Registrar Web Services

<back to all web services

R_Subscription

Requires Authentication
Required role:Admin
The following routes are available for this service:
PUT,OPTIONS/R_Subscriptions/{Id}
DELETE,OPTIONS/R_Subscriptions/{Id}
POST,OPTIONS/R_Subscriptions
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdbodylongNo
RegistrationIdbodylongNo
UnitIdbodystringNo
SubscriptionStatusTypeIdbodylongNo
BrandIdbodylongNo
StartDatebodyDateTimeNo
PreviousBillDatebodyDateTime?No
CurrentBillDatebodyDateTime?No
NextBillDatebodyDateTime?No
PaidUntilbodyDateTime?No
NumberOfOccurrencesbodyintNo
BillingIntervalbodyintNo
BillingIntervalTimeUnitIdbodylongNo
TrialOccurrencesbodyint?No
TrialBillingIntervalbodyint?No
TrialBillingIntervalTimeUnitIdbodylong?No
SubscriptionBillingStatusIdbodylong?No
IdpathlongNo
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdbodylongNo
RegistrationIdbodylongNo
UnitIdbodystringNo
SubscriptionStatusTypeIdbodylongNo
BrandIdbodylongNo
StartDatebodyDateTimeNo
PreviousBillDatebodyDateTime?No
CurrentBillDatebodyDateTime?No
NextBillDatebodyDateTime?No
PaidUntilbodyDateTime?No
NumberOfOccurrencesbodyintNo
BillingIntervalbodyintNo
BillingIntervalTimeUnitIdbodylongNo
TrialOccurrencesbodyint?No
TrialBillingIntervalbodyint?No
TrialBillingIntervalTimeUnitIdbodylong?No
SubscriptionBillingStatusIdbodylong?No
IdpathlongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/R_Subscription HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_Subscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <AccountHolderId>0</AccountHolderId>
  <BillingInterval>0</BillingInterval>
  <BillingIntervalTimeUnitId>0</BillingIntervalTimeUnitId>
  <BrandId>0</BrandId>
  <CurrentBillDate>0001-01-01T00:00:00</CurrentBillDate>
  <Id>0</Id>
  <NextBillDate>0001-01-01T00:00:00</NextBillDate>
  <NumberOfOccurrences>0</NumberOfOccurrences>
  <PaidUntil>0001-01-01T00:00:00</PaidUntil>
  <PreviousBillDate>0001-01-01T00:00:00</PreviousBillDate>
  <RegistrationId>0</RegistrationId>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <SubscriptionBillingStatusId>0</SubscriptionBillingStatusId>
  <SubscriptionStatusTypeId>0</SubscriptionStatusTypeId>
  <TrialBillingInterval>0</TrialBillingInterval>
  <TrialBillingIntervalTimeUnitId>0</TrialBillingIntervalTimeUnitId>
  <TrialOccurrences>0</TrialOccurrences>
  <UnitId>String</UnitId>
</R_Subscription>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_Subscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <AccountHolderId>0</AccountHolderId>
  <BillingInterval>0</BillingInterval>
  <BillingIntervalTimeUnitId>0</BillingIntervalTimeUnitId>
  <BrandId>0</BrandId>
  <CurrentBillDate>0001-01-01T00:00:00</CurrentBillDate>
  <Id>0</Id>
  <NextBillDate>0001-01-01T00:00:00</NextBillDate>
  <NumberOfOccurrences>0</NumberOfOccurrences>
  <PaidUntil>0001-01-01T00:00:00</PaidUntil>
  <PreviousBillDate>0001-01-01T00:00:00</PreviousBillDate>
  <RegistrationId>0</RegistrationId>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <SubscriptionBillingStatusId>0</SubscriptionBillingStatusId>
  <SubscriptionStatusTypeId>0</SubscriptionStatusTypeId>
  <TrialBillingInterval>0</TrialBillingInterval>
  <TrialBillingIntervalTimeUnitId>0</TrialBillingIntervalTimeUnitId>
  <TrialOccurrences>0</TrialOccurrences>
  <UnitId>String</UnitId>
</R_Subscription>