Export/Report Files (check status in batch)

Stability: production

Closely mimics the "Recent Files" screen in the WebAdMIT application. This call will display all export files that have recently run under a particular identity, and their status. Importantly, the download URL is not displayed in this response as these individual expiring URLs can only be generated by calling for the status of an individual file directly using the previous call. You can use the results of this call and loop through each one to get a download URL for each export file marked as "Available".

Attributes

Name Type Description Example
export_files/export_id integer Unique identifier of the associated export. 86446
export_files/href string Hypertext reference to this resource.
pattern: /api/v1/exports/\d+/export_files/\d+
"/api/v1/exports/86466/export_files/74780"
export_files/id integer Unique identifier of this export file. 74780
export_files/status string Current status of this export file.
one of:"initializing" or "queued" or "in_progress" or "available" or "success_with_errors" or "empty_list" or "failed"
"available"
href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/export_files
"/api/v1/user_identities/37442/export_files"

Export/Report Files (check status in batch) List

The response is the collection of ids and statuses of the running exports for a specific identity within a user’s WebAdMIT profile.

GET /api/v1/user_identities/:user_identity_id/export_files

Curl Example

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

Response Example

HTTP/1.1 200 OK
{
  "href": "/api/v1/user_identities/37442/export_files",
  "export_files": [
    {
      "id": 74780,
      "href": "/api/v1/exports/86466/export_files/74780",
      "export_id": 86446,
      "status": "available"
    }
  ]
}

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