Update Student Medical Consents

PUT 
/students/:communityId/medical/consents/:id

Updates a student's relevant medical consent information such as the consent type, whom it is given by, the given date, and the expiry date.

For a list of all consent types, go to Lookup - Consent Type.

Request

Path Parameters

communityId uuidrequired
id uuidrequired

application/json

Body

required

consentType objectrequired

id uuidrequired

Lookup - Consent Type

consentGivenById uuidnullablerequired

The Community ID of the person who gave the consent

isConsentGiven booleannullablerequired
comment stringnullablerequired
consentGivenDate datenullablerequired
consentExpiryDate datenullablerequired

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
id uuidrequired
consentType objectrequired
id uuidrequired
Lookup - Consent Type
description stringrequired
code stringrequired
consentGivenById stringnullablerequired
consentGivenByName stringnullablerequired
isConsentGiven booleanrequired
comment stringnullablerequired
consentGivenDate datenullablerequired
consentExpiryDate datenullablerequired
modifiedDate date-timenullablerequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "consentType": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "code": "string"
    },
    "consentGivenById": "string",
    "consentGivenByName": "string",
    "isConsentGiven": true,
    "comment": "string",
    "consentGivenDate": "2025-03-12",
    "consentExpiryDate": "2025-03-12",
    "modifiedDate": "2025-03-12T03:31:59.411Z"
  }
}

Successful

{
  "code": "OK",
  "data": [
    {
      "id": "fe0e86d1-8a75-4805-8900-ac0a5eb8d552",
      "consentType": {
        "id": "01baec2e-8204-4aad-b798-d803eedc1a3b",
        "description": "Anti inflammatory consent",
        "code": "ANTIINFLAMMATORY"
      },
      "consentGivenDate": "2024-05-31",
      "consentExpiryDate": "2025-05-31",
      "modifiedDate": "2024-05-31T00:00:00Z",
      "consentGivenByName": "ADDISONER, Mr Connor Garrick",
      "consentGivenById": "24bfe081-0364-4560-a627-0d752e176143",
      "isConsentGiven": true,
      "comment": "Parent gives consent"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...