Documents (Facility Level)
Retrieve Documents

Discussion

A document is a pdf file related to an event.

The /documents/:session_document_id/session/:sessions_id endpoint is used in conjunction with the /move_ins/review_cost endpoint.
review_cost will return a session_id and a list of Event Documents, each with their own session_document_id.
The "session" associated with these two IDs will expire 24 hours after they have been initialized by the review_cost endpoint.
This session_document_id is NOT the same ID as the document_id used with the /documents/:id endpoint, and any attempt to use it as such will result in a 404.

>>>

GET /v1/:facility_id/documents/:id
Returns a pdf of the specified document

Examples

GET /v1/b6ff4064-5c56-4101-a6c8-0c34d9f6fc10/documents/fb3a130b-6f71-4c0e-b6cc-6b533cdfe1dd
200
>>>

GET /v1/:facility_id/documents/:session_document_id/session/:session_id
Returns a pdf of the specifed document for a move in

Params

Param name Description
session_id
required

Validations:

  • Must be a String
session_document_id
required

Validations:

  • Must be a String

Examples

GET /v1/d80c660f-a9e8-4951-8d3f-4d108149c0c8/documents/4fbd8eff628047250a2f11212546b41d/session/30cad8891837a108c2a64f5b2bd90e8d
200
>>>

GET /v1/:facility_id/events/:event_id/documents
Returns a list of documents and their IDs

The event_id can be a move_in_unit_event, move_out_unit_event, or successful_payment_event id.

Examples

GET /v1/6cec37f2-44c4-461d-a567-7f0d5bff4283/events/07f76197-04d5-45a5-bf43-374caa3895f1/documents
200
{
  "documents": [
    {
      "id": "63893f4b-8de5-4bcd-81fb-52b0e02ae105",
      "description": "Print Doc 2",
      "type": "PrintTemplate",
      "is_relevant": true,
      "created_at": "2023-09-15T04:37:54.105-10:00"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 1,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "6cec37f2-44c4-461d-a567-7f0d5bff4283",
      "event_id": "07f76197-04d5-45a5-bf43-374caa3895f1",
      "document": {}
    }
  }
}
>>>

POST /v1/:facility_id/documents/:event_id/send_esignable_documents
Send esignable documents for a given event via email or sms to a specifed email address or phone number

Discussion

Given a facility_id and event_id, this endpoint will attempt to deliver any of the event's esignable documents to the specified email address or phone number (via sms).
If there are no esignable documents related to the specified event, a 400 status code will be returned along with an error message.
You should never specify both email and sms_number. If both parameters are provided, an error will be returned.

Params

Param name Description
email
optional

Required to send esignable documents via email

Validations:

  • Must be a String
sms_number
optional

Required to send esignable documents via sms

Validations:

  • Must be a String

Examples

POST /v1/b313fc0b-1073-4650-8815-ef015c41b553/documents/0f3879e5-2d55-40aa-8108-3a01e2a4d3d8/send_esignable_documents
{
  "email": "[email protected]",
  "document": {
    "email": "[email protected]"
  }
}
200
{
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "email": "[email protected]",
      "facility_id": "b313fc0b-1073-4650-8815-ef015c41b553",
      "event_id": "0f3879e5-2d55-40aa-8108-3a01e2a4d3d8",
      "document": {
        "email": "[email protected]"
      }
    }
  }
}