Custom Field

A custom field defines an abstract field that admissions staff can use to store arbitrary data about an applicant. The data itself is stored in a custom field answer.

Attributes

Name Type Description Example
custom_fields/field_type string The type of data that this field stores.
one of:"boolean" or "number" or "date" or "string" or "select"
"select"
custom_fields/id integer Unique identifier for this custom field. 4
custom_fields/label string Human-readable name of this custom field. "Preferred house"
custom_fields/options nullable array When field_type is "select", this defines the list of allowed values for the field. Otherwise, this is null. ["Gryffindor","Hufflepuff","Ravenclaw","Slytherin"]
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/programs/\d+/custom_fields
"/api/v1/user_identities/1/programs/42023191739237/custom_fields"

Custom Field List

List existing custom fields.

GET /api/v1/user_identities/:user_identity_id/programs/:program_id/custom_fields

Curl Example

$ curl -n https://api.webadmit.org/api/v1/user_identities/:user_identity_id/programs/:program_id/custom_fields \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK
{
  "href": "/api/v1/user_identities/1/programs/42023191739237/custom_fields",
  "custom_fields": [
    {
      "id": 4,
      "label": "Preferred house",
      "field_type": "select",
      "options": [
        "Gryffindor",
        "Hufflepuff",
        "Ravenclaw",
        "Slytherin"
      ]
    }
  ]
}

Not Found

Specific error messages

When the user_identity is not found

{
  "errors": {
    "schema": [
      "User identity '999' not found."
    ]
  }
}

When the program is not found

{
  "errors": {
    "schema": [
      "Program '99999999999' not found."
    ]
  }
}

When the applicant is not found

{
  "errors": {
    "schema": [
      "Applicant '88888888888' not found."
    ]
  }
}

When the custom field is not found

{
  "errors": {
    "schema": [
      "CustomeField '42' not found."
    ]
  }
}

While these error messages are most often associated with resources that don't exist when making a GET request, please note that the same messages are also the response during POST, PUT, and PATCH requests if any resources specified by parameters cannot be found.

Generic error message (legacy error)

HTTP/1.1 404 Not Found
{
  "message": "Not Found"
}

Liaison is currently phasing out this error message in favor of more descriptive messages. If you encounter this message, please contact your Liaison representative with a detail description of the API request you made and one of our engineers will update the API.

Unauthorized

Response Example

HTTP/1.1 401 Unauthorized

(Empty response body.)