Registrar Web Services

<back to all web services

R_CustomFieldBundle

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_CustomFieldBundles
PUT,OPTIONS/R_CustomFieldBundles/{Id}
DELETE,OPTIONS/R_CustomFieldBundles/{Id}
R_CustomFieldBundle Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
NamebodystringNo
DescriptionbodystringNo
CreatedDatebodyDateTimeNo
UpdatedDatebodyDateTime?No
TotalNumberOfRecordsbodylongNo
CustomFieldListbodyList<R_CustomField>No
R_CustomField Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CustomFieldTypeIdformlongNo
NameformstringNo
ValueformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTime?No
TotalNumberOfRecordsformlongNo
R_CustomFieldBundle Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
NamebodystringNo
DescriptionbodystringNo
CreatedDatebodyDateTimeNo
UpdatedDatebodyDateTime?No
TotalNumberOfRecordsbodylongNo
CustomFieldListbodyList<R_CustomField>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_CustomFieldBundle HTTP/1.1 
Host: regapi.pumpalarm.com 
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
		}
	]
}
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
		}
	]
}