Decision

Stability: prototype

An association has a set of valid decisions for an applicant.

Attributes

Name Type Description Example
decisions/id integer Unique identifier of this decision. NOTE: This identifier changes between cycles. 42
decisions/name string Human-readable name for this decision. "Offer Accepted"
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/decisions
"/api/v1/user_identities/1/decisions"

Decision List

List valid decisions for the association that this user identity belongs to.

GET /api/v1/user_identities/:user_identity_id/decisions

Curl Example

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

Response Example

HTTP/1.1 200 OK
{
  "href": "/api/v1/user_identities/1/decisions",
  "decisions": [
    {
      "id": 42,
      "name": "Offer Accepted"
    }
  ]
}

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