Skip to content
This repository has been archived by the owner on Sep 7, 2023. It is now read-only.

Accessibility

Matthias Rohmer edited this page Jun 15, 2022 · 1 revision

/v1/location/:locationId/accessibility

Locations can have additional accesibility information.

Note: The accessibility endpoint is a key-value store. You can not individually patch a11y fields by id but patch/delete by key using the parent endpoint.

Warning: The keys are not validated by the API. Please see frontend implementation for a list of available keys.

Resource

Features Yes / No
Allows media No
Allows links No
Is taggable No
Is translatable No
interface Accessibility {
  id: number;
  relations: {
    fields: [
      {
        type: "boolean" | "string" | "number" | "object";
        key: string;
        value: string;
      }
    ];
  };
}

Routes

Parameters Values
sort createdAt, updatedAt, name
include *, offer
filter status=published, status=draft

GET /v1/location/:locationId/accessibility

Response

{
  "data": {
    "id": 253,
    "type": "accessibility",
    "relations": {
      "fields": [
        {
          "attributes": {
            "type": "string",
            "key": "door.width",
            "value": "120cm"
          }
        },
        {
          "attributes": {
            "type": "string",
            "key": "door.height",
            "value": "120cm"
          }
        }
      ]
    }
  },
  "meta": {
    "language": "de"
  }
}
Clone this wiki locally