Required role: | Admin |
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} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | long | No | |
AccountId | path | long | No | |
CreationDateTime | body | DateTime? | No | |
body | string | No | ||
PhoneNumber | body | string | No | |
FirstName | body | string | No | |
LastName | body | string | No | |
Address1 | body | string | No | |
Address2 | body | string | No | |
City | body | string | No | |
StateProvince | body | string | No | |
ZipCode | body | string | No | |
Country | body | string | No | |
CreditCardNumber | body | string | No | |
CardCode | body | string | No | |
ExpirationMonth | body | int? | No | |
ExpirationYear | body | int? | No | |
NeedToUpdatePaymentInfo | body | bool | No | |
UpdatePaymentInfoDate | body | DateTime? | No | |
TotalNumberOfRecords | body | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | long | No | |
AccountId | path | long | No | |
CreationDateTime | body | DateTime? | No | |
body | string | No | ||
PhoneNumber | body | string | No | |
FirstName | body | string | No | |
LastName | body | string | No | |
Address1 | body | string | No | |
Address2 | body | string | No | |
City | body | string | No | |
StateProvince | body | string | No | |
ZipCode | body | string | No | |
Country | body | string | No | |
CreditCardNumber | body | string | No | |
CardCode | body | string | No | |
ExpirationMonth | body | int? | No | |
ExpirationYear | body | int? | No | |
NeedToUpdatePaymentInfo | body | bool | No | |
UpdatePaymentInfoDate | body | DateTime? | No | |
TotalNumberOfRecords | body | 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_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}