Applicant Details

Stability: prototype

Applicant details stores information about the applicant, only some of this information is editable.

Applicant Details Update Applicant Details

Update a batch of Applicant Details, this endpoint is limited to 1000 Applicants per call.

PUT /api/v1/user_identities/:user_identity_id/applicant_details

Required Parameters

Name	Type	Description	Example
applicants:applicant_cas_id	string	Unique identifier of the applicant.	"123456789"

Optional Parameters

Name	Type	Description	Example
applicants:redirect_eligible	boolean	True if the applicant is eligible for redirect.	true

Curl Example

$ curl -n -X PUT https://api.webadmit.org/api/v1/user_identities/:user_identity_id/applicant_details \
  -d '{
  "applicants": [
    {
      "applicant_cas_id": "123456789",
      "redirect_eligible": true
    }
  ]
}' \
  -H "Content-Type: application/json" \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK

{
}

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.)

---