Registrar Web Services

<back to all web services

R_Brand

Requires Authentication
Required role:Admin
R_Brand Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
ParentBrandIdbodylong?No
NamebodystringNo
BrandTypeIdbodylongNo
BrandNamebodystringNo
LogoUrlbodystringNo
LicenseUrlbodystringNo
ActivationUrlbodystringNo
CompanyInfobodyR_CompanyNo
InvoicedEmailTemplatebodystringNo
PaymentConfirmationEmailTemplatebodystringNo
ReceiptEmailTemplatebodystringNo
RtuActivatedEmailTemplatebodystringNo
RtuDeactivatedEmailTemplatebodystringNo
CreditCardWarning1EmailTemplatebodystringNo
CreditCardWarning2EmailTemplatebodystringNo
CreditCardWarning3EmailTemplatebodystringNo
CreditCardUpdateUrlbodystringNo
PaymentFailureEmailTemplatebodystringNo
Dunning1EmailTemplatebodystringNo
Dunning2EmailTemplatebodystringNo
Dunning3EmailTemplatebodystringNo
Dunning4EmailTemplatebodystringNo
DunningUpdateUrlbodystringNo
RefundEmailTemplatebodystringNo
TransferUnitEmailTemplatebodystringNo
ResetCustomerPasswordEmailTemplatebodystringNo
TotalNumberOfRecordsbodylongNo
R_Company Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UrlformstringNo
LogoUrlformstringNo
StreetformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
PhoneformstringNo
EmailformstringNo
CustomerSupportPhoneNumberformstringNo
CustomerSupportEmailformstringNo
CustomerSupportHoursformstringNo
R_Brand Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
ParentBrandIdbodylong?No
NamebodystringNo
BrandTypeIdbodylongNo
BrandNamebodystringNo
LogoUrlbodystringNo
LicenseUrlbodystringNo
ActivationUrlbodystringNo
CompanyInfobodyR_CompanyNo
InvoicedEmailTemplatebodystringNo
PaymentConfirmationEmailTemplatebodystringNo
ReceiptEmailTemplatebodystringNo
RtuActivatedEmailTemplatebodystringNo
RtuDeactivatedEmailTemplatebodystringNo
CreditCardWarning1EmailTemplatebodystringNo
CreditCardWarning2EmailTemplatebodystringNo
CreditCardWarning3EmailTemplatebodystringNo
CreditCardUpdateUrlbodystringNo
PaymentFailureEmailTemplatebodystringNo
Dunning1EmailTemplatebodystringNo
Dunning2EmailTemplatebodystringNo
Dunning3EmailTemplatebodystringNo
Dunning4EmailTemplatebodystringNo
DunningUpdateUrlbodystringNo
RefundEmailTemplatebodystringNo
TransferUnitEmailTemplatebodystringNo
ResetCustomerPasswordEmailTemplatebodystringNo
TotalNumberOfRecordsbodylongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: R_Brand

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<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>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<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>

    </soap:Body>
</soap:Envelope>