Arlo home

REST Auth API: Custom field instances

Certain entities, such as leads and contacts, may be associated with one or more custom field instances. A custom field is an additional property of an entity and may be returned with the entity as a member of a collection of instances. By 'additional', we mean a property of a resource that is configurable per platform, and hence may or will differ between platforms.

Additionally, each custom field instance is associated with a metadata instance that may be examined using the custom field meta data endpoint.

Custom field instance resource

Resource URI

This type of object is part of a collection and has no distinct resource URI

Resource properties

Property Description
Identifier A Guid that represents the unique platform identifier of the metadata associated with this instance. The name of the child element is an encoding of the custom field type - see the custom field meta data endpoint for details on possible types
Name A string representing the system name of this instance.
Value An element with a single child element repesenting the value attached to this instance.
Link (title) Description
CustomField Reference to the metadata resource for this object.

Example

An example (and elided) XML document including custom fields is shown below.

                            
<?xml version="1.0" encoding="utf-8"?>
<Lead>
  <LeadID>131</LeadID>
  <Topic>My private topic</Topic>
  <Category>Private event</Category>
  <Information>Misc</Information>
  <Type>NewPrivateEvent</Type>
  <Status>Open</Status>
  <CreatedDateTime>2015-02-11T02:50:38.760Z</CreatedDateTime>
  <LastModifiedDateTime>2015-02-17T00:16:20.523Z</LastModifiedDateTime>
  <CustomFields>
    <Field>
      <Identifier>04d349e5-dc60-4c6e-867f-1d7dc7f2ed0b</Identifier>
      <Name>NumberOfExpectedParticipants</Name>
      <Value>
        <String>5-10</String>
      </Value>
      <Link rel="related" type="application/xml" title="CustomField" href="https://api.learningsourceapp.com/demo/api/2012-02-01/auth/resources/lead/describe/04d349e5-dc60-4c6e-867f-1d7dc7f2ed0b/"/>
    </Field>
    <Field><Identifier>b4417d82-671a-4a3e-866e-6f8ac88acedf</Identifier>
      <Name>QualificationsOfExpectedParticipants</Name>
      <Value>
         <String>Majority of attendees have a tertiary qualification</String>
      </Value>
      <Link rel="related" type="application/xml" title="CustomField" href="https://api.learningsourceapp.com/demo/api/2012-02-01/auth/resources/lead/describe/b4417d82-671a-4a3e-866e-6f8ac88acedf/"/>
    </Field>
    <Field><Identifier>2ed993dc-79d1-491a-98ed-7eb095528131</Identifier>
      <Name>InHouseCourseLocation</Name>
      <Value>
         <String>Auckland</String>
      </Value><Link rel="related" type="application/xml" title="CustomField" href="https://api.learningsourceapp.com/demo/api/2012-02-01/auth/resources/lead/describe/2ed993dc-79d1-491a-98ed-7eb095528131/"/>
    </Field>
    <Field>
      <Identifier>a01d543e-713a-488d-a961-87dcb092695c</Identifier>
      <Name>ServiceLengthOfExpectedParticipants</Name>
      <Value>
         <String>1-3 years</String>
      </Value>
      <Link rel="related" type="application/xml" title="CustomField" href="https://api.learningsourceapp.com/demo/api/2012-02-01/auth/resources/lead/describe/a01d543e-713a-488d-a961-87dcb092695c/"/>
    </Field>
    <Field>
      <Identifier>688df318-0957-4c58-aaa2-c930eaa42bb9</Identifier>
      <Name>LevelOfExpectedParticipants</Name>
      <Value>
          <String>Entry</String>
      </Value>
      <Link rel="related" type="application/xml" title="CustomField" href="https://api.learningsourceapp.com/demo/api/2012-02-01/auth/resources/lead/describe/688df318-0957-4c58-aaa2-c930eaa42bb9/"/>
    </Field>
  </CustomFields>
  ...