KOkontainer
Consent

Get all active consent wards

This endpoint returns all active wards. If the persons associated with the wards need to be included, 'consent_parties' can be added to the relationship parameter.

get/consent/wards

Request

Query parameters

relationshipsstring

Requested relationships (e.g. 'consent_parties')

includesstring

Requested includes (consent_parties)

filterobject

Filtering

Filters can be applied to limit the results that are returned. Filters are applied using the "filter" query parameter. Available filters are:

  • consent_agreements.status (eq) (Pending, Accepted, Declined, Annulled, Revoked, Expired)

Example:

To apply agreement filter where the "consent_agreements.status" equals "Accepted", you could write the filter query as below (Beware you have to add consent_parties to relationship and includes):

{
    "filter": {
        "consent_agreements.status": {
            "eq": "Accepted"
        }
    }
}

{
  "consent_agreements.status": {
    "eq": "Accepted"
  }
}
pagenumber

Requested page number (defaults to 1)

pageSizenumber

Requested page size (defaults to 100)

Response

success

includedobject[]

Included consent_party resources, present only when requested via the includes parameter.

Example response

{
  "data": [
    {
      "type": "consent_ward",
      "id": "22",
      "attributes": {
        "name": "John Doe",
        "birthday": "2025-01-08"
      },
      "relationships": {
        "consent_parties": {
          "data": [
            {
              "type": "consent_party",
              "id": "7"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
    "last": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://example.kontainer.com/jsonapi/v2/dam/folders?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "path": "https://example.kontainer.com/jsonapi/v2/dam/folders",
    "per_page": 500,
    "to": 1,
    "total": 1,
    "sort": "name"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.