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

HTTP + XML

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

POST /xml/reply/R_CustomFields HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_CustomFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <CustomFieldTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </CustomFieldTypeIds>
  <DescOrder>false</DescOrder>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <Name>String</Name>
  <NumberOfRecords>0</NumberOfRecords>
  <OnlyRecordsCount>false</OnlyRecordsCount>
  <SortBy>String</SortBy>
  <StartIndex>0</StartIndex>
  <Value>String</Value>
</R_CustomFields>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_CustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_CustomField>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CustomFieldTypeId>0</CustomFieldTypeId>
    <Id>0</Id>
    <Name>String</Name>
    <TotalNumberOfRecords>0</TotalNumberOfRecords>
    <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
    <Value>String</Value>
  </R_CustomField>
</ArrayOfR_CustomField>