Requires any of the roles: | Admin, User |
OPTIONS | /R_RegistrationSummaries |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UnitId | query | string | No | |
CreationDateTime | query | DateTime? | No | |
AccountId | query | long? | No | |
RegistrationStatus | query | R_RegistrationStatusType | No | |
SubscriptionId | query | long? | No | |
Plan | query | R_Plan | No | |
ProductName | query | string | No | |
NextBillDate | query | DateTime? | No | |
PaidUntilDate | query | DateTime? | No | |
PhoneNumber | query | string | No | |
CellularDeviceStateId | query | long? | No | |
CellDeviceId | query | string | No | |
DeviceSerialNumber | query | string | No | |
Id | query | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Description | form | string | No | |
PriceDescription | form | string | No | |
CurrencyTypeId | form | long | No | |
PlanStatus | form | long | No | |
PlanBillingstructureId | form | long | No | |
Id | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UnitId | query | string | No | |
CreationDateTime | query | DateTime? | No | |
AccountId | query | long? | No | |
RegistrationStatus | query | R_RegistrationStatusType | No | |
SubscriptionId | query | long? | No | |
Plan | query | R_Plan | No | |
ProductName | query | string | No | |
NextBillDate | query | DateTime? | No | |
PaidUntilDate | query | DateTime? | No | |
PhoneNumber | query | string | No | |
CellularDeviceStateId | query | long? | No | |
CellDeviceId | query | string | No | |
DeviceSerialNumber | query | string | No | |
Id | query | long | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/R_RegistrationSummary HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/jsv
Content-Length: length
{
UnitId: String,
CreationDateTime: 0001-01-01,
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: 0001-01-01,
PaidUntilDate: 0001-01-01,
PhoneNumber: String,
CellularDeviceStateId: 0,
CellDeviceId: String,
DeviceSerialNumber: String,
Id: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { UnitId: String, CreationDateTime: 0001-01-01, 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: 0001-01-01, PaidUntilDate: 0001-01-01, PhoneNumber: String, CellularDeviceStateId: 0, CellDeviceId: String, DeviceSerialNumber: String, Id: 0 }