Registrar Web Services

<back to all web services

R_AccountHolders

Requires Authentication
Required role:Admin
The following routes are available for this service:
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
R_AccountHolders Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathlong?No
IdspathList<long>No
FullDetailsqueryboolNo
LastNamequerystringNo
UnitIdpathstringNo
EmailpathstringNo
EmailIdsqueryList<string>No
OnlySubscriptionOwnersWithActiveSubscriptionqueryboolNo
AccountIdspathList<long>No
FirstNamequerystringNo
CityquerystringNo
StateCodequerystringNo
OnlyRecordCountqueryboolNo
SortByquerystringNo
DescOrderqueryboolNo
StartIndexquerylong?No
PageSizequerylong?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/R_AccountHolders HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
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: text/csv
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}]