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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

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

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