Offer

/v1/offer

Organizer can create offers in any of their locations.

Resource

Features	Yes / No
Allows media	Yes
Allows links	Yes
Is taggable	Yes
Is translatable	Yes

interface Offer {
  id: string;
  type: "offer";
  attributes: {
    status: "draft" | "published";
    hasFee: boolean | null;
    isPermanent: boolean | null;
    needsRegistration: boolean | null;
    ticketUrl?: string | null;
    registrationUrl?: string | null;
    createdAt: string;
    updatedAt: string;
  };
  relations: {
    translations: [
      {
        id: number;
        type: "offertranslation";
        attributes: {
          language: "de" | "en";
          name?: string;
          description?: string;
          roomDescription?: string;
        };
      }
    ];
    organizer?: Organizer;
    location?: Location;
    dates?: OfferDate[];
    links?: Link[];
    media?: Media[];
    tags?: Tag[];
  };
  meta?: {
    recurrenceRule: string;
    startsAt: string;
    endsAt: string;
  };
}

Routes

Parameters	Values
sort	createdAt, updatedAt, name
include	*, dates, media, links, location, tags
filter	status=published, status=draft

GET /v1/offer

Response

{
  "data": [
    {
      "id": "cku6t5bel00dh19k23e3t50ki",
      "type": "offer",
      "attributes": {
        "status": "published",
        "hasFee": true,
        "needsRegistration": true,
        "isPermanent": true,
        "ticketUrl": "https://marah.ch",
        "createdAt": "2021-06-02T13:38:02.814+00:00",
        "updatedAt": "2021-09-30T10:41:46.004+00:00"
      },
      "relations": {
        "translations": [
          {
            "id": 1,
            "type": "offertranslation",
            "attributes": {
              "language": "de",
              "name": "Die Aufgeregten von Goethe",
              "description": "Consequatur eos voluptatem iure assumenda praesentium commodi vero velit quaerat. Culpa neque assumenda ratione porro necessitatibus in. Laboriosam perferendis consequatur velit at ad quo incidunt quisquam nemo. Consequatur ut tempora adipisci nostrum. Unde incidunt et molestias velit.",
              "roomDescription": null
            }
          }
        ],
        "dates": [
          {
            "id": 1,
            "type": "offerdate",
            "attributes": {
              "status": "scheduled",
              "startsAt": "2021-10-04T21:15:44.310+00:00",
              "endsAt": "2021-10-04T23:15:44.310+00:00",
              "hasFee": true,
              "needsRegistration": true,
              "ticketUrl": "https://tizian.info"
            },
            "relations": {
              "translations": [
                {
                  "id": 1,
                  "type": "offerdatetranslation",
                  "attributes": {
                    "language": "de",
                    "name": "Premiere: Die Aufgeregten von Goethe",
                    "description": "Et perspiciatis vel atque. Magnam est quam est. Nihil vitae non ducimus voluptas excepturi aut voluptatibus et. Quam expedita ad. Dolorem laborum assumenda et. Vel ex fugiat est consequatur voluptatem.",
                    "roomDescription": "Excepturi rem voluptas aperiam. Et pariatur expedita. Quos debitis tenetur enim suscipit delectus. Eligendi officia alias. Quo et accusamus nulla deserunt. Fuga rem quo nobis eum ullam velit assumenda voluptates temporibus."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "links": {
    "self": "http://beta.api.kulturdaten.berlin/v1/offer",
    "first": "http://beta.api.kulturdaten.berlin/v1/offer?page=1",
    "prev": null,
    "next": null,
    "last": "http://beta.api.kulturdaten.berlin/v1/offer?page=1"
  },
  "meta": {
    "pages": {
      "total": 105,
      "perPage": 1000,
      "currentPage": 1,
      "lastPage": 1
    },
    "language": "de"
  }
}