Registrar Web Services

<back to all web services

R_CellularServices

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Accounts/AccountId/{AccountId}/R_CellularServices
GET,OPTIONS/R_Registrations/{RegistrationId}/R_CellularServices
GET,OPTIONS/R_CellularServices
GET,OPTIONS/R_CellularServices/{Ids}/{AssignRegistrationId}
GET,OPTIONS/R_Registrations/UnitId/{UnitIds}/R_CellularServices/
GET,OPTIONS/R_Registrations/DeviceId/{DeviceIds}/R_CellularServices
R_CellularServices Parameters:
NameParameterData TypeRequiredDescription
DeviceIdspathList<string>No
RegistrationIdpathlong?No
IdspathList<long>No
UnitIdspathList<string>No
AccountIdpathlong?No
DevicePhoneNumbersqueryList<string>No
DeviceSerialNumbersqueryList<string>No
AssignRegistrationIdpathboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No
CellularDeviceStateIdsqueryList<long>No
GetOnlyRecordsCountqueryboolNo
DescOrderqueryboolNo
SortByquerystringNo

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

<R_CellularServices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <AccountId>0</AccountId>
  <AssignRegistrationId>false</AssignRegistrationId>
  <CellularDeviceStateIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </CellularDeviceStateIds>
  <DescOrder>false</DescOrder>
  <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>
  <DeviceSerialNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeviceSerialNumbers>
  <GetOnlyRecordsCount>false</GetOnlyRecordsCount>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <NumberOfRecords>0</NumberOfRecords>
  <RegistrationId>0</RegistrationId>
  <SortBy>String</SortBy>
  <StartIndex>0</StartIndex>
  <UnitIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UnitIds>
</R_CellularServices>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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