Export/Report

Stability: production

Retrieve details on all exports (e.g. export templates) that a user has access to within a specific identity. The id returned for each export is the value that needs to be provided in order to run that export.

Attributes

Name Type Description Example
exports/format string Format of the file.
one of:"Comma-Separated Values" or "Microsoft Excel" or "Website HTML" or "Fixed Width Report" or "Comma-Separated Values in Multiple Files"
"Comma-Separated Values"
exports/id integer Unique identifier of this export. 29897
exports/list_type nullable string Type of the list used for this export.
one of:"all" or "clipboard" or "search"
"all"
exports/mime_type string MIME type of the file.
one of:"text/csv;charset=iso-8859-1" or "application/vnd.ms-excel" or "text/html" or "text/plain" or "application/zip"
"text/csv;charset=iso-8859-1"
exports/name string Human-readable name for this export. "Nightly Banner Export"
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/exports
"/api/v1/user_identities/24567/exports"

Export/Report List

The response is the collection of exports belonging to a specific identity in the current user’s WebAdMIT profile, including the List that each export is tied to.

GET /api/v1/user_identities/:user_identity_id/exports

Curl Example

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

Response Example

HTTP/1.1 200 OK
{
  "href": "/api/v1/user_identities/24567/exports",
  "exports": [
    {
      "id": 29897,
      "name": "Nightly Banner Export",
      "list_type": "all",
      "format": "Comma-Separated Values",
      "mime_type": "text/csv;charset=iso-8859-1"
    }
  ]
}

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