Registrar Web Services

<back to all web services

R_RegistrationSummary

Requires Authentication
Requires any of the roles:Admin, User
The following routes are available for this service:
OPTIONS/R_RegistrationSummaries
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"UnitId":"String","CreationDateTime":"\/Date(-62135596800000-0000)\/","AccountId":0,"RegistrationStatus":{"Id":0,"Description":"String"},"SubscriptionId":0,"Plan":{"Name":"String","Description":"String","PriceDescription":"String","CurrencyTypeId":0,"PlanStatus":0,"PlanBillingstructureId":0,"Id":0},"ProductName":"String","NextBillDate":"\/Date(-62135596800000-0000)\/","PaidUntilDate":"\/Date(-62135596800000-0000)\/","PhoneNumber":"String","CellularDeviceStateId":0,"CellDeviceId":"String","DeviceSerialNumber":"String","Id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"UnitId":"String","CreationDateTime":"\/Date(-62135596800000-0000)\/","AccountId":0,"RegistrationStatus":{"Id":0,"Description":"String"},"SubscriptionId":0,"Plan":{"Name":"String","Description":"String","PriceDescription":"String","CurrencyTypeId":0,"PlanStatus":0,"PlanBillingstructureId":0,"Id":0},"ProductName":"String","NextBillDate":"\/Date(-62135596800000-0000)\/","PaidUntilDate":"\/Date(-62135596800000-0000)\/","PhoneNumber":"String","CellularDeviceStateId":0,"CellDeviceId":"String","DeviceSerialNumber":"String","Id":0}