Required role: | Admin |
GET, OPTIONS | /R_AccountHolders | ||
---|---|---|---|
GET, OPTIONS | /R_AccountHolders/{Ids} | ||
GET, OPTIONS | /R_AccountHolders/UnitId/{UnitId} | ||
GET, OPTIONS | /R_AccountHolders/Email/{Email} | ||
GET, OPTIONS | /R_AccountHolders/AccountIds/{AccountIds} | ||
GET, OPTIONS | /R_Accounts/{AccountId}/R_AccountHolders |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AccountId | path | long? | No | |
Ids | path | List<long> | No | |
FullDetails | query | bool | No | |
LastName | query | string | No | |
UnitId | path | string | No | |
path | string | No | ||
EmailIds | query | List<string> | No | |
OnlySubscriptionOwnersWithActiveSubscription | query | bool | No | |
AccountIds | path | List<long> | No | |
FirstName | query | string | No | |
City | query | string | No | |
StateCode | query | string | No | |
OnlyRecordCount | query | bool | No | |
SortBy | query | string | No | |
DescOrder | query | bool | No | |
StartIndex | query | long? | No | |
PageSize | query | long? | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/R_AccountHolders HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: application/json
Content-Length: length
{"AccountId":0,"Ids":[0],"FullDetails":false,"LastName":"String","UnitId":"String","Email":"String","EmailIds":["String"],"OnlySubscriptionOwnersWithActiveSubscription":false,"AccountIds":[0],"FirstName":"String","City":"String","StateCode":"String","OnlyRecordCount":false,"SortBy":"String","DescOrder":false,"StartIndex":0,"PageSize":0}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length [{"Id":0,"AccountId":0,"CreationDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","CreditCardNumber":"String","CardCode":"String","ExpirationMonth":0,"ExpirationYear":0,"NeedToUpdatePaymentInfo":false,"UpdatePaymentInfoDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0}]