Registrar Web Services

<back to all web services

R_RegistrationOfCommission

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS/R_RegistrationOfCommission
R_RegistrationOfCommission Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
RegistrationqueryR_RegistrationNo
AccountHolderqueryR_AccountHolderNo
SubscriptionAmountquerydecimalNo
TotalNumberOfRegistrationsquerylongNo
ConsideredForCommissionqueryboolNo
DunningLevelIdquerylong?No
R_Registration Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UnitIdformstringNo
MerchantIdformstringNo
CreationDateTimeformDateTime?No
RegistrationStatusformlongNo
AccountIdformlong?No
ProductIdformlongNo
ProductNameformstringNo
PlanIdformlong?No
PlanNameformstringNo
SubscriptionIdformlong?No
CellularServiceIdformlong?No
BrandIdformlongNo
BrandNameformstringNo
EligibleBundleIdformlong?No
BundleNameformstringNo
ResellerIdformlong?No
ResellerNameformstringNo
CellularServiceformR_CellularServiceNo
SubscriptionformR_SubscriptionNo
TotalNumberOfRecordsformlongNo
R_CellularService Parameters:
NameParameterData TypeRequiredDescription
RegistrationIdformlongNo
UnitIdformstringNo
ProductNameformstringNo
CellDeviceIdformstringNo
DeviceSerialNumberformstringNo
PhoneNumberformstringNo
BrandNameformstringNo
ProfileIdformlongNo
CellularDeviceStateIdformlongNo
CreateDateTimeformDateTimeNo
LastUpdatDateTimeformDateTimeNo
ContactEmailformstringNo
IdformlongNo
TotalNumberOfRecordsformlongNo
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdformlongNo
RegistrationIdformlongNo
UnitIdformstringNo
SubscriptionStatusTypeIdformlongNo
BrandIdformlongNo
StartDateformDateTimeNo
PreviousBillDateformDateTime?No
CurrentBillDateformDateTime?No
NextBillDateformDateTime?No
PaidUntilformDateTime?No
NumberOfOccurrencesformintNo
BillingIntervalformintNo
BillingIntervalTimeUnitIdformlongNo
TrialOccurrencesformint?No
TrialBillingIntervalformint?No
TrialBillingIntervalTimeUnitIdformlong?No
SubscriptionBillingStatusIdformlong?No
IdformlongNo
R_AccountHolder Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
CreationDateTimeformDateTime?No
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateProvinceformstringNo
ZipCodeformstringNo
CountryformstringNo
CreditCardNumberformstringNo
CardCodeformstringNo
ExpirationMonthformint?No
ExpirationYearformint?No
NeedToUpdatePaymentInfoformboolNo
UpdatePaymentInfoDateformDateTime?No
TotalNumberOfRecordsformlongNo
R_RegistrationOfCommission Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
RegistrationqueryR_RegistrationNo
AccountHolderqueryR_AccountHolderNo
SubscriptionAmountquerydecimalNo
TotalNumberOfRegistrationsquerylongNo
ConsideredForCommissionqueryboolNo
DunningLevelIdquerylong?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_RegistrationOfCommission HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_RegistrationOfCommission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <AccountHolder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:CardCode>String</d2p1:CardCode>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CreationDateTime>0001-01-01T00:00:00</d2p1:CreationDateTime>
    <d2p1:CreditCardNumber>String</d2p1:CreditCardNumber>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:ExpirationMonth>0</d2p1:ExpirationMonth>
    <d2p1:ExpirationYear>0</d2p1:ExpirationYear>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:NeedToUpdatePaymentInfo>false</d2p1:NeedToUpdatePaymentInfo>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:StateProvince>String</d2p1:StateProvince>
    <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
    <d2p1:UpdatePaymentInfoDate>0001-01-01T00:00:00</d2p1:UpdatePaymentInfoDate>
    <d2p1:ZipCode>String</d2p1:ZipCode>
  </AccountHolder>
  <ConsideredForCommission>false</ConsideredForCommission>
  <DunningLevelId>0</DunningLevelId>
  <Id>0</Id>
  <Registration xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:BrandId>0</d2p1:BrandId>
    <d2p1:BrandName>String</d2p1:BrandName>
    <d2p1:BundleName>String</d2p1:BundleName>
    <d2p1:CellularService>
      <d2p1:BrandName>String</d2p1:BrandName>
      <d2p1:CellDeviceId>String</d2p1:CellDeviceId>
      <d2p1:CellularDeviceStateId>0</d2p1:CellularDeviceStateId>
      <d2p1:ContactEmail>String</d2p1:ContactEmail>
      <d2p1:CreateDateTime>0001-01-01T00:00:00</d2p1:CreateDateTime>
      <d2p1:DeviceSerialNumber>String</d2p1:DeviceSerialNumber>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastUpdatDateTime>0001-01-01T00:00:00</d2p1:LastUpdatDateTime>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:ProductName>String</d2p1:ProductName>
      <d2p1:ProfileId>0</d2p1:ProfileId>
      <d2p1:RegistrationId>0</d2p1:RegistrationId>
      <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
      <d2p1:UnitId>String</d2p1:UnitId>
    </d2p1:CellularService>
    <d2p1:CellularServiceId>0</d2p1:CellularServiceId>
    <d2p1:CreationDateTime>0001-01-01T00:00:00</d2p1:CreationDateTime>
    <d2p1:EligibleBundleId>0</d2p1:EligibleBundleId>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:MerchantId>String</d2p1:MerchantId>
    <d2p1:PlanId>0</d2p1:PlanId>
    <d2p1:PlanName>String</d2p1:PlanName>
    <d2p1:ProductId>0</d2p1:ProductId>
    <d2p1:ProductName>String</d2p1:ProductName>
    <d2p1:RegistrationStatus>0</d2p1:RegistrationStatus>
    <d2p1:ResellerId>0</d2p1:ResellerId>
    <d2p1:ResellerName>String</d2p1:ResellerName>
    <d2p1:Subscription>
      <d2p1:AccountHolderId>0</d2p1:AccountHolderId>
      <d2p1:BillingInterval>0</d2p1:BillingInterval>
      <d2p1:BillingIntervalTimeUnitId>0</d2p1:BillingIntervalTimeUnitId>
      <d2p1:BrandId>0</d2p1:BrandId>
      <d2p1:CurrentBillDate>0001-01-01T00:00:00</d2p1:CurrentBillDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:NextBillDate>0001-01-01T00:00:00</d2p1:NextBillDate>
      <d2p1:NumberOfOccurrences>0</d2p1:NumberOfOccurrences>
      <d2p1:PaidUntil>0001-01-01T00:00:00</d2p1:PaidUntil>
      <d2p1:PreviousBillDate>0001-01-01T00:00:00</d2p1:PreviousBillDate>
      <d2p1:RegistrationId>0</d2p1:RegistrationId>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:SubscriptionBillingStatusId>0</d2p1:SubscriptionBillingStatusId>
      <d2p1:SubscriptionStatusTypeId>0</d2p1:SubscriptionStatusTypeId>
      <d2p1:TrialBillingInterval>0</d2p1:TrialBillingInterval>
      <d2p1:TrialBillingIntervalTimeUnitId>0</d2p1:TrialBillingIntervalTimeUnitId>
      <d2p1:TrialOccurrences>0</d2p1:TrialOccurrences>
      <d2p1:UnitId>String</d2p1:UnitId>
    </d2p1:Subscription>
    <d2p1:SubscriptionId>0</d2p1:SubscriptionId>
    <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
    <d2p1:UnitId>String</d2p1:UnitId>
  </Registration>
  <SubscriptionAmount>0</SubscriptionAmount>
  <TotalNumberOfRegistrations>0</TotalNumberOfRegistrations>
