Registrar Web Services

<back to all web services

R_RegistrationCustomFields

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
GET,OPTIONS/R_RegistrationCustomFields
GET,OPTIONS/R_RegistrationCustomFields/{Ids}
GET,OPTIONS/R_RegistrationCustomFields/RegistrationId/{RegistrationId}
GET,OPTIONS/R_RegistrationCustomFields/UnitId/{UnitId}
GET,OPTIONS/R_RegistrationCustomFields/AccountId/{AccountId}
R_RegistrationCustomFields Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
RegistrationIdpathlong?No
UnitIdpathstringNo
AccountIdpathlong?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_RegistrationCustomFields HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_RegistrationCustomFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Queries">
  <AccountId>0</AccountId>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Ids>
  <RegistrationId>0</RegistrationId>
  <UnitId>String</UnitId>
</R_RegistrationCustomFields>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfR_RegistrationCustomField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_RegistrationCustomField>
    <CustomFieldName>String</CustomFieldName>
    <CustomFieldValue>String</CustomFieldValue>
    <Id>0</Id>
    <RegistrationId>0</RegistrationId>
  </R_RegistrationCustomField>
</ArrayOfR_RegistrationCustomField>