Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

Redocly Museum API (1.0.0)

An imaginary, but delightful Museum API for interacting with museum services and information. Built with love by Redocly.

Download OpenAPI description
Languages
Servers
Mock server
https://redocly.com/_mock/docs/openapi/museum-api/
https://api.fake-museum-example.com/v1/

Operations

Operational information about the museum.

Operations

Events

Special events hosted by the Museum

Operations

Create special events

Request

Creates a new special event for the museum.

Bodyapplication/jsonrequired
namestring(EventName)required

Name of the special event

locationstring(EventLocation)required

Location where the special event is held

eventDescriptionstring(EventDescription)required

Description of the special event

datesArray of strings(date)(EventDates)required

List of planned dates for the special event

Example:

["2023-10-29T00:00:00.000Z"]

pricenumber(float)(EventPrice)required

Price of a ticket for the special event

curl -i -X POST \
  -u undefined:undefined \
  https://redocly.com/_mock/docs/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-05T00:00:00.000Z",
      "2023-09-08T00:00:00.000Z"
    ],
    "price": 0
  }'
Experience it firsthand in the API Explorer!

Responses

Success

Bodyapplication/json
eventIdstring(uuid)(EventId)required

Identifier for a special event.

namestring(EventName)required

Name of the special event

locationstring(EventLocation)required

Location where the special event is held

eventDescriptionstring(EventDescription)required

Description of the special event

datesArray of strings(date)(EventDates)required

List of planned dates for the special event

Example:

["2023-10-29T00:00:00.000Z"]

pricenumber(float)(EventPrice)required

Price of a ticket for the special event

Response
application/json
{ "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-05T00:00:00.000Z", "2023-09-08T00:00:00.000Z" ], "price": 30 }

List special events

Request

Return a list of upcoming special events at the museum.

Query
startDatestring(date)

The starting date to retrieve future operating hours from. Defaults to today's date.

Example:

startDate=2023-02-23T00:00:00.000Z

endDatestring(date)

The end of a date range to retrieve special events for. Defaults to 7 days after startDate.

Example:

endDate=2023-04-18T00:00:00.000Z

pageinteger

The page number to retrieve.

Default 1
Example:

page=2

limitinteger<= 30

The number of days per page.

Default 10
Example:

limit=15

curl -i -X GET \
  -u undefined:undefined \
  'https://redocly.com/_mock/docs/openapi/museum-api/special-events?endDate=2023-04-18T00%3A00%3A00.000Z&limit=15&page=2&startDate=2023-02-23T00%3A00%3A00.000Z'
Experience it firsthand in the API Explorer!

Responses

Success

Bodyapplication/jsonArray [
eventIdstring(uuid)(EventId)required

Identifier for a special event.

namestring(EventName)required

Name of the special event

locationstring(EventLocation)required

Location where the special event is held

eventDescriptionstring(EventDescription)required

Description of the special event

datesArray of strings(date)(EventDates)required

List of planned dates for the special event

Example:

["2023-10-29T00:00:00.000Z"]

pricenumber(float)(EventPrice)required

Price of a ticket for the special event

]
Response
application/json
[ { "eventId": "f3e0e76e-e4a8-466e-ab9c-ae36c15b8e97", "name": "Sasquatch Ballet", "location": "Seattle... probably", "eventDescription": "They're big, they're hairy, but they're also graceful. Come learn how the biggest feet can have the lightest touch.", "dates": [], "price": 40 }, { "eventId": "2f14374a-9c65-4ee5-94b7-fba66d893483", "name": "Solar Telescope Demonstration", "location": "Far from the sun.", "eventDescription": "Look at the sun without going blind!", "dates": [], "price": 50 }, { "eventId": "6aaa61ba-b2aa-4868-b803-603dbbf7bfdb", "name": "Cook like a Caveman", "location": "Fire Pit on East side", "eventDescription": "Learn to cook on an open flame.", "dates": [], "price": 5 }, { "eventId": "602b75e1-5696-4ab8-8c7a-f9e13580f910", "name": "Underwater Basket Weaving", "location": "Rec Center Pool next door.", "eventDescription": "Learn to weave baskets underwater.", "dates": [], "price": 15 }, { "eventId": "dad4bce8-f5cb-4078-a211-995864315e39", "name": "Mermaid Treasure Identification and Analysis", "location": "Room Sea-12", "eventDescription": "Join us as we review and classify a rare collection of 20 thingamabobs, gadgets, gizmos, whoosits, and whatsits — kindly donated by Ariel.", "dates": [], "price": 30 }, { "eventId": "6744a0da-4121-49cd-8479-f8cc20526495", "name": "Time Traveler Tea Party", "location": "Temporal Tearoom", "eventDescription": "Sip tea with important historical figures.", "dates": [], "price": 60 }, { "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54", "name": "Pirate Coding Workshop", "location": "Computer Room", "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).", "dates": [], "price": 45 }, { "eventId": "9d90d29a-2af5-4206-97d9-9ea9ceadcb78", "name": "Llama Street Art Through the Ages", "location": "Auditorium", "eventDescription": "Llama street art?! Alpaca my bags -- let's go!", "dates": [], "price": 45 }, { "eventId": "a3c7b2c4-b5fb-4ef7-9322-00a919864957", "name": "The Great Parrot Debate", "location": "Outdoor Amphitheatre", "eventDescription": "See leading parrot minds discuss important geopolitical issues.", "dates": [], "price": 35 }, { "eventId": "b92d46b7-4c5d-422b-87a5-287767e26f29", "name": "Eat a Bunch of Corn", "location": "Cafeteria", "eventDescription": "We accidentally bought too much corn. Please come eat it.", "dates": [], "price": 5 } ]

