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

HTTP + JSV

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

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

{
	StartIndex: 0,
	NumberOfRecords: 0,
	BrandIds: 
	[
		0
	],
	RegistrationStatusTypeIds: 
	[
		0
	],
	Filter: String,
	SearchTerm: String,
	ShowOnlyDelinquentUnits: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Id: 0,
		Registration: 
		{
			Id: 0,
			UnitId: String,
			MerchantId: String,
			CreationDateTime: 0001-01-01,
			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: 0001-01-01,
				LastUpdatDateTime: 0001-01-01,
				ContactEmail: String,
				Id: 0,
				TotalNumberOfRecords: 0
			},
			Subscription: 
			{
				AccountHolderId: 0,
				RegistrationId: 0,
				UnitId: String,
				SubscriptionStatusTypeId: 0,
				BrandId: 0,
				StartDate: 0001-01-01,
				PreviousBillDate: 0001-01-01,
				CurrentBillDate: 0001-01-01,
				NextBillDate: 0001-01-01,
				PaidUntil: 0001-01-01,
				NumberOfOccurrences: 0,
				BillingInterval: 0,
				BillingIntervalTimeUnitId: 0,
				TrialOccurrences: 0,
				TrialBillingInterval: 0,
				TrialBillingIntervalTimeUnitId: 0,
				SubscriptionBillingStatusId: 0,
				Id: 0
			},
			TotalNumberOfRecords: 0
		},
		AccountHolder: 
		{
			Id: 0,
			AccountId: 0,
			CreationDateTime: 0001-01-01,
			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: 0001-01-01,
			TotalNumberOfRecords: 0
		},
		SubscriptionAmount: 0,
		TotalNumberOfRegistrations: 0,
		ConsideredForCommission: False,
		DunningLevelId: 0
	}
]