Set an Information Item value for a Participant

put/public/v1/participants/{participant}/information-items

Creates or updates the participant's value for the given participant_information_item.id, attaching any documents referenced by the id returned from the temporary upload endpoint.

put/public/v1/participants/{participant}/information-items

curl --request PUT \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/information-items' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "participant_information_item": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
  },
  "detail": "string",
  "documents": [
    {
      "file": "string",
      "name": "string",
      "categories": [
        {
          "id": "string"
        }
      ]
    }
  ]
}'

Response

{
  "data": {
    "id": "i1n2f3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "detail": "Medication details for participant",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_at": "2024-06-02T09:15:00+00:00",
    "info_item": {
      "id": "i1t2e3m4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "name": "Emergency Contact",
      "required": true,
      "documents_allowed": true,
      "visible_to_support_workers": false
    },
    "documents": [
      {
        "id": "d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "name": "Service Agreement",
        "file_extension": "pdf",
        "created_at": "2024-01-15T10:30:00+00:00",
        "categories": [
          {
            "id": "c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9",
            "name": "Assessments"
          }
        ]
      }
    ]
  }
}

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

participant_information_itemobjectrequired
▶Show 1 child attributesHide child attributes
- idstring<uuid>required
detailstring | nullmax length 65535
Limited to 65535 bytes.
documentsobject[]max items 20
▶Show 3 child attributesHide child attributes
- filestringrequired
- namestring | nullmax length 255
- categoriesobject[] | nullmax items 100
  ▶Show 1 child attributesHide child attributes
  idstringrequired

Response

200application/json

ParticipantInformationItemResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:i1n2f3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- detailstring | nullrequired
  Example:Medication details for participant
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstring | nullrequired
  Example:2024-06-02T09:15:00+00:00
- info_itemobject | nullrequired
  ▶Show 5 child attributesHide child attributes
  idstringrequired
  Example:i1t2e3m4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Emergency Contact
  requiredbooleanrequired
  Example:true
  documents_allowedbooleanrequired
  Example:true
  visible_to_support_workersbooleanrequired
  Example:false
- documentsobject[] | string[]required
  ▶Show 5 child attributesHide child attributes
  idstringrequired
  Example:d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Service Agreement
  file_extensionstringrequired
  Example:pdf
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
  categoriesobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9
  namestringrequired
  Example:Assessments

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors