Stability: production

An applicant applies to a program at an organization.


Name Type Description Example
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/organizations
organizations/association_name nullable string Human-readable name of the association that this organization belongs to, or null if not applicable. "SOPHAS"
organizations/cas3 boolean Whether or not this organization is using CAS3 (as opposed to the older CAS2, for example). true
organizations/config_portal_identifier string Organization identifier that is specific to Config Portal. May not be unique if cas3 is false. "2235"
organizations/cycle_name nullable string Academic cycle of this organization, or null if not applicable.
pattern: ^\d{4} - \d{4}$
"2014 - 2015"
organizations/id integer Unique identifier of this organization. 42023191739237
organizations/name string Human-readable name of this organization. "Demo University School of Public Health"

Organization List

List existing organizations for this user identity.

GET /api/v1/user_identities/:user_identity_id/organizations

Curl Example

$ curl -n \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK
  "href": "/api/v1/user_identities/1/organizations",
  "organizations": [
      "id": 42023191739237,
      "name": "Demo University School of Public Health",
      "cycle_name": "2014 - 2015",
      "association_name": "SOPHAS",
      "cas3": true,
      "config_portal_identifier": "2235"

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.


Response Example

HTTP/1.1 401 Unauthorized

(Empty response body.)