Registrar Web Services

<back to all web services

R_AccountHolder

Requires Authentication
Required role:Admin
The following routes are available for this service:
DELETE, OPTIONS/R_AccountHolders/{Id}
POST, OPTIONS/R_Accounts/{AccountId}/R_AccountHolders
DELETE, OPTIONS/R_Accounts/{AccountId}/R_AccountHolders/{Id}
PUT, OPTIONS/R_Accounts/{AccountId}/R_AccountHolders/{Id}
R_AccountHolder Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
AccountIdpathlongNo
CreationDateTimebodyDateTime?No
EmailbodystringNo
PhoneNumberbodystringNo
FirstNamebodystringNo
LastNamebodystringNo
Address1bodystringNo
Address2bodystringNo
CitybodystringNo
StateProvincebodystringNo
ZipCodebodystringNo
CountrybodystringNo
CreditCardNumberbodystringNo
CardCodebodystringNo
ExpirationMonthbodyint?No
ExpirationYearbodyint?No
NeedToUpdatePaymentInfobodyboolNo
UpdatePaymentInfoDatebodyDateTime?No
TotalNumberOfRecordsbodylongNo
R_AccountHolder Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
AccountIdpathlongNo
CreationDateTimebodyDateTime?No
EmailbodystringNo
PhoneNumberbodystringNo
FirstNamebodystringNo
LastNamebodystringNo
Address1bodystringNo
Address2bodystringNo
CitybodystringNo
StateProvincebodystringNo
ZipCodebodystringNo
CountrybodystringNo
CreditCardNumberbodystringNo
CardCodebodystringNo
ExpirationMonthbodyint?No
ExpirationYearbodyint?No
NeedToUpdatePaymentInfobodyboolNo
UpdatePaymentInfoDatebodyDateTime?No
TotalNumberOfRecordsbodylongNo

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_AccountHolder HTTP/1.1 
Host: regapi.pumpalarm.com 
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}
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}