Registrar Web Services

R_PublicBrands

The following routes are available for this service:
GET, OPTIONS	/UserApi/R_Brands
GET, OPTIONS	/UserApi/R_Brands/{Ids}
GET, OPTIONS	/UserApi/R_Brands/BrandName/{BrandNames}
GET, OPTIONS	/UserApi/R_Brands/Name/{Names}

**R_PublicBrands** Parameters:
Name	Parameter	Data Type	Required
Ids	path	List<long>	No
BrandNames	path	List<string>	No
Names	path	List<string>	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_PublicBrands HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_PublicBrands xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <BrandNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BrandNames>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <Names xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Names>
</R_PublicBrands>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_Brand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_Brand>
    <ActivationUrl>String</ActivationUrl>
    <BrandName>String</BrandName>
    <BrandTypeId>0</BrandTypeId>
    <CompanyInfo>
      <City>String</City>
      <CustomerSupportEmail>String</CustomerSupportEmail>
      <CustomerSupportHours>String</CustomerSupportHours>
      <CustomerSupportPhoneNumber>String</CustomerSupportPhoneNumber>
      <Email>String</Email>
      <LogoUrl>String</LogoUrl>
      <Name>String</Name>
      <Phone>String</Phone>
      <State>String</State>
      <Street>String</Street>
      <Url>String</Url>
      <Zip>String</Zip>
    </CompanyInfo>
    <CreditCardUpdateUrl>String</CreditCardUpdateUrl>
    <CreditCardWarning1EmailTemplate>String</CreditCardWarning1EmailTemplate>
    <CreditCardWarning2EmailTemplate>String</CreditCardWarning2EmailTemplate>
    <CreditCardWarning3EmailTemplate>String</CreditCardWarning3EmailTemplate>
    <Dunning1EmailTemplate>String</Dunning1EmailTemplate>
    <Dunning2EmailTemplate>String</Dunning2EmailTemplate>
    <Dunning3EmailTemplate>String</Dunning3EmailTemplate>
    <Dunning4EmailTemplate>String</Dunning4EmailTemplate>
    <DunningUpdateUrl>String</DunningUpdateUrl>
    <Id>0</Id>
    <InvoicedEmailTemplate>String</InvoicedEmailTemplate>
    <LicenseUrl>String</LicenseUrl>
    <LogoUrl>String</LogoUrl>
    <Name>String</Name>
    <ParentBrandId>0</ParentBrandId>
    <PaymentConfirmationEmailTemplate>String</PaymentConfirmationEmailTemplate>
    <PaymentFailureEmailTemplate>String</PaymentFailureEmailTemplate>
    <ReceiptEmailTemplate>String</ReceiptEmailTemplate>
    <RefundEmailTemplate>String</RefundEmailTemplate>
    <ResetCustomerPasswordEmailTemplate>String</ResetCustomerPasswordEmailTemplate>
    <RtuActivatedEmailTemplate>String</RtuActivatedEmailTemplate>
    <RtuDeactivatedEmailTemplate>String</RtuDeactivatedEmailTemplate>
    <TotalNumberOfRecords>0</TotalNumberOfRecords>
    <TransferUnitEmailTemplate>String</TransferUnitEmailTemplate>
  </R_Brand>
</ArrayOfR_Brand>