GET Api/Applicant/CustomFields/{applicantId}

Returns all custom field values for a specific applicant profile. Only custom fields that have a value are returned, "empty" custom fields will be ignored.

Request Information

URI Parameters

Name	Description	Type	Additional information
applicantId	The ID of the applicant.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of custom fields including their respectivy values. Returns HTTP 404 if the specified applicant ID does not exist. Returns HTTP 403 if access the the specified applicant is denied.

Collection of CustomFieldValueResponse

Name	Description	Type	Additional information
CustomField	The associated custom field where the value belongs to.	CustomFieldResponse	None.
Value	The Value property provides a formatted version of the one property which holds a value (Either BoolValue property, StringValue property, DateValue property or NumberValue).	string	None.
BoolValue	Contains a boolean value true or false if type is CustomFieldType.CheckBox.	boolean	None.
DateValue	Contains a datetime value if type is CustomFieldType.Date.	date	None.
StringValue	Contains a string if type is either CustomFieldType.TextMultiLine, CustomFieldType.TextSingleLine, CustomFieldType.DropdownList or CustomFieldType.Html. If type is CustomFieldType.CheckboxList the property contains all values separated by the "\|" character.	string	None.
NumberValue	Contains a number value if a value of any type (usually CustomFieldType.DropdownList) can be parsed to a number.	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomField": {
      "Name": "sample string 1",
      "Title": "sample string 2",
      "GroupName": "sample string 3",
      "Type": 0,
      "Target": 0,
      "IsPublic": true,
      "PossibleValues": [
        "sample string 1",
        "sample string 2"
      ],
      "DefaultValue": "sample string 5"
    },
    "Value": "sample string 1",
    "BoolValue": true,
    "DateValue": "2025-01-06T20:29:55.0780481+01:00",
    "StringValue": "sample string 2",
    "NumberValue": 1.0
  },
  {
    "CustomField": {
      "Name": "sample string 1",
      "Title": "sample string 2",
      "GroupName": "sample string 3",
      "Type": 0,
      "Target": 0,
      "IsPublic": true,
      "PossibleValues": [
        "sample string 1",
        "sample string 2"
      ],
      "DefaultValue": "sample string 5"
    },
    "Value": "sample string 1",
    "BoolValue": true,
    "DateValue": "2025-01-06T20:29:55.0780481+01:00",
    "StringValue": "sample string 2",
    "NumberValue": 1.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomFieldValueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <CustomFieldValueResponse>
    <BoolValue>true</BoolValue>
    <CustomField>
      <DefaultValue>sample string 5</DefaultValue>
      <GroupName>sample string 3</GroupName>
      <IsPublic>true</IsPublic>
      <Name>sample string 1</Name>
      <PossibleValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PossibleValues>
      <Target>Applicant</Target>
      <Title>sample string 2</Title>
      <Type>TextMultiLine</Type>
    </CustomField>
    <DateValue>2025-01-06T20:29:55.0780481+01:00</DateValue>
    <NumberValue>1</NumberValue>
    <StringValue>sample string 2</StringValue>
    <Value>sample string 1</Value>
  </CustomFieldValueResponse>
  <CustomFieldValueResponse>
    <BoolValue>true</BoolValue>
    <CustomField>
      <DefaultValue>sample string 5</DefaultValue>
      <GroupName>sample string 3</GroupName>
      <IsPublic>true</IsPublic>
      <Name>sample string 1</Name>
      <PossibleValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </PossibleValues>
      <Target>Applicant</Target>
      <Title>sample string 2</Title>
      <Type>TextMultiLine</Type>
    </CustomField>
    <DateValue>2025-01-06T20:29:55.0780481+01:00</DateValue>
    <NumberValue>1</NumberValue>
    <StringValue>sample string 2</StringValue>
    <Value>sample string 1</Value>
  </CustomFieldValueResponse>
</ArrayOfCustomFieldValueResponse>