Create a Generated Document for a Participant

post/public/v1/participants/{participant}/generated-documents

Pass either template.id, to generate the document from one of the provider's participant document templates, or content, to write the document's rich text (HTML) directly. Sending both, or neither, is rejected. A document generated from a Word template is finalised straight away; any other document is created as a draft.

post/public/v1/participants/{participant}/generated-documents

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/generated-documents' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "template": {
    "id": "string"
  },
  "content": "string"
}'

Response

{
  "data": {
    "id": "g1e2n3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "name": "Support Plan - Jane Citizen",
    "status": "draft",
    "type": "rich_text",
    "template_name": "Support Plan",
    "content": "<p>Jane's goals for the next 12 months.</p>",
    "finalised_at": "2024-01-16T09:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_at": "2024-01-15T11:05:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

participantstringrequired
The participant UUID

Body

application/json

namestringrequiredmax length 255
templateobject
▶Show 1 child attributesHide child attributes
- idstring
contentstringmax length 16777215
Limited to 16777215 bytes.

Response

201application/json

GeneratedDocumentResource

dataobjectrequired
▶Show 9 child attributesHide child attributes
- idstringrequired
  Example:g1e2n3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Support Plan - Jane Citizen
- statusenum<string>required
  Available options:draftfinalised
- typeenum<string>required
  Available options:rich_textword
- template_namestring | nullrequired
  Example:Support Plan
- contentstring | nullrequired
  Example:<p>Jane's goals for the next 12 months.</p>
- finalised_atstring | nullrequired
  Example:2024-01-16T09:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstringrequired
  Example:2024-01-15T11:05:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error