Registrar Web Services

<back to all web services

R_Subscriptions

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Accounts/{AccountIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
GET,OPTIONS/R_Subscriptions/{AssignRegistrationId}
GET,OPTIONS/R_Subscriptions/{Ids}/AssignRegId/{AssignRegistrationId}
GET,OPTIONS/R_Subscriptions/BrandIds/{BrandIds}/AssignRegId/{AssignRegistrationId}
GET,OPTIONS/R_Registration/RegistrationIds/{RegistrationIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
GET,OPTIONS/R_Registration/UnitIds/{UnitIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
GET,OPTIONS/R_AccountHolders/{AccountHolderIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
R_Subscriptions Parameters:
NameParameterData TypeRequiredDescription
RegistrationIdspathList<long>No
UnitIdspathList<string>No
AccountHolderIdspathList<long>No
AccountIdspathList<long>No
IdspathList<long>No
BrandIdspathList<long>No
AssignRegistrationIdpathboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No

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_Subscriptions HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_Subscriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <AccountHolderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccountHolderIds>
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccountIds>
  <AssignRegistrationId>false</AssignRegistrationId>
  <BrandIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </BrandIds>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <NumberOfRecords>0</NumberOfRecords>
  <RegistrationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </RegistrationIds>
  <StartIndex>0</StartIndex>
  <UnitIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UnitIds>
</R_Subscriptions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_Subscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_Subscription>
    <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>
</ArrayOfR_Subscription>