Registrar Web Services

<back to all web services

R_RegistrationOfCommissions

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET, OPTIONS/R_RegistrationOfCommissions/BrandIds/{BrandIds}/RegistrationStatusTypeIds/{RegistrationStatusTypeIds}
GET, OPTIONS/R_RegistrationOfCommissions/BrandIds/{BrandIds}/StatusIds/{RegistrationStatusTypeIds}/{ShowOnlyDelinquentUnits}/Start/{StartIndex}/PageSize/{NumberOfRecords}
R_RegistrationOfCommissions Parameters:
NameParameterData TypeRequiredDescription
StartIndexpathlong?No
NumberOfRecordspathlong?No
BrandIdspathList<long>No
RegistrationStatusTypeIdspathList<long>No
FilterquerystringNo
SearchTermquerystringNo
ShowOnlyDelinquentUnitspathboolNo

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_RegistrationOfCommissions HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_RegistrationOfCommissions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Views">
  <BrandIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </BrandIds>
  <Filter>String</Filter>
  <NumberOfRecords>0</NumberOfRecords>
  <RegistrationStatusTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </RegistrationStatusTypeIds>
  <SearchTerm>String</SearchTerm>
  <ShowOnlyDelinquentUnits>false</ShowOnlyDelinquentUnits>
  <StartIndex>0</StartIndex>
</R_RegistrationOfCommissions>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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