Registrar Web Services

<back to all web services

R_RegistrationSummary

Requires Authentication
Requires any of the roles:Admin, User
R_RegistrationSummary Parameters:
NameParameterData TypeRequiredDescription
UnitIdquerystringNo
CreationDateTimequeryDateTime?No
AccountIdquerylong?No
RegistrationStatusqueryR_RegistrationStatusTypeNo
SubscriptionIdquerylong?No
PlanqueryR_PlanNo
ProductNamequerystringNo
NextBillDatequeryDateTime?No
PaidUntilDatequeryDateTime?No
PhoneNumberquerystringNo
CellularDeviceStateIdquerylong?No
CellDeviceIdquerystringNo
DeviceSerialNumberquerystringNo
IdquerylongNo
R_RegistrationStatusType Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DescriptionformstringNo
R_Plan Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
PriceDescriptionformstringNo
CurrencyTypeIdformlongNo
PlanStatusformlongNo
PlanBillingstructureIdformlongNo
IdformlongNo
R_RegistrationSummary Parameters:
NameParameterData TypeRequiredDescription
UnitIdquerystringNo
CreationDateTimequeryDateTime?No
AccountIdquerylong?No
RegistrationStatusqueryR_RegistrationStatusTypeNo
SubscriptionIdquerylong?No
PlanqueryR_PlanNo
ProductNamequerystringNo
NextBillDatequeryDateTime?No
PaidUntilDatequeryDateTime?No
PhoneNumberquerystringNo
CellularDeviceStateIdquerylong?No
CellDeviceIdquerystringNo
DeviceSerialNumberquerystringNo
IdquerylongNo

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: R_RegistrationSummary

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<R_RegistrationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <AccountId>0</AccountId>
  <CellDeviceId>String</CellDeviceId>
  <CellularDeviceStateId>0</CellularDeviceStateId>
  <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
  <DeviceSerialNumber>String</DeviceSerialNumber>
  <Id>0</Id>
  <NextBillDate>0001-01-01T00:00:00</NextBillDate>
  <PaidUntilDate>0001-01-01T00:00:00</PaidUntilDate>
  <PhoneNumber>String</PhoneNumber>
  <Plan xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:CurrencyTypeId>0</d2p1:CurrencyTypeId>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:PlanBillingstructureId>0</d2p1:PlanBillingstructureId>
    <d2p1:PlanStatus>0</d2p1:PlanStatus>
    <d2p1:PriceDescription>String</d2p1:PriceDescription>
  </Plan>
  <ProductName>String</ProductName>
  <RegistrationStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
  </RegistrationStatus>
  <SubscriptionId>0</SubscriptionId>
  <UnitId>String</UnitId>
</R_RegistrationSummary>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<R_RegistrationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <AccountId>0</AccountId>
  <CellDeviceId>String</CellDeviceId>
  <CellularDeviceStateId>0</CellularDeviceStateId>
  <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
  <DeviceSerialNumber>String</DeviceSerialNumber>
  <Id>0</Id>
  <NextBillDate>0001-01-01T00:00:00</NextBillDate>
  <PaidUntilDate>0001-01-01T00:00:00</PaidUntilDate>
  <PhoneNumber>String</PhoneNumber>
  <Plan xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:CurrencyTypeId>0</d2p1:CurrencyTypeId>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:PlanBillingstructureId>0</d2p1:PlanBillingstructureId>
    <d2p1:PlanStatus>0</d2p1:PlanStatus>
    <d2p1:PriceDescription>String</d2p1:PriceDescription>
  </Plan>
  <ProductName>String</ProductName>
  <RegistrationStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
  </RegistrationStatus>
  <SubscriptionId>0</SubscriptionId>
  <UnitId>String</UnitId>
</R_RegistrationSummary>

    </soap:Body>
</soap:Envelope>