Events

Create special events

Creates a new special event for the museum.

Authorization

AuthorizationRequiredBasic <token>

In: header

Request Body

application/jsonRequired

eventIdstring

Identifier for a special event.

Format: "uuid"

nameRequiredstring

Name of the special event.

locationRequiredstring

Location where the special event is held.

eventDescriptionRequiredstring

Description of the special event.

datesRequiredarray<string>

List of planned dates for the special event.

priceRequirednumber

Price of a ticket for the special event.

Format: "float"

Response Body

Created.

eventIdstring

Identifier for a special event.

Format: "uuid"

nameRequiredstring

Name of the special event.

locationRequiredstring

Location where the special event is held.

eventDescriptionRequiredstring

Description of the special event.

datesRequiredarray<string>

List of planned dates for the special event.

priceRequirednumber

Price of a ticket for the special event.

Format: "float"

/**
 * List of planned dates for the special event.
 */
export type EventDates = string[];
 
export interface Response {
  /**
   * Identifier for a special event.
   */
  eventId?: string;
  /**
   * Name of the special event.
   */
  name: string;
  /**
   * Location where the special event is held.
   */
  location: string;
  /**
   * Description of the special event.
   */
  eventDescription: string;
  dates: EventDates;
  /**
   * Price of a ticket for the special event.
   */
  price: number;
}

curl -X POST "https://redocly.com/_mock/docs/openapi/museum-api/special-events" \
  -H "Authorization: Basic <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mermaid Treasure Identification and Analysis",
    "location": "Under the seaaa 🦀 🎶 🌊.",
    "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
    "dates": [
      "2023-09-05",
      "2023-09-08"
    ],
    "price": 0
  }'

{
  "eventId": "dad4bce8-f5cb-4078-a211-995864315e39",
  "name": "Mermaid Treasure Identification and Analysis",
  "location": "Under the seaaa 🦀 🎶 🌊.",
  "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits, kindly donated by Ariel.",
  "dates": [
    "2023-09-05",
    "2023-09-08"
  ],
  "price": 30
}

How is this guide?

List of Achievements GET

Retrieves the list of game achievements the user has earned.

Delete special event DELETE

Delete a special event from the collection. Allows museum to cancel planned events.