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

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

<ArrayOfR_CustomFieldBundle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <R_CustomFieldBundle>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CustomFieldList>
      <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>
    </CustomFieldList>
    <Description>String</Description>
    <Id>0</Id>
    <Name>String</Name>
    <TotalNumberOfRecords>0</TotalNumberOfRecords>
    <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
  </R_CustomFieldBundle>
</ArrayOfR_CustomFieldBundle>