Get special event

Request

Get details about a special event.

Path
eventIdstring(uuid)required

An identifier for a special event.

Example:

dad4bce8-f5cb-4078-a211-995864315e39

curl -i -X GET \
  -u undefined:undefined \
  'https://redocly.com/_mock/docs/openapi/museum-api/special-events/{eventId}'
Experience it firsthand in the API Explorer!

Responses

Success

Bodyapplication/json
eventIdstring(uuid)(EventId)required

Identifier for a special event.

namestring(EventName)required

Name of the special event

locationstring(EventLocation)required

Location where the special event is held

eventDescriptionstring(EventDescription)required

Description of the special event

datesArray of strings(date)(EventDates)required

List of planned dates for the special event

Example:

["2023-10-29T00:00:00.000Z"]

pricenumber(float)(EventPrice)required

Price of a ticket for the special event

Response
application/json
{ "eventId": "6744a0da-4121-49cd-8479-f8cc20526495", "name": "Time Traveler Tea Party", "location": "Temporal Tearoom", "eventDescription": "Sip tea with important historical figures.", "dates": [ "2023-11-18T00:00:00.000Z", "2023-11-25T00:00:00.000Z", "2023-12-02T00:00:00.000Z" ], "price": 60 }

Update special event

Request

Update the details of a special event

Path
eventIdstring(uuid)required

An identifier for a special event.

Example:

dad4bce8-f5cb-4078-a211-995864315e39

Bodyapplication/jsonrequired
namestring(EventName)

Name of the special event

locationstring(EventLocation)

Location where the special event is held

eventDescriptionstring(EventDescription)

Description of the special event

datesArray of strings(date)(EventDates)

List of planned dates for the special event

Example:

["2023-10-29T00:00:00.000Z"]

pricenumber(float)(EventPrice)

Price of a ticket for the special event

curl -i -X PATCH \
  -u undefined:undefined \
  'https://redocly.com/_mock/docs/openapi/museum-api/special-events/{eventId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "location": "On the beach.",
    "price": 15
  }'
Experience it firsthand in the API Explorer!

Responses

Success

Bodyapplication/json
eventIdstring(uuid)(EventId)required

Identifier for a special event.

namestring(EventName)required

Name of the special event

locationstring(EventLocation)required

Location where the special event is held

eventDescriptionstring(EventDescription)required

Description of the special event

datesArray of strings(date)(EventDates)required

List of planned dates for the special event

Example:

["2023-10-29T00:00:00.000Z"]

pricenumber(float)(EventPrice)required

Price of a ticket for the special event

Response
application/json
{ "eventId": "dad4bce8-f5cb-4078-a211-995864315e39", "name": "Mermaid Treasure Identification and Analysis", "location": "On the beach.", "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-05T00:00:00.000Z", "2023-09-08T00:00:00.000Z" ], "price": 15 }

Delete special event

Request

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

Path
eventIdstring(uuid)required

An identifier for a special event.

Example:

dad4bce8-f5cb-4078-a211-995864315e39

curl -i -X DELETE \
  -u undefined:undefined \
  'https://redocly.com/_mock/docs/openapi/museum-api/special-events/{eventId}'
Experience it firsthand in the API Explorer!

Responses

Success - no content

Tickets

Museum tickets for general entrance or special events.

Operations