POST Subscribers

Request Information

URI Parameters

None.

Body Parameters

vwEffectiveConfiguration3
NameDescriptionTypeAdditional information
InfoPopupText

string

None.

CreatedByAndTime

string

None.

ModifiedByAndTime

string

None.

DeletedByAndTime

string

None.

effectiveNextBillingDate

date

None.

InstallationID

globally unique identifier

None.

InstallationName

string

None.

InstallationDescription

string

None.

DatabaseName

string

None.

InstallationEmailBatchSize

integer

None.

InstallationEmailUseAsync

boolean

None.

InstallationEmailSendingActive

boolean

None.

OwnerUser

string

None.

OwnerMasterUserID

globally unique identifier

None.

FinanceContactMasterUserID

globally unique identifier

None.

InstallationAdminMasterUserID

globally unique identifier

None.

InstallationFreeTrialUntil

date

None.

InstallationLastBillingDate

date

None.

InstallationNextBillingDate

date

None.

CreatedDate

date

None.

InstallationEmailUseTracker

boolean

None.

InstallationStatusName

string

None.

DiscountSchemeTitle

string

None.

DiscountSchemeDescription

string

None.

DiscountSchemeStartDate

date

None.

DiscountSchemeEndDate

date

None.

DiscountSchemeDiscount

decimal number

None.

DiscountSchemeAbsoluteDiscountMonthly

decimal number

None.

DiscountSchemeMaximumAmount

decimal number

None.

DiscountSchemeDefaultLengthMonths

integer

None.

InstallationLastUsageStatDateTime

date

None.

InstallationStripeAPIKey

string

None.

InstallationStripeAPITestKey

string

None.

InstallationStripeConnectAccessToken

string

None.

InstallationStripeConnectLivemode

string

None.

InstallationStripeConnectRefreshToken

string

None.

InstallationStripeConnectPublishableKey

string

None.

InstallationStripeConnectUserID

string

None.

InstallationStripeConnectScope

string

None.

EffectiveConnectionString

string

None.

ServerName

string

None.

ServerLocation

string

None.

ServerDescription

string

None.

ConnectionStringTemplate

string

None.

StructureConnectionString

string

None.

LoggingServiceURL

string

None.

MessageServiceURL

string

None.

WebWorkerURL

string

None.

MessageServiceActive

boolean

None.

ServerID

globally unique identifier

None.

InstallationSendGridIP

string

None.

InstallationSendGridDedicatedIP

boolean

None.

InstallationSendGridDomain

string

None.

InstallationSendGridActivated

boolean

None.

InstallationSendGridOneTimeAllowance

integer

None.

InstallationSendGridMonthlyAllowance

integer

None.

InstallationSendGridPassword

string

None.

InstallationSendGridSubUser

string

None.

InstallationAddonDiscountText

string

None.

InstallationAddonAbsoluteDiscount

decimal number

None.

InstallationAddonPercentageDiscount

decimal number

None.

InstallationDiscountText

string

None.

InstallationPercentageDiscount

decimal number

None.

InstallationAbsoluteDiscount

decimal number

None.

InstallationAcountingServiceEnabled

boolean

None.

InstallationDefaultSESConfigurationSet

string

None.

InstallationDefaultMailFromDomainID

globally unique identifier

None.

IsDeleted

boolean

None.

InstallationService1Enabled

boolean

None.

IntsallationService2Enabled

boolean

None.

InstallationService3Enabled

boolean

None.

InstallationMassEmailEnabled

boolean

None.

RunMagsMessagingServiceUrl

string

None.

RunMagsAccountingServiceUrl

string

None.

RunMagsWebWorkerUrl

string

None.

RunMagsDatabaseServerUrl

string

None.

DatabaseID

globally unique identifier

None.

Expr1

string

None.

RunMagsMessagingServiceID

globally unique identifier

None.

RunMagsClientUrlID

globally unique identifier

None.

RunMagsClientUrl

string

None.

RunMagsAccountingServiceID

globally unique identifier

None.

Expr2

string

None.

AccountingServiceURL

string

None.

