Custom Field Answer (Select)

A custom field answer stores arbitrary data about an applicant, answering the question posed by a custom field.

Attributes

Name	Type	Description	Example
custom_field_answer:custom_field_id	integer	Unique identifier of the custom field that this answers.	4
custom_field_answer:field_type	string	Type of data that the custom field stores. one of:"select"	"select"
custom_field_answer:href	string	Hypertext reference to this resource. pattern: /api/v1/user_identities/\d+/programs/\d+/applicants_by_cas_id/\d+/custom_field_answers/\d+	"/api/v1/user_identities/1/programs/42023191739237/applicants_by_cas_id/3/custom_field_answers/4"
custom_field_answer:label	string	Human-readable label of the custom field that this answers.	"Preferred house"
custom_field_answer:value	nullable string	The select value stored as an answer to the custom field. The value must be one of the valid values configured on the custom field.	"Gryffindor"

Custom Field Answer (Select) Show

Display an existing custom field answer.

GET /api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/custom_field_answers/:custom_field_id

Curl Example

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

Response Example

HTTP/1.1 200 OK

{
  "custom_field_answer": {
    "href": "/api/v1/user_identities/1/programs/42023191739237/applicants_by_cas_id/3/custom_field_answers/4",
    "custom_field_id": 4,
    "label": "Preferred house",
    "field_type": "select",
    "value": "Gryffindor"
  }
}

Custom Field Answer (Select) Store

Store a custom field value. If a value has not previously been stored, this creates an answer. Otherwise, this updates an existing answer.

PUT /api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/custom_field_answers/:custom_field_id

Required Parameters

Name	Type	Description	Example
custom_field_answer:field_type	string	Type of data that the custom field stores. one of:"select"	"select"
custom_field_answer:value	nullable string	The select value to be stored as an answer to the custom field. The value must be one of the valid values configured on the custom field.	"Gryffindor"

Curl Example

$ curl -n -X PUT https://api.webadmit.org/api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/custom_field_answers/:custom_field_id \
  -d '{
  "custom_field_answer": {
    "field_type": "select",
    "value": "Gryffindor"
  }
}' \
  -H "Content-Type: application/json" \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK

{
  "custom_field_answer": {
    "href": "/api/v1/user_identities/1/programs/42023191739237/applicants_by_cas_id/3/custom_field_answers/4",
    "custom_field_id": 4,
    "label": "Preferred house",
    "field_type": "select",
    "value": "Gryffindor"
  }
}

Custom Field Answer (Select) Destroy

Clear an existing custom field answer. (Same semantics as PUT with "value": null.) This is a "soft delete" that tracks who made the change.

DELETE /api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/custom_field_answers/:custom_field_id

Curl Example

$ curl -n -X DELETE https://api.webadmit.org/api/v1/user_identities/:user_identity_id/programs/:program_id/applicants_by_cas_id/:applicant_cas_id/custom_field_answers/:custom_field_id \
  -H "Content-Type: application/json" \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK

{
  "custom_field_answer": {
    "href": "/api/v1/user_identities/1/programs/42023191739237/applicants_by_cas_id/3/custom_field_answers/4",
    "custom_field_id": 4,
    "label": "Preferred house",
    "field_type": "select",
    "value": null
  }
}

Errors

Response Example

HTTP/1.1 422 Unprocessable Entity

{
  "errors": {
    "value": ["\"XYZ\" is not a valid option (expected \"Gryffindor\", \"Hufflepuff\", \"Ravenclaw\", or \"Slytherin\")"]
  }
}

Not Found

Specific error messages

When the user_identity is not found

{
  "message": "User identity '999' not found."
}

When the program is not found

{
  "message": "Program '99999999999' not found."
}

When the applicant is not found

{
  "message": "Applicant '99999999999' not found."
}

When the custom field is not found

{
  "message": "CustomeField '99999999999' 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.)

---