PDF Manager Template

Stability: production

A PDF Manager template contains the configuration that determines the contents of a PDF Manager batch. It is configured in the user interface and only readable in the API.

Attributes

Name Type Description Example
pdf_manager_template:document_source_title string Human-readable name of the document source that is used when populating this template. "Full Application PDF"
pdf_manager_template:href string Hypertext reference to this resource.
pattern: /api/v1/user_identities/\d+/pdf_manager_templates/\d+
"/api/v1/user_identities/1/pdf_manager_templates/2"
pdf_manager_template:id integer Unique identifier of this PDF Manager template. 2
pdf_manager_template:list_name string Human-readable name of the list that is used when populating this template. "Offer Accepted"
pdf_manager_template:name string Human-readable name of this PDF Manager template. "Accepted Offers for Review"

PDF Manager Template List

List existing PDF Manager templates.

GET /api/v1/user_identities/:user_identity_id/pdf_manager_templates

Curl Example

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

Response Example

HTTP/1.1 200 OK
{
  "href": "/api/v1/user_identities/1/pdf_manager_templates",
  "pdf_manager_templates": [
    {
      "href": "/api/v1/user_identities/1/pdf_manager_templates/2",
      "id": 2,
      "name": "Accepted Offers for Review",
      "list_name": "Offer Accepted",
      "document_source_title": "Full Application PDF"
    }
  ]
}

PDF Manager Template Show

Display an existing PDF Manager template.

GET /api/v1/user_identities/:user_identity_id/pdf_manager_templates/:pdf_manager_template_id

Curl Example

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

Response Example

HTTP/1.1 200 OK
{
  "pdf_manager_template": {
    "href": "/api/v1/user_identities/1/pdf_manager_templates/2",
    "id": 2,
    "name": "Accepted Offers for Review",
    "list_name": "Offer Accepted",
    "document_source_title": "Full Application PDF"
  }
}

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