Registrar Web Services

R_Brand

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST,OPTIONS	/R_Brands
PUT,OPTIONS	/R_Brands/{Id}
DELETE,OPTIONS	/R_Brands/{Id}

**R_Brand** Parameters:
Name	Parameter	Data Type	Required
Id	path	long	No
ParentBrandId	body	long?	No
Name	body	string	No
BrandTypeId	body	long	No
BrandName	body	string	No
LogoUrl	body	string	No
LicenseUrl	body	string	No
ActivationUrl	body	string	No
CompanyInfo	body	R_Company	No
InvoicedEmailTemplate	body	string	No
PaymentConfirmationEmailTemplate	body	string	No
ReceiptEmailTemplate	body	string	No
RtuActivatedEmailTemplate	body	string	No
RtuDeactivatedEmailTemplate	body	string	No
CreditCardWarning1EmailTemplate	body	string	No
CreditCardWarning2EmailTemplate	body	string	No
CreditCardWarning3EmailTemplate	body	string	No
CreditCardUpdateUrl	body	string	No
PaymentFailureEmailTemplate	body	string	No
Dunning1EmailTemplate	body	string	No
Dunning2EmailTemplate	body	string	No
Dunning3EmailTemplate	body	string	No
Dunning4EmailTemplate	body	string	No
DunningUpdateUrl	body	string	No
RefundEmailTemplate	body	string	No
TransferUnitEmailTemplate	body	string	No
ResetCustomerPasswordEmailTemplate	body	string	No
TotalNumberOfRecords	body	long	No

**R_Company** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Url	form	string	No
LogoUrl	form	string	No
Street	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Phone	form	string	No
Email	form	string	No
CustomerSupportPhoneNumber	form	string	No
CustomerSupportEmail	form	string	No
CustomerSupportHours	form	string	No

**R_Brand** Parameters:
Name	Parameter	Data Type	Required
Id	path	long	No
ParentBrandId	body	long?	No
Name	body	string	No
BrandTypeId	body	long	No
BrandName	body	string	No
LogoUrl	body	string	No
LicenseUrl	body	string	No
ActivationUrl	body	string	No
CompanyInfo	body	R_Company	No
InvoicedEmailTemplate	body	string	No
PaymentConfirmationEmailTemplate	body	string	No
ReceiptEmailTemplate	body	string	No
RtuActivatedEmailTemplate	body	string	No
RtuDeactivatedEmailTemplate	body	string	No
CreditCardWarning1EmailTemplate	body	string	No
CreditCardWarning2EmailTemplate	body	string	No
CreditCardWarning3EmailTemplate	body	string	No
CreditCardUpdateUrl	body	string	No
PaymentFailureEmailTemplate	body	string	No
Dunning1EmailTemplate	body	string	No
Dunning2EmailTemplate	body	string	No
Dunning3EmailTemplate	body	string	No
Dunning4EmailTemplate	body	string	No
DunningUpdateUrl	body	string	No
RefundEmailTemplate	body	string	No
TransferUnitEmailTemplate	body	string	No
ResetCustomerPasswordEmailTemplate	body	string	No
TotalNumberOfRecords	body	long	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_Brand HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

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

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

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