</R_RegistrationOfCommission>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_RegistrationOfCommission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <AccountHolder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:CardCode>String</d2p1:CardCode>
    <d2p1:City>String</d2p1:City>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CreationDateTime>0001-01-01T00:00:00</d2p1:CreationDateTime>
    <d2p1:CreditCardNumber>String</d2p1:CreditCardNumber>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:ExpirationMonth>0</d2p1:ExpirationMonth>
    <d2p1:ExpirationYear>0</d2p1:ExpirationYear>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:NeedToUpdatePaymentInfo>false</d2p1:NeedToUpdatePaymentInfo>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:StateProvince>String</d2p1:StateProvince>
    <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
    <d2p1:UpdatePaymentInfoDate>0001-01-01T00:00:00</d2p1:UpdatePaymentInfoDate>
    <d2p1:ZipCode>String</d2p1:ZipCode>
  </AccountHolder>
  <ConsideredForCommission>false</ConsideredForCommission>
  <DunningLevelId>0</DunningLevelId>
  <Id>0</Id>
  <Registration xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:BrandId>0</d2p1:BrandId>
    <d2p1:BrandName>String</d2p1:BrandName>
    <d2p1:BundleName>String</d2p1:BundleName>
    <d2p1:CellularService>
      <d2p1:BrandName>String</d2p1:BrandName>
      <d2p1:CellDeviceId>String</d2p1:CellDeviceId>
      <d2p1:CellularDeviceStateId>0</d2p1:CellularDeviceStateId>
      <d2p1:ContactEmail>String</d2p1:ContactEmail>
      <d2p1:CreateDateTime>0001-01-01T00:00:00</d2p1:CreateDateTime>
      <d2p1:DeviceSerialNumber>String</d2p1:DeviceSerialNumber>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastUpdatDateTime>0001-01-01T00:00:00</d2p1:LastUpdatDateTime>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:ProductName>String</d2p1:ProductName>
      <d2p1:ProfileId>0</d2p1:ProfileId>
      <d2p1:RegistrationId>0</d2p1:RegistrationId>
      <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
      <d2p1:UnitId>String</d2p1:UnitId>
    </d2p1:CellularService>
    <d2p1:CellularServiceId>0</d2p1:CellularServiceId>
    <d2p1:CreationDateTime>0001-01-01T00:00:00</d2p1:CreationDateTime>
    <d2p1:EligibleBundleId>0</d2p1:EligibleBundleId>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:MerchantId>String</d2p1:MerchantId>
    <d2p1:PlanId>0</d2p1:PlanId>
    <d2p1:PlanName>String</d2p1:PlanName>
    <d2p1:ProductId>0</d2p1:ProductId>
    <d2p1:ProductName>String</d2p1:ProductName>
    <d2p1:RegistrationStatus>0</d2p1:RegistrationStatus>
    <d2p1:ResellerId>0</d2p1:ResellerId>
    <d2p1:ResellerName>String</d2p1:ResellerName>
    <d2p1:Subscription>
      <d2p1:AccountHolderId>0</d2p1:AccountHolderId>
      <d2p1:BillingInterval>0</d2p1:BillingInterval>
      <d2p1:BillingIntervalTimeUnitId>0</d2p1:BillingIntervalTimeUnitId>
      <d2p1:BrandId>0</d2p1:BrandId>
      <d2p1:CurrentBillDate>0001-01-01T00:00:00</d2p1:CurrentBillDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:NextBillDate>0001-01-01T00:00:00</d2p1:NextBillDate>
      <d2p1:NumberOfOccurrences>0</d2p1:NumberOfOccurrences>
      <d2p1:PaidUntil>0001-01-01T00:00:00</d2p1:PaidUntil>
      <d2p1:PreviousBillDate>0001-01-01T00:00:00</d2p1:PreviousBillDate>
      <d2p1:RegistrationId>0</d2p1:RegistrationId>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:SubscriptionBillingStatusId>0</d2p1:SubscriptionBillingStatusId>
      <d2p1:SubscriptionStatusTypeId>0</d2p1:SubscriptionStatusTypeId>
      <d2p1:TrialBillingInterval>0</d2p1:TrialBillingInterval>
      <d2p1:TrialBillingIntervalTimeUnitId>0</d2p1:TrialBillingIntervalTimeUnitId>
      <d2p1:TrialOccurrences>0</d2p1:TrialOccurrences>
      <d2p1:UnitId>String</d2p1:UnitId>
    </d2p1:Subscription>
    <d2p1:SubscriptionId>0</d2p1:SubscriptionId>
    <d2p1:TotalNumberOfRecords>0</d2p1:TotalNumberOfRecords>
    <d2p1:UnitId>String</d2p1:UnitId>
  </Registration>
  <SubscriptionAmount>0</SubscriptionAmount>
  <TotalNumberOfRegistrations>0</TotalNumberOfRegistrations>
</R_RegistrationOfCommission>