Requires the role: | Admin |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RegistrationIds | path | List<long> | No | |
UnitIds | path | List<string> | No | |
AccountHolderIds | path | List<long> | No | |
AccountIds | path | List<long> | No | |
Ids | path | List<long> | No | |
BrandIds | path | List<long> | No | |
AssignRegistrationId | path | bool | No | |
StartIndex | query | long? | No | |
NumberOfRecords | query | long? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/R_Subscriptions HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/csv
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/csv 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}]