Registrar Web Services

<back to all web services

R_Subscriptions

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Accounts/{AccountIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
GET,OPTIONS/R_Subscriptions/{AssignRegistrationId}
GET,OPTIONS/R_Subscriptions/{Ids}/AssignRegId/{AssignRegistrationId}
GET,OPTIONS/R_Subscriptions/BrandIds/{BrandIds}/AssignRegId/{AssignRegistrationId}
GET,OPTIONS/R_Registration/RegistrationIds/{RegistrationIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
GET,OPTIONS/R_Registration/UnitIds/{UnitIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
GET,OPTIONS/R_AccountHolders/{AccountHolderIds}/AssignRegId/{AssignRegistrationId}/R_Subscriptions
R_Subscriptions Parameters:
NameParameterData TypeRequiredDescription
RegistrationIdspathList<long>No
UnitIdspathList<string>No
AccountHolderIdspathList<long>No
AccountIdspathList<long>No
IdspathList<long>No
BrandIdspathList<long>No
AssignRegistrationIdpathboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No

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_Subscriptions HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	RegistrationIds: 
	[
		0
	],
	UnitIds: 
	[
		String
	],
	AccountHolderIds: 
	[
		0
	],
	AccountIds: 
	[
		0
	],
	Ids: 
	[
		0
	],
	BrandIds: 
	[
		0
	],
	AssignRegistrationId: False,
	StartIndex: 0,
	NumberOfRecords: 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
	}
]