Stability: prototype

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

This is a prototype resource.

A prototype resource is experimental, and major changes are likely. In time, a prototype resource may or may not advance to production.


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

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 \
  -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

Response Example

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

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


Response Example

HTTP/1.1 401 Unauthorized

(Empty response body.)