Registrar Web Services

<back to all web services

R_CustomField

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_CustomFields
PUT,OPTIONS/R_CustomFields/{Id}
DELETE,OPTIONS/R_CustomFields/{Id}
R_CustomField Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
CustomFieldTypeIdbodylongNo
NamebodystringNo
ValuebodystringNo
CreatedDatebodyDateTimeNo
UpdatedDatebodyDateTime?No
TotalNumberOfRecordsbodylongNo
R_CustomField Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
CustomFieldTypeIdbodylongNo
NamebodystringNo
ValuebodystringNo
CreatedDatebodyDateTimeNo
UpdatedDatebodyDateTime?No
TotalNumberOfRecordsbodylongNo

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_CustomField HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_CustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <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>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_CustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <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>