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 .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_RegistrationOfCommission HTTP/1.1 
Host: regapi.pumpalarm.com 
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}
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}