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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/R_RegistrationOfCommissions HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/json
Content-Length: length

{"StartIndex":0,"NumberOfRecords":0,"BrandIds":[0],"RegistrationStatusTypeIds":[0],"Filter":"String","SearchTerm":"String","ShowOnlyDelinquentUnits":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"Id":0,"Registration":{"Id":0,"UnitId":"String","MerchantId":"String","CreationDateTime":"\/Date(-62135596800000-0000)\/","RegistrationStatus":0,"AccountId":0,"ProductId":0,"ProductName":"String","PlanId":0,"PlanName":"String","SubscriptionId":0,"CellularServiceId":0,"BrandId":0,"BrandName":"String","EligibleBundleId":0,"BundleName":"String","ResellerId":0,"ResellerName":"String","CellularService":{"RegistrationId":0,"UnitId":"String","ProductName":"String","CellDeviceId":"String","DeviceSerialNumber":"String","PhoneNumber":"String","BrandName":"String","ProfileId":0,"CellularDeviceStateId":0,"CreateDateTime":"\/Date(-62135596800000-0000)\/","LastUpdatDateTime":"\/Date(-62135596800000-0000)\/","ContactEmail":"String","Id":0,"TotalNumberOfRecords":0},"Subscription":{"AccountHolderId":0,"RegistrationId":0,"UnitId":"String","SubscriptionStatusTypeId":0,"BrandId":0,"StartDate":"\/Date(-62135596800000-0000)\/","PreviousBillDate":"\/Date(-62135596800000-0000)\/","CurrentBillDate":"\/Date(-62135596800000-0000)\/","NextBillDate":"\/Date(-62135596800000-0000)\/","PaidUntil":"\/Date(-62135596800000-0000)\/","NumberOfOccurrences":0,"BillingInterval":0,"BillingIntervalTimeUnitId":0,"TrialOccurrences":0,"TrialBillingInterval":0,"TrialBillingIntervalTimeUnitId":0,"SubscriptionBillingStatusId":0,"Id":0},"TotalNumberOfRecords":0},"AccountHolder":{"Id":0,"AccountId":0,"CreationDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","CreditCardNumber":"String","CardCode":"String","ExpirationMonth":0,"ExpirationYear":0,"NeedToUpdatePaymentInfo":false,"UpdatePaymentInfoDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0},"SubscriptionAmount":0,"TotalNumberOfRegistrations":0,"ConsideredForCommission":false,"DunningLevelId":0}]