Skip to content

Create special events

Request

Creates a new special event for the museum.

Security
MuseumPlaceholderAuth
Bodyapplication/jsonrequired
namestring(EventName)required

Name of the special event.

Example:"Pirate Coding Workshop"
locationstring(EventLocation)required

Location where the special event is held.

Example:"Computer Room"
eventDescriptionstring(EventDescription)required

Description of the special event.

Example:"Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang)."
datesArray of strings, (date)(EventDates)required

List of planned dates for the special event.

Example:
[ "2023-10-29" ]
pricenumber, (float)(EventPrice)required

Price of a ticket for the special event.

Example:25
curl -i -X POST \
  -u '<username>:<password>' \
  https://redocly.com/_mock/demo/openapi/museum-api/special-events \
  -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
  }'

Responses

Created.

Bodyapplication/json
eventIdstring, (uuid)(EventId)required

Identifier for a special event.

Example:"3be6453c-03eb-4357-ae5a-984a0e574a54"
namestring(EventName)required

Name of the special event.

Example:"Pirate Coding Workshop"
locationstring(EventLocation)required

Location where the special event is held.

Example:"Computer Room"
eventDescriptionstring(EventDescription)required

Description of the special event.

Example:"Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang)."
datesArray of strings, (date)(EventDates)required

List of planned dates for the special event.

Example:
[ "2023-10-29" ]
pricenumber, (float)(EventPrice)required

Price of a ticket for the special event.

Example:25
Response
{ "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 }