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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/R_CustomFieldBundles HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
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/csv
Content-Length: length

[{"Id":0,"Name":"String","Description":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","UpdatedDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0,"CustomFieldList":[{"Id":0,"CustomFieldTypeId":0,"Name":"String","Value":"String","CreatedDate":"\/Date(-62135596800000-0000)\/","UpdatedDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0}]}]