Registrar Web Services

<back to all web services

R_ProtectedBrandCommissionOrders

Returns a list of R_BrandCommissionOrders resource for given filters

Requires Authentication
Required role:BrandOwner
The following routes are available for this service:
GET/UserApi/R_BrandCommissionOrders
R_ProtectedBrandCommissionOrders Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<long>No
StartIndexquerylong?No
NumberOfRecordsquerylong?No
IncludeBrandCommissionTransactionqueryboolNo
IncludeBrandCommissionPricequeryboolNo

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

HTTP + CSV

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

POST /csv/reply/R_ProtectedBrandCommissionOrders HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
Content-Length: length

{"Ids":[0],"StartIndex":0,"NumberOfRecords":0,"IncludeBrandCommissionTransaction":false,"IncludeBrandCommissionPrice":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"Id":0,"BrandId":0,"BrandCommissionPriceId":0,"BrandCommissionStatusId":0,"StartDateTime":"\/Date(-62135596800000-0000)\/","EndDateTime":"\/Date(-62135596800000-0000)\/","TotalPrice":0,"CreateDateTime":"\/Date(-62135596800000-0000)\/","UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CurrentIntervalCount":0,"BrandCommissionPrice":{"Id":0,"BrandId":0,"CommissionPriceId":0,"UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CreateDateTime":"\/Date(-62135596800000-0000)\/","CommissionBrands":[{"Id":0,"ParentBrandId":0,"Name":"String","BrandTypeId":0,"BrandName":"String","LogoUrl":"String","LicenseUrl":"String","ActivationUrl":"String","CompanyInfo":{"Name":"String","Url":"String","LogoUrl":"String","Street":"String","City":"String","State":"String","Zip":"String","Phone":"String","Email":"String","CustomerSupportPhoneNumber":"String","CustomerSupportEmail":"String","CustomerSupportHours":"String"},"InvoicedEmailTemplate":"String","PaymentConfirmationEmailTemplate":"String","ReceiptEmailTemplate":"String","RtuActivatedEmailTemplate":"String","RtuDeactivatedEmailTemplate":"String","CreditCardWarning1EmailTemplate":"String","CreditCardWarning2EmailTemplate":"String","CreditCardWarning3EmailTemplate":"String","CreditCardUpdateUrl":"String","PaymentFailureEmailTemplate":"String","Dunning1EmailTemplate":"String","Dunning2EmailTemplate":"String","Dunning3EmailTemplate":"String","Dunning4EmailTemplate":"String","DunningUpdateUrl":"String","RefundEmailTemplate":"String","TransferUnitEmailTemplate":"String","ResetCustomerPasswordEmailTemplate":"String","TotalNumberOfRecords":0}],"CommissionPrice":{"Id":0,"Name":"String","Description":"String","MinimumNumberOfDays":0,"Price":0,"Interval":0,"IntervalCount":0,"UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CreateDateTime":"\/Date(-62135596800000-0000)\/","BrandCommissionPrice":{"Id":0,"BrandId":0,"CommissionPriceId":0,"UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CreateDateTime":"\/Date(-62135596800000-0000)\/","CommissionBrands":[{"Id":0,"ParentBrandId":0,"Name":"String","BrandTypeId":0,"BrandName":"String","LogoUrl":"String","LicenseUrl":"String","ActivationUrl":"String","CompanyInfo":{"Name":"String","Url":"String","LogoUrl":"String","Street":"String","City":"String","State":"String","Zip":"String","Phone":"String","Email":"String","CustomerSupportPhoneNumber":"String","CustomerSupportEmail":"String","CustomerSupportHours":"String"},"InvoicedEmailTemplate":"String","PaymentConfirmationEmailTemplate":"String","ReceiptEmailTemplate":"String","RtuActivatedEmailTemplate":"String","RtuDeactivatedEmailTemplate":"String","CreditCardWarning1EmailTemplate":"String","CreditCardWarning2EmailTemplate":"String","CreditCardWarning3EmailTemplate":"String","CreditCardUpdateUrl":"String","PaymentFailureEmailTemplate":"String","Dunning1EmailTemplate":"String","Dunning2EmailTemplate":"String","Dunning3EmailTemplate":"String","Dunning4EmailTemplate":"String","DunningUpdateUrl":"String","RefundEmailTemplate":"String","TransferUnitEmailTemplate":"String","ResetCustomerPasswordEmailTemplate":"String","TotalNumberOfRecords":0}],"CommissionPrice":{"Id":0,"Name":"String","Description":"String","MinimumNumberOfDays":0,"Price":0,"Interval":0,"IntervalCount":0,"UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CreateDateTime":"\/Date(-62135596800000-0000)\/","BrandCommissionPrice":{"Id":0,"BrandId":0,"CommissionPriceId":0,"UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CreateDateTime":"\/Date(-62135596800000-0000)\/","CommissionBrands":[{"Id":0,"ParentBrandId":0,"Name":"String","BrandTypeId":0,"BrandName":"String","LogoUrl":"String","LicenseUrl":"String","ActivationUrl":"String","CompanyInfo":{"Name":"String","Url":"String","LogoUrl":"String","Street":"String","City":"String","State":"String","Zip":"String","Phone":"String","Email":"String","CustomerSupportPhoneNumber":"String","CustomerSupportEmail":"String","CustomerSupportHours":"String"},"InvoicedEmailTemplate":"String","PaymentConfirmationEmailTemplate":"String","ReceiptEmailTemplate":"String","RtuActivatedEmailTemplate":"String","RtuDeactivatedEmailTemplate":"String","CreditCardWarning1EmailTemplate":"String","CreditCardWarning2EmailTemplate":"String","CreditCardWarning3EmailTemplate":"String","CreditCardUpdateUrl":"String","PaymentFailureEmailTemplate":"String","Dunning1EmailTemplate":"String","Dunning2EmailTemplate":"String","Dunning3EmailTemplate":"String","Dunning4EmailTemplate":"String","DunningUpdateUrl":"String","RefundEmailTemplate":"String","TransferUnitEmailTemplate":"String","ResetCustomerPasswordEmailTemplate":"String","TotalNumberOfRecords":0}],"CommissionPrice":{"Id":0,"Name":"String","Description":"String","MinimumNumberOfDays":0,"Price":0,"Interval":0,"IntervalCount":0,"UpdatedDateTime":"\/Date(-62135596800000-0000)\/","CreateDateTime":"\/Date(-62135596800000-0000)\/"}}}}}},"Brand":{"Id":0,"ParentBrandId":0,"Name":"String","BrandTypeId":0,"BrandName":"String","LogoUrl":"String","LicenseUrl":"String","ActivationUrl":"String","CompanyInfo":{"Name":"String","Url":"String","LogoUrl":"String","Street":"String","City":"String","State":"String","Zip":"String","Phone":"String","Email":"String","CustomerSupportPhoneNumber":"String","CustomerSupportEmail":"String","CustomerSupportHours":"String"},"InvoicedEmailTemplate":"String","PaymentConfirmationEmailTemplate":"String","ReceiptEmailTemplate":"String","RtuActivatedEmailTemplate":"String","RtuDeactivatedEmailTemplate":"String","CreditCardWarning1EmailTemplate":"String","CreditCardWarning2EmailTemplate":"String","CreditCardWarning3EmailTemplate":"String","CreditCardUpdateUrl":"String","PaymentFailureEmailTemplate":"String","Dunning1EmailTemplate":"String","Dunning2EmailTemplate":"String","Dunning3EmailTemplate":"String","Dunning4EmailTemplate":"String","DunningUpdateUrl":"String","RefundEmailTemplate":"String","TransferUnitEmailTemplate":"String","ResetCustomerPasswordEmailTemplate":"String","TotalNumberOfRecords":0}}]