Registrar Web Services

<back to all web services

R_ProtectedBrandCommissionPrices

Returns a list of R_BrandCommissionPrices resource for given filters

Requires Authentication
Required role:BrandOwner
The following routes are available for this service:
GET/UserApi/R_BrandCommissionPrices
R_ProtectedBrandCommissionPrices Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<long>No
IncludeCommissionPricequeryboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?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_ProtectedBrandCommissionPrices HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_ProtectedBrandCommissionPrices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <IncludeCommissionPrice>false</IncludeCommissionPrice>
  <NumberOfRecords>0</NumberOfRecords>
  <StartIndex>0</StartIndex>
</R_ProtectedBrandCommissionPrices>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_BrandCommissionPrice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_BrandCommissionPrice>
    <BrandId>0</BrandId>
    <CommissionBrands>
      <R_Brand>
        <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>
    </CommissionBrands>
    <CommissionPrice>
      <BrandCommissionPrice>
        <BrandId>0</BrandId>
        <CommissionBrands>
          <R_Brand>
            <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>
        </CommissionBrands>
        <CommissionPrice>
          <BrandCommissionPrice>
            <BrandId>0</BrandId>
            <CommissionBrands>
              <R_Brand>
                <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>
            </CommissionBrands>
            <CommissionPrice>
              <BrandCommissionPrice i:nil="true" />
              <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
              <Description>String</Description>
              <Id>0</Id>
              <Interval>0</Interval>
              <IntervalCount>0</IntervalCount>
              <MinimumNumberOfDays>0</MinimumNumberOfDays>
              <Name>String</Name>
              <Price>0</Price>
              <UpdatedDateTime>0001-01-01T00:00:00</UpdatedDateTime>
            </CommissionPrice>
            <CommissionPriceId>0</CommissionPriceId>
            <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
            <Id>0</Id>
            <UpdatedDateTime>0001-01-01T00:00:00</UpdatedDateTime>
          </BrandCommissionPrice>
          <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
          <Description>String</Description>
          <Id>0</Id>
          <Interval>0</Interval>
          <IntervalCount>0</IntervalCount>
          <MinimumNumberOfDays>0</MinimumNumberOfDays>
          <Name>String</Name>
          <Price>0</Price>
          <UpdatedDateTime>0001-01-01T00:00:00</UpdatedDateTime>
        </CommissionPrice>
        <CommissionPriceId>0</CommissionPriceId>
        <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
        <Id>0</Id>
        <UpdatedDateTime>0001-01-01T00:00:00</UpdatedDateTime>
      </BrandCommissionPrice>
      <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
      <Description>String</Description>
      <Id>0</Id>
      <Interval>0</Interval>
      <IntervalCount>0</IntervalCount>
      <MinimumNumberOfDays>0</MinimumNumberOfDays>
      <Name>String</Name>
      <Price>0</Price>
      <UpdatedDateTime>0001-01-01T00:00:00</UpdatedDateTime>
    </CommissionPrice>
    <CommissionPriceId>0</CommissionPriceId>
    <CreateDateTime>0001-01-01T00:00:00</CreateDateTime>
    <Id>0</Id>
    <UpdatedDateTime>0001-01-01T00:00:00</UpdatedDateTime>
  </R_BrandCommissionPrice>
</ArrayOfR_BrandCommissionPrice>