Location

/v1/location

Every organizer may have one ore more locations in which they make a cultural offer.

Resource

interface Location {
  id: string;
  type: "location";
  attributes: {
    status: "draft" | "published";
    createdAt: string;
    updatedAt: string;
  };
  relations: {
    translations: [
      {
        id: number;
        type: "locationtranslation";
        attributes: {
          language: "de" | "en";
          name?: string;
          description?: string;
        };
      }
    ];
    organizer?: Organizer;
    address?: {
      type: "address";
      attributes: {
        street1: string;
        street2?: string;
        city: string;
        zipCode: string;
      };
    };
    links?: [
      {
        id: number;
        type: "link";
        attributes: {
          url: string;
        };
      }
    ];
  };
}

Routes

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

GET /v1/location

Response

{
  "data": [
    {
      "id": "ckqgddbx8000017ofdxwf7tfj",
      "type": "location",
      "attributes": {
        "status": "published",
        "createdAt": "2021-03-24T06:12:37.608+00:00",
        "updatedAt": "2021-05-28T02:54:05.564+00:00"
      },
      "relations": {
        "translations": [
          {
            "id": 1,
            "type": "locationtranslation",
            "attributes": {
              "language": "de",
              "name": "Deutsche Kinemathek - Museum für Film und Fernsehen",
              "description": null
            }
          },
          {
            "id": 2,
            "type": "locationtranslation",
            "attributes": {
              "language": "en",
              "name": "Museum of Film and Television Berlin",
              "description": "Vitae quis sint magnam animi magni sint. Non impedit vero cumque. Voluptas et ipsum dolores placeat molestiae tempore qui ea at. Deserunt nam earum ratione. Consequatur qui unde enim voluptatem nesciunt voluptas ipsam atque ullam. Nostrum amet debitis et quaerat repellat minus."
            }
          }
        ]
      }
    }
  ],
  "links": {
    "self": "http://beta.api.kulturdaten.berlin/v1/location/",
    "first": "http://beta.api.kulturdaten.berlin/v1/location/?page=1",
    "prev": null,
    "next": null,
    "last": "http://beta.api.kulturdaten.berlin/v1/location/?page=1"
  },
  "meta": {
    "pages": {
      "total": 265,
      "perPage": 1000,
      "currentPage": 1,
      "lastPage": 1
    },
    "language": "de"
  }
}

POST /v1/location

Request

{
  "attributes": {
    "name": "New location"
  },
  "relations": {
    "links": ["http://facebook.new-location.com"]
  }
}

Response

{
  "data": {
    "id": "ckq9mgxw70001ev522wasb143",
    "type": "location",
    "attributes": {
      "status": "draft",
      "createdAt": "2021-06-23T17:19:20.000+02:00",
      "updatedAt": "2021-06-23T17:19:20.000+02:00"
    },
    "relations": {
      "translations": [
        {
          "id": 92,
          "type": "locationtranslation",
          "attributes": {
            "language": "en",
            "name": "New Location",
            "description": null
          }
        }
      ]
    }
  },
  "meta": {
    "language": "de"
  }
}