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 .xml suffix or ?format=xml

HTTP + XML

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

POST /xml/reply/R_AccountHolder HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_AccountHolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <AccountId>0</AccountId>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <CardCode>String</CardCode>
  <City>String</City>
  <Country>String</Country>
  <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
  <CreditCardNumber>String</CreditCardNumber>
  <Email>String</Email>
  <ExpirationMonth>0</ExpirationMonth>
  <ExpirationYear>0</ExpirationYear>
  <FirstName>String</FirstName>
  <Id>0</Id>
  <LastName>String</LastName>
  <NeedToUpdatePaymentInfo>false</NeedToUpdatePaymentInfo>
  <PhoneNumber>String</PhoneNumber>
  <StateProvince>String</StateProvince>
  <TotalNumberOfRecords>0</TotalNumberOfRecords>
  <UpdatePaymentInfoDate>0001-01-01T00:00:00</UpdatePaymentInfoDate>
  <ZipCode>String</ZipCode>
</R_AccountHolder>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_AccountHolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <AccountId>0</AccountId>
  <Address1>String</Address1>
  <Address2>String</Address2>
  <CardCode>String</CardCode>
  <City>String</City>
  <Country>String</Country>
  <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
  <CreditCardNumber>String</CreditCardNumber>
  <Email>String</Email>
  <ExpirationMonth>0</ExpirationMonth>
  <ExpirationYear>0</ExpirationYear>
  <FirstName>String</FirstName>
  <Id>0</Id>
  <LastName>String</LastName>
  <NeedToUpdatePaymentInfo>false</NeedToUpdatePaymentInfo>
  <PhoneNumber>String</PhoneNumber>
  <StateProvince>String</StateProvince>
  <TotalNumberOfRecords>0</TotalNumberOfRecords>
  <UpdatePaymentInfoDate>0001-01-01T00:00:00</UpdatePaymentInfoDate>
  <ZipCode>String</ZipCode>
</R_AccountHolder>