Registrar Web Services

<back to all web services

R_Subscription

Requires Authentication
Required role:Admin
The following routes are available for this service:
PUT,OPTIONS/R_Subscriptions/{Id}
DELETE,OPTIONS/R_Subscriptions/{Id}
POST,OPTIONS/R_Subscriptions
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdbodylongNo
RegistrationIdbodylongNo
UnitIdbodystringNo
SubscriptionStatusTypeIdbodylongNo
BrandIdbodylongNo
StartDatebodyDateTimeNo
PreviousBillDatebodyDateTime?No
CurrentBillDatebodyDateTime?No
NextBillDatebodyDateTime?No
PaidUntilbodyDateTime?No
NumberOfOccurrencesbodyintNo
BillingIntervalbodyintNo
BillingIntervalTimeUnitIdbodylongNo
TrialOccurrencesbodyint?No
TrialBillingIntervalbodyint?No
TrialBillingIntervalTimeUnitIdbodylong?No
SubscriptionBillingStatusIdbodylong?No
IdpathlongNo
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdbodylongNo
RegistrationIdbodylongNo
UnitIdbodystringNo
SubscriptionStatusTypeIdbodylongNo
BrandIdbodylongNo
StartDatebodyDateTimeNo
PreviousBillDatebodyDateTime?No
CurrentBillDatebodyDateTime?No
NextBillDatebodyDateTime?No
PaidUntilbodyDateTime?No
NumberOfOccurrencesbodyintNo
BillingIntervalbodyintNo
BillingIntervalTimeUnitIdbodylongNo
TrialOccurrencesbodyint?No
TrialBillingIntervalbodyint?No
TrialBillingIntervalTimeUnitIdbodylong?No
SubscriptionBillingStatusIdbodylong?No
IdpathlongNo

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_Subscription HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/json
Content-Length: length

{"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}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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}