POST/transactional-api/create-document-form-template

Create Document Form Template

Creates a new document form template.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/create-document-form-template' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "name": "string",
    "description": "string",
    "type": "referral-form"
  }'

Body parameters

Field	Type	Required	Description
name	string	Yes	Template name.
description	string	Yes	Template description.
type	enum	Yes	Document form type. One of: referral-form, letter, general-document.

Responses

201 Created.

{
  "id": "00000000-0000-0000-0000-000000000000"
}

400 Invalid request.

3 possible code values

Code	Description	When
missing-required-field	fieldName is required	a required field is absent
invalid-operation	Human-readable reason.	business rule violation
invalid-field	fieldName must be a valid UUID	a UUID field is not a valid UUID

{
  "errors": [
    {
      "code": "missing-required-field",
      "description": "fieldName is required"
    }
  ]
}