Registrar Web Services

<back to all web services

R_Registrations

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Accounts/{AccountId}/R_Registrations
GET,OPTIONS/R_Registrations/UnitIds/{UnitIds}
GET,OPTIONS/R_Registrations/RegistrationStatus/{RegistrationStatusTypeId}
GET,OPTIONS/R_Registrations/DevicePhoneNumbers/{DevicePhoneNumbers}
GET,OPTIONS/R_Registrations/DeviceIds/{DeviceIds}
GET,OPTIONS/R_Registrations/AccountIds/{AccountIds}
GET,OPTIONS/R_Registrations
GET,OPTIONS/R_Registrations/{Ids}
GET,OPTIONS/R_Registrations/BIds/{BrandIds}/SIds/{RegistrationStatusTypeIds}/AIds/{AccountIds}/Start/{StartIndex}/PageSize/{NumberOfRecords}
GET,OPTIONS/R_Registrations/BIds/{BrandIds}/SIds/{RegistrationStatusTypeIds}/UID/{PartialUnitId}/RId/{ResellerId}/Pids/{ProductIds}/Start/{StartIndex}/PageSize/{NumberOfRecords}
R_Registrations Parameters:
NameParameterData TypeRequiredDescription
PartialUnitIdpathstringNo
ResellerIdpathlong?No
RegistrationStatusTypeIdspathList<long>No
BrandIdspathList<long>No
ProductIdspathList<long>No
AccountIdpathlong?No
UnitIdspathList<string>No
IdspathList<long>No
RegistrationStatusTypeIdpathlong?No
DevicePhoneNumberspathList<string>No
DeviceIdspathList<string>No
AccountIdspathList<long>No
ReturnOnlyTotalNumberOfRecordsqueryboolNo
IncludeMetaDataInformationqueryboolNo
StartIndexpathlong?No
NumberOfRecordspathlong?No
APlanMdqueryboolNo
ABundleMdqueryboolNo
AResellerMdqueryboolNo
ABrandMdqueryboolNo
ASubsMdqueryboolNo
ACellMdqueryboolNo

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

<R_Registrations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <ABrandMd>false</ABrandMd>
  <ABundleMd>false</ABundleMd>
  <ACellMd>false</ACellMd>
  <APlanMd>false</APlanMd>
  <AResellerMd>false</AResellerMd>
  <ASubsMd>false</ASubsMd>
  <AccountId>0</AccountId>
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccountIds>
  <BrandIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </BrandIds>
  <DeviceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeviceIds>
  <DevicePhoneNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DevicePhoneNumbers>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <IncludeMetaDataInformation>false</IncludeMetaDataInformation>
  <NumberOfRecords>0</NumberOfRecords>
  <PartialUnitId>String</PartialUnitId>
  <ProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </ProductIds>
  <RegistrationStatusTypeId>0</RegistrationStatusTypeId>
  <RegistrationStatusTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </RegistrationStatusTypeIds>
  <ResellerId>0</ResellerId>
  <ReturnOnlyTotalNumberOfRecords>false</ReturnOnlyTotalNumberOfRecords>
  <StartIndex>0</StartIndex>
  <UnitIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UnitIds>
</R_Registrations>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_Registration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_Registration>
    <AccountId>0</AccountId>
    <BrandId>0</BrandId>
    <BrandName>String</BrandName>
    <BundleName>String</BundleName>
    <CellularService>
      <BrandName>String</BrandName>
      <CellDeviceId>String</CellDeviceId>
      <CellularDeviceStateId>0</CellularDeviceStateId>
      <ContactEmail>String</ContactEmail>
      <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
      <DeviceSerialNumber>String</DeviceSerialNumber>
      <Id>0</Id>
      <LastUpdatDateTime>0001-01-01T00:00:00</LastUpdatDateTime>
      <PhoneNumber>String</PhoneNumber>
      <ProductName>String</ProductName>
      <ProfileId>0</ProfileId>
      <RegistrationId>0</RegistrationId>
      <TotalNumberOfRecords>0</TotalNumberOfRecords>
      <UnitId>String</UnitId>
    </CellularService>
    <CellularServiceId>0</CellularServiceId>
    <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
    <EligibleBundleId>0</EligibleBundleId>
    <Id>0</Id>
    <MerchantId>String</MerchantId>
    <PlanId>0</PlanId>
    <PlanName>String</PlanName>
    <ProductId>0</ProductId>
    <ProductName>String</ProductName>
    <RegistrationStatus>0</RegistrationStatus>
    <ResellerId>0</ResellerId>
    <ResellerName>String</ResellerName>
    <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>
    </Subscription>
    <SubscriptionId>0</SubscriptionId>
    <TotalNumberOfRecords>0</TotalNumberOfRecords>
    <UnitId>String</UnitId>
  </R_Registration>
</ArrayOfR_Registration>