Required role: | Admin |
POST,OPTIONS | /R_Registrations | ||
---|---|---|---|
PUT,OPTIONS | /R_Registrations/{Id} | ||
DELETE,OPTIONS | /R_Registrations/{Id} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | long | No | |
UnitId | body | string | No | |
MerchantId | body | string | No | |
CreationDateTime | body | DateTime? | No | |
RegistrationStatus | body | long | No | |
AccountId | body | long? | No | |
ProductId | body | long | No | |
ProductName | body | string | No | |
PlanId | body | long? | No | |
PlanName | body | string | No | |
SubscriptionId | body | long? | No | |
CellularServiceId | body | long? | No | |
BrandId | body | long | No | |
BrandName | body | string | No | |
EligibleBundleId | body | long? | No | |
BundleName | body | string | No | |
ResellerId | body | long? | No | |
ResellerName | body | string | No | |
CellularService | body | R_CellularService | No | |
Subscription | body | R_Subscription | No | |
TotalNumberOfRecords | body | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RegistrationId | form | long | No | |
UnitId | form | string | No | |
ProductName | form | string | No | |
CellDeviceId | form | string | No | |
DeviceSerialNumber | form | string | No | |
PhoneNumber | form | string | No | |
BrandName | form | string | No | |
ProfileId | form | long | No | |
CellularDeviceStateId | form | long | No | |
CreateDateTime | form | DateTime | No | |
LastUpdatDateTime | form | DateTime | No | |
ContactEmail | form | string | No | |
Id | form | long | No | |
TotalNumberOfRecords | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountHolderId | form | long | No | |
RegistrationId | form | long | No | |
UnitId | form | string | No | |
SubscriptionStatusTypeId | form | long | No | |
BrandId | form | long | No | |
StartDate | form | DateTime | No | |
PreviousBillDate | form | DateTime? | No | |
CurrentBillDate | form | DateTime? | No | |
NextBillDate | form | DateTime? | No | |
PaidUntil | form | DateTime? | No | |
NumberOfOccurrences | form | int | No | |
BillingInterval | form | int | No | |
BillingIntervalTimeUnitId | form | long | No | |
TrialOccurrences | form | int? | No | |
TrialBillingInterval | form | int? | No | |
TrialBillingIntervalTimeUnitId | form | long? | No | |
SubscriptionBillingStatusId | form | long? | No | |
Id | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | long | No | |
UnitId | body | string | No | |
MerchantId | body | string | No | |
CreationDateTime | body | DateTime? | No | |
RegistrationStatus | body | long | No | |
AccountId | body | long? | No | |
ProductId | body | long | No | |
ProductName | body | string | No | |
PlanId | body | long? | No | |
PlanName | body | string | No | |
SubscriptionId | body | long? | No | |
CellularServiceId | body | long? | No | |
BrandId | body | long | No | |
BrandName | body | string | No | |
EligibleBundleId | body | long? | No | |
BundleName | body | string | No | |
ResellerId | body | long? | No | |
ResellerName | body | string | No | |
CellularService | body | R_CellularService | No | |
Subscription | body | R_Subscription | No | |
TotalNumberOfRecords | body | 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_Registration HTTP/1.1
Host: regapi.pumpalarm.com
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
}
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 }