Registrar Web Services

<back to all web services

R_CustomFieldBundles

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

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

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

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