Registrar Web Services

<back to all web services

R_CellularServices

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_Accounts/AccountId/{AccountId}/R_CellularServices
GET,OPTIONS/R_Registrations/{RegistrationId}/R_CellularServices
GET,OPTIONS/R_CellularServices
GET,OPTIONS/R_CellularServices/{Ids}/{AssignRegistrationId}
GET,OPTIONS/R_Registrations/UnitId/{UnitIds}/R_CellularServices/
GET,OPTIONS/R_Registrations/DeviceId/{DeviceIds}/R_CellularServices
R_CellularServices Parameters:
NameParameterData TypeRequiredDescription
DeviceIdspathList<string>No
RegistrationIdpathlong?No
IdspathList<long>No
UnitIdspathList<string>No
AccountIdpathlong?No
DevicePhoneNumbersqueryList<string>No
DeviceSerialNumbersqueryList<string>No
AssignRegistrationIdpathboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No
CellularDeviceStateIdsqueryList<long>No
GetOnlyRecordsCountqueryboolNo
DescOrderqueryboolNo
SortByquerystringNo

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

{
	DeviceIds: 
	[
		String
	],
	RegistrationId: 0,
	Ids: 
	[
		0
	],
	UnitIds: 
	[
		String
	],
	AccountId: 0,
	DevicePhoneNumbers: 
	[
		String
	],
	DeviceSerialNumbers: 
	[
		String
	],
	AssignRegistrationId: False,
	StartIndex: 0,
	NumberOfRecords: 0,
	CellularDeviceStateIds: 
	[
		0
	],
	GetOnlyRecordsCount: False,
	DescOrder: False,
	SortBy: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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