Registrar Web Services

<back to all web services

R_CustomFields

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS, GET/R_CustomFields
OPTIONS, GET/R_CustomFields/{Ids}
R_CustomFields Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
CustomFieldTypeIdsqueryList<long>No
NamequerystringNo
ValuequerystringNo
OnlyRecordsCountqueryboolNo
SortByquerystringNo
DescOrderqueryboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?No

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

{
	Ids: 
	[
		0
	],
	CustomFieldTypeIds: 
	[
		0
	],
	Name: String,
	Value: String,
	OnlyRecordsCount: False,
	SortBy: String,
	DescOrder: False,
	StartIndex: 0,
	NumberOfRecords: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		Id: 0,
		CustomFieldTypeId: 0,
		Name: String,
		Value: String,
		CreatedDate: 0001-01-01,
		UpdatedDate: 0001-01-01,
		TotalNumberOfRecords: 0
	}
]