Update a Participant Record Type

put/public/v1/participant-record-types/{participantRecordType}

Only the fields you send are changed. visible_to_support_workers cannot be set to false while any of its records need support worker acknowledgement. Sending a required_for_* list replaces the whole list; send an empty list to clear it.

put/public/v1/participant-record-types/{participantRecordType}

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/participant-record-types/{participantRecordType}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "expires": true,
  "required": true,
  "requires_documents": true,
  "visible_to_support_workers": true,
  "required_for_participant_tags": [
    {
      "id": "string"
    }
  ],
  "required_for_charge_item_sets": [
    {
      "id": "string"
    }
  ],
  "required_for_charge_items": [
    {
      "id": "string"
    }
  ],
  "template_name": "consent_form"
}'

Response

{
  "data": {
    "id": "rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c",
    "name": "Police Check",
    "expires": true,
    "required": true,
    "requires_documents": true,
    "visible_to_support_workers": true,
    "template_name": "service_agreement",
    "created_at": "2024-01-15T10:30:00+00:00",
    "required_for_participant_tags": [
      {
        "id": "p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
        "name": "High Priority",
        "colour": "#FF0000"
      }
    ],
    "required_for_charge_item_sets": [
      {
        "id": "a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c",
        "reference": "SC-SET-01",
        "name": "Standard Support Coordination Set"
      }
    ],
    "required_for_charge_items": [
      {
        "id": "c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c",
        "name": "Assistance With Self-Care Activities",
        "number": "01_011_0107_1_1"
      }
    ]
  }
}

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

participantRecordTypestringrequired
The participant record type UUID

Body

application/json

namestringmax length 255
expiresboolean
requiredboolean
requires_documentsboolean
visible_to_support_workersboolean
required_for_participant_tagsobject[]max items 5000
▶Show 1 child attributesHide child attributes
- idstringrequired
required_for_charge_item_setsobject[]max items 5000
▶Show 1 child attributesHide child attributes
- idstringrequired
required_for_charge_itemsobject[]max items 5000
▶Show 1 child attributesHide child attributes
- idstringrequired
template_nameenum<string> | null
Available options:consent_formemergency_and_disaster_management_planparticipant_handbookservice_agreementsupport_plan

Response

200application/json

ParticipantRecordTypeResource

dataobjectrequired
▶Show 11 child attributesHide child attributes
- idstringrequired
  Example:rt1a2b3c-d4e5-6f7a-8b9c-0d1e2f3a4b5c
- namestringrequired
  Example:Police Check
- expiresbooleanrequired
  Example:true
- requiredbooleanrequired
  Example:true
- requires_documentsbooleanrequired
  Example:true
- visible_to_support_workersbooleanrequired
  Example:true
- template_nameenum<string> | nullrequired
  Available options:consent_formemergency_and_disaster_management_planparticipant_handbookservice_agreementsupport_plan
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- required_for_participant_tagsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:p1t2a3g4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:High Priority
  colourstring | nullrequired
  Example:#FF0000
- required_for_charge_item_setsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  referencestringrequired
  Example:SC-SET-01
  namestringrequired
  Example:Standard Support Coordination Set
- required_for_charge_itemsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c
  namestringrequired
  Example:Assistance With Self-Care Activities
  numberstringrequired
  Example:01_011_0107_1_1

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error