Registrar Web Services

<back to all web services

R_CanActivateRegistrationRequest

R_CanActivateRegistrationRequest Parameters:
NameParameterData TypeRequiredDescription
UnitIdbodystringNo
AccountIdbodylong?No
R_CanActivateRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
CanActivateformboolNo
IsExchangeableformboolNo
RegistrationIdformlongNo
BrandformR_BrandNo
ExchangeReasonformstringNo
R_Brand Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ParentBrandIdformlong?No
NameformstringNo
BrandTypeIdformlongNo
BrandNameformstringNo
LogoUrlformstringNo
LicenseUrlformstringNo
ActivationUrlformstringNo
CompanyInfoformR_CompanyNo
InvoicedEmailTemplateformstringNo
PaymentConfirmationEmailTemplateformstringNo
ReceiptEmailTemplateformstringNo
RtuActivatedEmailTemplateformstringNo
RtuDeactivatedEmailTemplateformstringNo
CreditCardWarning1EmailTemplateformstringNo
CreditCardWarning2EmailTemplateformstringNo
CreditCardWarning3EmailTemplateformstringNo
CreditCardUpdateUrlformstringNo
PaymentFailureEmailTemplateformstringNo
Dunning1EmailTemplateformstringNo
Dunning2EmailTemplateformstringNo
Dunning3EmailTemplateformstringNo
Dunning4EmailTemplateformstringNo
DunningUpdateUrlformstringNo
RefundEmailTemplateformstringNo
TransferUnitEmailTemplateformstringNo
ResetCustomerPasswordEmailTemplateformstringNo
TotalNumberOfRecordsformlongNo
R_Company Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UrlformstringNo
LogoUrlformstringNo
StreetformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
PhoneformstringNo
EmailformstringNo
CustomerSupportPhoneNumberformstringNo
CustomerSupportEmailformstringNo
CustomerSupportHoursformstringNo

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

HTTP + SOAP12

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

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

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

<R_CanActivateRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Activation">
  <AccountId>0</AccountId>
  <UnitId>String</UnitId>
</R_CanActivateRegistrationRequest>

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

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

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

    </soap12:Body>
</soap12:Envelope>