InstallationMassEmailMergeEnabled

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "InfoPopupText": "Created: Unknown : 2024-11-21 13:26\r\nModified: Unknown : \r\nDeleted: Unknown : ",
  "CreatedByAndTime": "Unknown : 2024-11-21 13:26",
  "ModifiedByAndTime": "Unknown : ",
  "DeletedByAndTime": "Unknown : ",
  "effectiveNextBillingDate": "2024-11-21T13:26:43.4969361+00:00",
  "InstallationID": "d1f69586-de41-47c0-aab8-0290e7456dd7",
  "InstallationName": "sample string 2",
  "InstallationDescription": "sample string 3",
  "DatabaseName": "sample string 4",
  "InstallationEmailBatchSize": 5,
  "InstallationEmailUseAsync": true,
  "InstallationEmailSendingActive": true,
  "OwnerUser": "sample string 8",
  "OwnerMasterUserID": "2b05f999-b631-4a4c-8e9f-cbb30cd1d9c3",
  "FinanceContactMasterUserID": "9f2c584d-572f-42dc-9412-047d1152a8c4",
  "InstallationAdminMasterUserID": "4b5a2248-b5f4-47d0-a272-e465b88f42b1",
  "InstallationFreeTrialUntil": "2024-11-21T13:26:43.4959388+00:00",
  "InstallationLastBillingDate": "2024-11-21T13:26:43.4969361+00:00",
  "InstallationNextBillingDate": "2024-11-21T13:26:43.4969361+00:00",
  "CreatedDate": "2024-11-21T13:26:43.4969361+00:00",
  "InstallationEmailUseTracker": true,
  "InstallationStatusName": "sample string 11",
  "DiscountSchemeTitle": "sample string 12",
  "DiscountSchemeDescription": "sample string 13",
  "DiscountSchemeStartDate": "2024-11-21T13:26:43.4969361+00:00",
  "DiscountSchemeEndDate": "2024-11-21T13:26:43.4979334+00:00",
  "DiscountSchemeDiscount": 1.0,
  "DiscountSchemeAbsoluteDiscountMonthly": 1.0,
  "DiscountSchemeMaximumAmount": 1.0,
  "DiscountSchemeDefaultLengthMonths": 1,
  "InstallationLastUsageStatDateTime": "2024-11-21T13:26:43.4979334+00:00",
  "InstallationStripeAPIKey": "sample string 14",
  "InstallationStripeAPITestKey": "sample string 15",
  "InstallationStripeConnectAccessToken": "sample string 16",
  "InstallationStripeConnectLivemode": "sample string 17",
  "InstallationStripeConnectRefreshToken": "sample string 18",
  "InstallationStripeConnectPublishableKey": "sample string 19",
  "InstallationStripeConnectUserID": "sample string 20",
  "InstallationStripeConnectScope": "sample string 21",
  "EffectiveConnectionString": "sample string 22",
  "ServerName": "sample string 23",
  "ServerLocation": "sample string 24",
  "ServerDescription": "sample string 25",
  "ConnectionStringTemplate": "sample string 26",
  "StructureConnectionString": "sample string 27",
  "LoggingServiceURL": "sample string 28",
  "MessageServiceURL": "sample string 29",
  "WebWorkerURL": "sample string 30",
  "MessageServiceActive": true,
  "ServerID": "02c867ae-fc6b-49e7-9220-5035911e1425",
  "InstallationSendGridIP": "sample string 31",
  "InstallationSendGridDedicatedIP": true,
  "InstallationSendGridDomain": "sample string 32",
  "InstallationSendGridActivated": true,
  "InstallationSendGridOneTimeAllowance": 1,
  "InstallationSendGridMonthlyAllowance": 1,
  "InstallationSendGridPassword": "sample string 33",
  "InstallationSendGridSubUser": "sample string 34",
  "InstallationAddonDiscountText": "sample string 35",
  "InstallationAddonAbsoluteDiscount": 1.0,
  "InstallationAddonPercentageDiscount": 1.0,
  "InstallationDiscountText": "sample string 36",
  "InstallationPercentageDiscount": 1.0,
  "InstallationAbsoluteDiscount": 1.0,
  "InstallationAcountingServiceEnabled": true,
  "InstallationDefaultSESConfigurationSet": "sample string 37",
  "InstallationDefaultMailFromDomainID": "511799c1-5e8b-47a4-bb91-8f33c3bfe222",
  "IsDeleted": true,
  "InstallationService1Enabled": true,
  "IntsallationService2Enabled": true,
  "InstallationService3Enabled": true,
  "InstallationMassEmailEnabled": true,
  "RunMagsMessagingServiceUrl": "sample string 39",
  "RunMagsAccountingServiceUrl": "sample string 40",
  "RunMagsWebWorkerUrl": "sample string 41",
  "RunMagsDatabaseServerUrl": "sample string 42",
  "DatabaseID": "7929261b-e68c-4edf-a933-a773673efc21",
  "Expr1": "sample string 43",
  "RunMagsMessagingServiceID": "38b67a2c-1ee3-4df3-ad4e-e0b8e622a47d",
  "RunMagsClientUrlID": "376ef0b2-7221-4801-b031-d91ff5b6687a",
  "RunMagsClientUrl": "sample string 44",
  "RunMagsAccountingServiceID": "186676bc-534a-44a4-8791-8c3f8b630dc4",
  "Expr2": "sample string 45",
  "AccountingServiceURL": "sample string 46",
  "InstallationMassEmailMergeEnabled": true
}

