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

Service

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

/v1/location/:locationId/service

Locations can have additional service information.

Note: The service 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 Service {
  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/service

Response

{
  "data": {
    "id": 253,
    "type": "service",
    "relations": {
      "fields": [
        {
          "id": 1,
          "type": "servicefield",
          "attributes": {
            "type": "string",
            "key": "services.parking",
            "value": "[onSite,accessibleParking,bicycleParking]"
          }
        },
        {
          "id": 2,
          "type": "servicefield",
          "attributes": {
            "type": "string",
            "key": "services.publicTransport",
            "value": "U Bayerischer Platz"
          }
        },
        {
          "id": 3,
          "type": "servicefield",
          "attributes": {
            "type": "string",
            "key": "services.publicTransport.bus",
            "value": "100"
          }
        },
        {
          "id": 4,
          "type": "servicefield",
          "attributes": {
            "type": "string",
            "key": "services.publicTransport.tram",
            "value": "M2"
          }
        },
        {
          "id": 5,
          "type": "servicefield",
          "attributes": {
            "type": "string",
            "key": "services.publicTransport.sbahn",
            "value": "S3, S5"
          }
        },
        {
          "id": 6,
          "type": "servicefield",
          "attributes": {
            "type": "string",
            "key": "services.publicTransport.ubahn",
            "value": "U7"
          }
        }
      ]
    }
  },
  "meta": {
    "language": "de"
  }
}
Clone this wiki locally