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 .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_AccountHolders HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_AccountHolders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <AccountId>0</AccountId>
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccountIds>
  <City>String</City>
  <DescOrder>false</DescOrder>
  <Email>String</Email>
  <EmailIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EmailIds>
  <FirstName>String</FirstName>
  <FullDetails>false</FullDetails>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <LastName>String</LastName>
  <OnlyRecordCount>false</OnlyRecordCount>
  <OnlySubscriptionOwnersWithActiveSubscription>false</OnlySubscriptionOwnersWithActiveSubscription>
  <PageSize>0</PageSize>
  <SortBy>String</SortBy>
  <StartIndex>0</StartIndex>
  <StateCode>String</StateCode>
  <UnitId>String</UnitId>
</R_AccountHolders>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_AccountHolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_AccountHolder>
    <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>
</ArrayOfR_AccountHolder>