| Requires the role: | Admin |
| 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} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PartialUnitId | path | string | No | |
| ResellerId | path | long? | No | |
| RegistrationStatusTypeIds | path | List<long> | No | |
| BrandIds | path | List<long> | No | |
| ProductIds | path | List<long> | No | |
| AccountId | path | long? | No | |
| UnitIds | path | List<string> | No | |
| Ids | path | List<long> | No | |
| RegistrationStatusTypeId | path | long? | No | |
| DevicePhoneNumbers | path | List<string> | No | |
| DeviceIds | path | List<string> | No | |
| AccountIds | path | List<long> | No | |
| ReturnOnlyTotalNumberOfRecords | query | bool | No | |
| IncludeMetaDataInformation | query | bool | No | |
| StartIndex | path | long? | No | |
| NumberOfRecords | path | long? | No | |
| APlanMd | query | bool | No | |
| ABundleMd | query | bool | No | |
| AResellerMd | query | bool | No | |
| ABrandMd | query | bool | No | |
| ASubsMd | query | bool | No | |
| ACellMd | query | bool | 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_Registrations HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/jsv
Content-Length: length
{
PartialUnitId: String,
ResellerId: 0,
RegistrationStatusTypeIds:
[
0
],
BrandIds:
[
0
],
ProductIds:
[
0
],
AccountId: 0,
UnitIds:
[
String
],
Ids:
[
0
],
RegistrationStatusTypeId: 0,
DevicePhoneNumbers:
[
String
],
DeviceIds:
[
String
],
AccountIds:
[
0
],
ReturnOnlyTotalNumberOfRecords: False,
IncludeMetaDataInformation: False,
StartIndex: 0,
NumberOfRecords: 0,
APlanMd: False,
ABundleMd: False,
AResellerMd: False,
ABrandMd: False,
ASubsMd: False,
ACellMd: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
Id: 0,
UnitId: String,
MerchantId: String,
CreationDateTime: 0001-01-01,
RegistrationStatus: 0,
AccountId: 0,
ProductId: 0,
ProductName: String,
PlanId: 0,
PlanName: String,
SubscriptionId: 0,
CellularServiceId: 0,
BrandId: 0,
BrandName: String,
EligibleBundleId: 0,
BundleName: String,
ResellerId: 0,
ResellerName: String,
CellularService:
{
RegistrationId: 0,
UnitId: String,
ProductName: String,
CellDeviceId: String,
DeviceSerialNumber: String,
PhoneNumber: String,
BrandName: String,
ProfileId: 0,
CellularDeviceStateId: 0,
CreateDateTime: 0001-01-01,
LastUpdatDateTime: 0001-01-01,
ContactEmail: String,
Id: 0,
TotalNumberOfRecords: 0
},
Subscription:
{
AccountHolderId: 0,
RegistrationId: 0,
UnitId: String,
SubscriptionStatusTypeId: 0,
BrandId: 0,
StartDate: 0001-01-01,
PreviousBillDate: 0001-01-01,
CurrentBillDate: 0001-01-01,
NextBillDate: 0001-01-01,
PaidUntil: 0001-01-01,
NumberOfOccurrences: 0,
BillingInterval: 0,
BillingIntervalTimeUnitId: 0,
TrialOccurrences: 0,
TrialBillingInterval: 0,
TrialBillingIntervalTimeUnitId: 0,
SubscriptionBillingStatusId: 0,
Id: 0
},
TotalNumberOfRecords: 0
}
]