Registrar Web Services

<back to all web services

R_Registration

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_Registrations
PUT,OPTIONS/R_Registrations/{Id}
DELETE,OPTIONS/R_Registrations/{Id}
R_Registration Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
UnitIdbodystringNo
MerchantIdbodystringNo
CreationDateTimebodyDateTime?No
RegistrationStatusbodylongNo
AccountIdbodylong?No
ProductIdbodylongNo
ProductNamebodystringNo
PlanIdbodylong?No
PlanNamebodystringNo
SubscriptionIdbodylong?No
CellularServiceIdbodylong?No
BrandIdbodylongNo
BrandNamebodystringNo
EligibleBundleIdbodylong?No
BundleNamebodystringNo
ResellerIdbodylong?No
ResellerNamebodystringNo
CellularServicebodyR_CellularServiceNo
SubscriptionbodyR_SubscriptionNo
TotalNumberOfRecordsbodylongNo
R_CellularService Parameters:
NameParameterData TypeRequiredDescription
RegistrationIdformlongNo
UnitIdformstringNo
ProductNameformstringNo
CellDeviceIdformstringNo
DeviceSerialNumberformstringNo
PhoneNumberformstringNo
BrandNameformstringNo
ProfileIdformlongNo
CellularDeviceStateIdformlongNo
CreateDateTimeformDateTimeNo
LastUpdatDateTimeformDateTimeNo
ContactEmailformstringNo
IdformlongNo
TotalNumberOfRecordsformlongNo
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdformlongNo
RegistrationIdformlongNo
UnitIdformstringNo
SubscriptionStatusTypeIdformlongNo
BrandIdformlongNo
StartDateformDateTimeNo
PreviousBillDateformDateTime?No
CurrentBillDateformDateTime?No
NextBillDateformDateTime?No
PaidUntilformDateTime?No
NumberOfOccurrencesformintNo
BillingIntervalformintNo
BillingIntervalTimeUnitIdformlongNo
TrialOccurrencesformint?No
TrialBillingIntervalformint?No
TrialBillingIntervalTimeUnitIdformlong?No
SubscriptionBillingStatusIdformlong?No
IdformlongNo
R_Registration Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
UnitIdbodystringNo
MerchantIdbodystringNo
CreationDateTimebodyDateTime?No
RegistrationStatusbodylongNo
AccountIdbodylong?No
ProductIdbodylongNo
ProductNamebodystringNo
PlanIdbodylong?No
PlanNamebodystringNo
SubscriptionIdbodylong?No
CellularServiceIdbodylong?No
BrandIdbodylongNo
BrandNamebodystringNo
EligibleBundleIdbodylong?No
BundleNamebodystringNo
ResellerIdbodylong?No
ResellerNamebodystringNo
CellularServicebodyR_CellularServiceNo
SubscriptionbodyR_SubscriptionNo
TotalNumberOfRecordsbodylongNo

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

HTTP + CSV

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

POST /csv/reply/R_Registration HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
Content-Length: length

{"Id":0,"UnitId":"String","MerchantId":"String","CreationDateTime":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","LastUpdatDateTime":"\/Date(-62135596800000-0000)\/","ContactEmail":"String","Id":0,"TotalNumberOfRecords":0},"Subscription":{"AccountHolderId":0,"RegistrationId":0,"UnitId":"String","SubscriptionStatusTypeId":0,"BrandId":0,"StartDate":"\/Date(-62135596800000-0000)\/","PreviousBillDate":"\/Date(-62135596800000-0000)\/","CurrentBillDate":"\/Date(-62135596800000-0000)\/","NextBillDate":"\/Date(-62135596800000-0000)\/","PaidUntil":"\/Date(-62135596800000-0000)\/","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/csv
Content-Length: length

{"Id":0,"UnitId":"String","MerchantId":"String","CreationDateTime":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","LastUpdatDateTime":"\/Date(-62135596800000-0000)\/","ContactEmail":"String","Id":0,"TotalNumberOfRecords":0},"Subscription":{"AccountHolderId":0,"RegistrationId":0,"UnitId":"String","SubscriptionStatusTypeId":0,"BrandId":0,"StartDate":"\/Date(-62135596800000-0000)\/","PreviousBillDate":"\/Date(-62135596800000-0000)\/","CurrentBillDate":"\/Date(-62135596800000-0000)\/","NextBillDate":"\/Date(-62135596800000-0000)\/","PaidUntil":"\/Date(-62135596800000-0000)\/","NumberOfOccurrences":0,"BillingInterval":0,"BillingIntervalTimeUnitId":0,"TrialOccurrences":0,"TrialBillingInterval":0,"TrialBillingIntervalTimeUnitId":0,"SubscriptionBillingStatusId":0,"Id":0},"TotalNumberOfRecords":0}