application/xml, text/xml

Sample:
<vwEffectiveConfiguration3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RunMags.ClassLibrary">
  <AccountingServiceURL>sample string 46</AccountingServiceURL>
  <ConnectionStringTemplate>sample string 26</ConnectionStringTemplate>
  <CreatedDate>2024-11-21T13:26:43.4969361+00:00</CreatedDate>
  <DatabaseID>7929261b-e68c-4edf-a933-a773673efc21</DatabaseID>
  <DatabaseName>sample string 4</DatabaseName>
  <DiscountSchemeAbsoluteDiscountMonthly>1</DiscountSchemeAbsoluteDiscountMonthly>
  <DiscountSchemeDefaultLengthMonths>1</DiscountSchemeDefaultLengthMonths>
  <DiscountSchemeDescription>sample string 13</DiscountSchemeDescription>
  <DiscountSchemeDiscount>1</DiscountSchemeDiscount>
  <DiscountSchemeEndDate>2024-11-21T13:26:43.4979334+00:00</DiscountSchemeEndDate>
  <DiscountSchemeMaximumAmount>1</DiscountSchemeMaximumAmount>
  <DiscountSchemeStartDate>2024-11-21T13:26:43.4969361+00:00</DiscountSchemeStartDate>
  <DiscountSchemeTitle>sample string 12</DiscountSchemeTitle>
  <EffectiveConnectionString>sample string 22</EffectiveConnectionString>
  <Expr1>sample string 43</Expr1>
  <Expr2>sample string 45</Expr2>
  <FinanceContactMasterUserID>9f2c584d-572f-42dc-9412-047d1152a8c4</FinanceContactMasterUserID>
  <InstallationAbsoluteDiscount>1</InstallationAbsoluteDiscount>
  <InstallationAcountingServiceEnabled>true</InstallationAcountingServiceEnabled>
  <InstallationAddonAbsoluteDiscount>1</InstallationAddonAbsoluteDiscount>
  <InstallationAddonDiscountText>sample string 35</InstallationAddonDiscountText>
  <InstallationAddonPercentageDiscount>1</InstallationAddonPercentageDiscount>
  <InstallationAdminMasterUserID>4b5a2248-b5f4-47d0-a272-e465b88f42b1</InstallationAdminMasterUserID>
  <InstallationDefaultMailFromDomainID>511799c1-5e8b-47a4-bb91-8f33c3bfe222</InstallationDefaultMailFromDomainID>
  <InstallationDefaultSESConfigurationSet>sample string 37</InstallationDefaultSESConfigurationSet>
  <InstallationDescription>sample string 3</InstallationDescription>
  <InstallationDiscountText>sample string 36</InstallationDiscountText>
  <InstallationEmailBatchSize>5</InstallationEmailBatchSize>
  <InstallationEmailSendingActive>true</InstallationEmailSendingActive>
  <InstallationEmailUseAsync>true</InstallationEmailUseAsync>
  <InstallationEmailUseTracker>true</InstallationEmailUseTracker>
  <InstallationFreeTrialUntil>2024-11-21T13:26:43.4959388+00:00</InstallationFreeTrialUntil>
  <InstallationID>d1f69586-de41-47c0-aab8-0290e7456dd7</InstallationID>
  <InstallationLastBillingDate>2024-11-21T13:26:43.4969361+00:00</InstallationLastBillingDate>
  <InstallationLastUsageStatDateTime>2024-11-21T13:26:43.4979334+00:00</InstallationLastUsageStatDateTime>
  <InstallationMassEmailEnabled>true</InstallationMassEmailEnabled>
  <InstallationMassEmailMergeEnabled>true</InstallationMassEmailMergeEnabled>
  <InstallationName>sample string 2</InstallationName>
  <InstallationNextBillingDate>2024-11-21T13:26:43.4969361+00:00</InstallationNextBillingDate>
  <InstallationPercentageDiscount>1</InstallationPercentageDiscount>
  <InstallationSendGridActivated>true</InstallationSendGridActivated>
  <InstallationSendGridDedicatedIP>true</InstallationSendGridDedicatedIP>
  <InstallationSendGridDomain>sample string 32</InstallationSendGridDomain>
  <InstallationSendGridIP>sample string 31</InstallationSendGridIP>
  <InstallationSendGridMonthlyAllowance>1</InstallationSendGridMonthlyAllowance>
  <InstallationSendGridOneTimeAllowance>1</InstallationSendGridOneTimeAllowance>
  <InstallationSendGridPassword>sample string 33</InstallationSendGridPassword>
  <InstallationSendGridSubUser>sample string 34</InstallationSendGridSubUser>
  <InstallationService1Enabled>true</InstallationService1Enabled>
  <InstallationService3Enabled>true</InstallationService3Enabled>
  <InstallationStatusName>sample string 11</InstallationStatusName>
  <InstallationStripeAPIKey>sample string 14</InstallationStripeAPIKey>
  <InstallationStripeAPITestKey>sample string 15</InstallationStripeAPITestKey>
  <InstallationStripeConnectAccessToken>sample string 16</InstallationStripeConnectAccessToken>
  <InstallationStripeConnectLivemode>sample string 17</InstallationStripeConnectLivemode>
  <InstallationStripeConnectPublishableKey>sample string 19</InstallationStripeConnectPublishableKey>
  <InstallationStripeConnectRefreshToken>sample string 18</InstallationStripeConnectRefreshToken>
  <InstallationStripeConnectScope>sample string 21</InstallationStripeConnectScope>
  <InstallationStripeConnectUserID>sample string 20</InstallationStripeConnectUserID>
  <IntsallationService2Enabled>true</IntsallationService2Enabled>
  <IsDeleted>true</IsDeleted>
  <LoggingServiceURL>sample string 28</LoggingServiceURL>
  <MessageServiceActive>true</MessageServiceActive>
  <MessageServiceURL>sample string 29</MessageServiceURL>
  <OwnerMasterUserID>2b05f999-b631-4a4c-8e9f-cbb30cd1d9c3</OwnerMasterUserID>
  <OwnerUser>sample string 8</OwnerUser>
  <RunMagsAccountingServiceID>186676bc-534a-44a4-8791-8c3f8b630dc4</RunMagsAccountingServiceID>
  <RunMagsAccountingServiceUrl>sample string 40</RunMagsAccountingServiceUrl>
  <RunMagsClientUrl>sample string 44</RunMagsClientUrl>
  <RunMagsClientUrlID>376ef0b2-7221-4801-b031-d91ff5b6687a</RunMagsClientUrlID>
  <RunMagsDatabaseServerUrl>sample string 42</RunMagsDatabaseServerUrl>
  <RunMagsMessagingServiceID>38b67a2c-1ee3-4df3-ad4e-e0b8e622a47d</RunMagsMessagingServiceID>
  <RunMagsMessagingServiceUrl>sample string 39</RunMagsMessagingServiceUrl>
  <RunMagsWebWorkerUrl>sample string 41</RunMagsWebWorkerUrl>
  <ServerDescription>sample string 25</ServerDescription>
  <ServerID>02c867ae-fc6b-49e7-9220-5035911e1425</ServerID>
  <ServerLocation>sample string 24</ServerLocation>
  <ServerName>sample string 23</ServerName>
  <StructureConnectionString>sample string 27</StructureConnectionString>
  <WebWorkerURL>sample string 30</WebWorkerURL>
</vwEffectiveConfiguration3>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'vwEffectiveConfiguration3'.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>