Registrar Web Services

<back to all web services

R_Registrations

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Accounts/{AccountId}/R_Registrations
GET,OPTIONS/R_Registrations/UnitIds/{UnitIds}
GET,OPTIONS/R_Registrations/RegistrationStatus/{RegistrationStatusTypeId}
GET,OPTIONS/R_Registrations/DevicePhoneNumbers/{DevicePhoneNumbers}
GET,OPTIONS/R_Registrations/DeviceIds/{DeviceIds}
GET,OPTIONS/R_Registrations/AccountIds/{AccountIds}
GET,OPTIONS/R_Registrations
GET,OPTIONS/R_Registrations/{Ids}
GET,OPTIONS/R_Registrations/BIds/{BrandIds}/SIds/{RegistrationStatusTypeIds}/AIds/{AccountIds}/Start/{StartIndex}/PageSize/{NumberOfRecords}
GET,OPTIONS/R_Registrations/BIds/{BrandIds}/SIds/{RegistrationStatusTypeIds}/UID/{PartialUnitId}/RId/{ResellerId}/Pids/{ProductIds}/Start/{StartIndex}/PageSize/{NumberOfRecords}
R_Registrations Parameters:
NameParameterData TypeRequiredDescription
PartialUnitIdpathstringNo
ResellerIdpathlong?No
RegistrationStatusTypeIdspathList<long>No
BrandIdspathList<long>No
ProductIdspathList<long>No
AccountIdpathlong?No
UnitIdspathList<string>No
IdspathList<long>No
RegistrationStatusTypeIdpathlong?No
DevicePhoneNumberspathList<string>No
DeviceIdspathList<string>No
AccountIdspathList<long>No
ReturnOnlyTotalNumberOfRecordsqueryboolNo
IncludeMetaDataInformationqueryboolNo
StartIndexpathlong?No
NumberOfRecordspathlong?No
APlanMdqueryboolNo
ABundleMdqueryboolNo
AResellerMdqueryboolNo
ABrandMdqueryboolNo
ASubsMdqueryboolNo
ACellMdqueryboolNo

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_Registrations HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	PartialUnitId: String,
	ResellerId: 0,
	RegistrationStatusTypeIds: 
	[
		0
	],
	BrandIds: 
	[
		0
	],
	ProductIds: 
	[
		0
	],
	AccountId: 0,
	UnitIds: 
	[
		String
	],
	Ids: 
	[
		0
	],
	RegistrationStatusTypeId: 0,
	DevicePhoneNumbers: 
	[
		String
	],
	DeviceIds: 
	[
		String
	],
	AccountIds: 
	[
		0
	],
	ReturnOnlyTotalNumberOfRecords: False,
	IncludeMetaDataInformation: False,
	StartIndex: 0,
	NumberOfRecords: 0,
	APlanMd: False,
	ABundleMd: False,
	AResellerMd: False,
	ABrandMd: False,
	ASubsMd: False,
	ACellMd: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		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
	}
]