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

Organizer

Matthias Rohmer edited this page Sep 30, 2021 · 8 revisions

/v1/organizer

This is the root entity of kulturdaten.berlin. All other entities (location, offer, as well as Users) belong to one or more organizers.

Resource

Features Yes / No
Allows media Yes
Allows links Yes
Is taggable Yes
Is translatable Yes
interface Organizer {
  id: string;
  type: "organizer";
  attributes: {
    status: "draft" | "published";
    createdAt: string;
    updatedAt: string;
    homepage?: string;
    email?: string;
    phone?: string;
  };
  relations: {
    translations?: [
      {
        id: number;
        type: "organizertranslation";
        attributes: {
          language: "de" | "en";
          name?: string;
          description?: string;
        };
      }
    ];
    address?: Address;
    types?: [
      {
        id: number;
        type: "organizertype";
        relations: {
          translations: [
            {
              id: number;
              type: "organizertypetranslation";
              attributes: {
                language: "de" | "en";
                name?: string;
                description?: string;
              };
            }
          ];
        };
      }
    ];
    subjects?: [
      {
        id: number;
        type: "organizersubject";
        relations: {
          translations: [
            {
              id: number;
              type: "organizersubjecttranslation";
              attributes: {
                language: "de" | "en";
                name: string;
                description: string;
              };
            }
          ];
        };
      }
    ];
    links?: Link[];
    media?: Media[];
    tags?: Tag[];
  };
}

Routes

Parameters Values
sort createdAt, updatedAt, name
include *, address, types, subjects, links, media
filter status=published, status=draft, type=<number>, subject=<number>

GET /v1/organizer

Response

{
  "data": [
    {
      "id": "ckqgddbx8000017ofdxwf7tfj",
      "type": "organizer",
      "attributes": {
        "status": "published",
        "createdAt": "2021-03-24T06:12:37.608+00:00",
        "updatedAt": "2021-05-28T02:54:05.564+00:00",
        "homepage": null,
        "email": null,
        "phone": null
      },
      "relations": {
        "translations": [
          {
            "id": 1,
            "type": "organizertranslation",
            "attributes": {
              "language": "de",
              "name": "Deutsche Kinemathek - Museum für Film und Fernsehen",
              "description": null
            }
          },
          {
            "id": 2,
            "type": "organizertranslation",
            "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/organizer/",
    "first": "http://beta.api.kulturdaten.berlin/v1/organizer/?page=1",
    "prev": null,
    "next": null,
    "last": "http://beta.api.kulturdaten.berlin/v1/organizer/?page=1"
  },
  "meta": {
    "pages": {
      "total": 265,
      "perPage": 1000,
      "currentPage": 1,
      "lastPage": 1
    },
    "language": "de"
  }
}

POST /v1/organizer

Request

{
  "attributes": {
    "name": "New Organizer",
    "homepage": "http://new-organizer.com",
    "email": "info@new-organizer.com",
    "phone": "+4915731234567"
  },
  "relations": {
    "links": ["http://facebook.new-organizer.com"]
  }
}

Response

{
  "data": {
    "id": "ckq9mgxw70001ev522wasb143",
    "type": "organizer",
    "attributes": {
      "status": "draft",
      "createdAt": "2021-06-23T17:19:20.000+02:00",
      "updatedAt": "2021-06-23T17:19:20.000+02:00",
      "homepage": "http://new-organizer.com",
      "email": "info@new-organizer.com",
      "phone": "+4915731234567"
    },
    "relations": {
      "translations": [
        {
          "id": 92,
          "type": "organizertranslation",
          "attributes": {
            "language": "de",
            "name": "New Organizer",
            "description": null
          }
        }
      ]
    }
  },
  "meta": {
    "language": "de"
  }
}
Clone this wiki locally