v1.2.1

Redocly Museum API

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

Contact

Contact/team@redocly.com

Terms of Service

https://redocly.com/subscription-agreement/

License

MIT

Servers

https://redocly.com/_mock/docs/openapi/museum-api

---

Operations

Operational information about the museum.

Operations

GET/museum-hours

---

Get museum hours

GET

/museum-hours

Get upcoming museum operating hours.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Parameters

Query Parameters

startDate

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

Typestring

Example2023-02-23

formatdate

page

Page number to retrieve.

Typeinteger

Example2

default1

limit

Number of days per page.

Typeinteger

Example15

default10

maximum30

Responses

Success.

Content-Type

application/json

[

{

"date": "2023-09-11",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-12",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-13",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-14",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-15",

"timeOpen": "10:00",

"timeClose": "16:00"

},

{

"date": "2023-09-18",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-19",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-20",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-21",

"timeOpen": "09:00",

"timeClose": "18:00"

},

{

"date": "2023-09-22",

"timeOpen": "10:00",

"timeClose": "16:00"

}

]

GET

/museum-hours

Playground

Authorization

MuseumPlaceholderAuth

Variables

Key

Value

startDate

page

limit

Samples

cURL

curl 'https://redocly.com/_mock/docs/openapi/museum-api/museum-hours?startDate=2023-02-23&page=2&limit=15' \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/museum-hours?startDate=2023-02-23&page=2&limit=15', {
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  }
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/museum-hours?startDate=2023-02-23&page=2&limit=15");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);

curl_exec($ch);

curl_close($ch);

Python

requests.get(
    "https://redocly.com/_mock/docs/openapi/museum-api/museum-hours",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    },
    params={
      "startDate": "2023-02-23",
      "page": 2,
      "limit": 15
    }
)

---

Events

Special events hosted by the museum.

Operations

GET/special-eventsPOST/special-eventsGET/special-events/{eventId}DELETE/special-events/{eventId}PATCH/special-events/{eventId}

---

List special events

GET

/special-events

Return a list of upcoming special events at the museum.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Parameters

Query Parameters

startDate

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

Typestring

Example2023-02-23

formatdate

endDate

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

Typestring

Example2023-04-18

formatdate

page

Page number to retrieve.

Typeinteger

Example2

default1

limit

Number of days per page.

Typeinteger

Example15

default10

maximum30

Responses

Success.

Content-Type

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": [

"2023-12-15",

"2023-12-22"

],

"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": [

"2023-09-07",

"2023-09-14"

],

"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": [

"2023-11-10",

"2023-11-17",

"2023-11-24"

],

"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": [

"2023-09-12",

"2023-09-15"

],

"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": [

"2023-09-05",

"2023-09-08"

],

"price": 30

},

{

"eventId": "6744a0da-4121-49cd-8479-f8cc20526495",

"name": "Time Traveler Tea Party",

"location": "Temporal Tearoom",

"eventDescription": "Sip tea with important historical figures.",

"dates": [

"2023-11-18",

"2023-11-25",

"2023-12-02"

],

"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": [

"2023-10-29",

"2023-10-30",

"2023-10-31"

],

"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": [

"2023-10-29",

"2023-10-30",

"2023-10-31"

],

"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": [

"2023-11-03",

"2023-11-10"

],

"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": [

"2023-11-10",

"2023-11-17",

"2023-11-24"

],

"price": 5

}

]

GET

/special-events

Playground

Authorization

MuseumPlaceholderAuth

Variables

Key

Value

startDate

endDate

page

limit

Samples

cURL

curl 'https://redocly.com/_mock/docs/openapi/museum-api/special-events?startDate=2023-02-23&endDate=2023-04-18&page=2&limit=15' \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/special-events?startDate=2023-02-23&endDate=2023-04-18&page=2&limit=15', {
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  }
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/special-events?startDate=2023-02-23&endDate=2023-04-18&page=2&limit=15");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);

curl_exec($ch);

curl_close($ch);

Python

requests.get(
    "https://redocly.com/_mock/docs/openapi/museum-api/special-events",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    },
    params={
      "startDate": "2023-02-23",
      "endDate": "2023-04-18",
      "page": 2,
      "limit": 15
    }
)

---

Create special events

POST

/special-events

Creates a new special event for the museum.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Request Body

{

"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.

Content-Type

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-05",

"2023-09-08"

],

"price": 30

}

POST

/special-events

Playground

Authorization

MuseumPlaceholderAuth

Body

Samples

cURL

curl https://redocly.com/_mock/docs/openapi/museum-api/special-events \
  --request POST \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": [
    "2023-10-29"
  ],
  "price": 25
}'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/special-events', {
  method: 'POST',
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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: ['2023-10-29'],
    price: 25
  })
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/special-events");

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  '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' => [
    '2023-10-29'
  ],
  'price' => 25
]));

curl_exec($ch);

curl_close($ch);

Python

requests.post(
    "https://redocly.com/_mock/docs/openapi/museum-api/special-events",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    },
    json={
      "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": [
        "2023-10-29"
      ],
      "price": 25
    }
)

---

Get special event

GET

/special-events/{eventId}

Get details about a special event.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Parameters

Path Parameters

eventId*

Identifier for a special event.

Typestring

Required

Exampledad4bce8-f5cb-4078-a211-995864315e39

formatuuid

Responses

Success.

Content-Type

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-18",

"2023-11-25",

"2023-12-02"

],

"price": 60

}

GET

/special-events/{eventId}

Playground

Authorization

MuseumPlaceholderAuth

Variables

Key

Value

eventId*

Samples

cURL

curl https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39 \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39', {
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  }
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);

curl_exec($ch);

curl_close($ch);

Python

requests.get(
    "https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    }
)

---

Delete special event

DELETE

/special-events/{eventId}

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

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Parameters

Path Parameters

eventId*

Identifier for a special event.

Typestring

Required

Exampledad4bce8-f5cb-4078-a211-995864315e39

formatuuid

Responses

Success - no content.

DELETE

/special-events/{eventId}

Playground

Authorization

MuseumPlaceholderAuth

Variables

Key

Value

eventId*

Samples

cURL

curl https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39 \
  --request DELETE \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39', {
  method: 'DELETE',
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  }
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);

curl_exec($ch);

curl_close($ch);

Python

requests.delete(
    "https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    }
)

---

Update special event

PATCH

/special-events/{eventId}

Update the details of a special event.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Parameters

Path Parameters

eventId*

Identifier for a special event.

Typestring

Required

Exampledad4bce8-f5cb-4078-a211-995864315e39

formatuuid

Request Body

{

"location": "On the beach.",

"price": 15

}

Responses

Success.

Content-Type

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-05",

"2023-09-08"

],

"price": 15

}

PATCH

/special-events/{eventId}

Playground

Authorization

MuseumPlaceholderAuth

Variables

Key

Value

eventId*

Body

Samples

cURL

curl https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39 \
  --request PATCH \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Pirate Coding Workshop",
  "location": "Computer Room",
  "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
  "dates": [
    "2023-10-29"
  ],
  "price": 25
}'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39', {
  method: 'PATCH',
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Pirate Coding Workshop',
    location: 'Computer Room',
    eventDescription: 'Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).',
    dates: ['2023-10-29'],
    price: 25
  })
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  'name' => 'Pirate Coding Workshop',
  'location' => 'Computer Room',
  'eventDescription' => 'Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).',
  'dates' => [
    '2023-10-29'
  ],
  'price' => 25
]));

curl_exec($ch);

curl_close($ch);

Python

requests.patch(
    "https://redocly.com/_mock/docs/openapi/museum-api/special-events/dad4bce8-f5cb-4078-a211-995864315e39",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    },
    json={
      "name": "Pirate Coding Workshop",
      "location": "Computer Room",
      "eventDescription": "Captain Blackbeard shares his love of the C...language. And possibly Arrrrr (R lang).",
      "dates": [
        "2023-10-29"
      ],
      "price": 25
    }
)

---

Tickets

Museum tickets for general entrance or special events.

Operations

POST/ticketsGET/tickets/{ticketId}/qr

---

Buy museum tickets

POST

/tickets

Purchase museum tickets for general entry or special events.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Request Body

{

"ticketType": "general",

"ticketDate": "2023-09-07",

"email": "todd@example.com"

}

Responses

Created.

Content-Type

application/json

{

"message": "Museum general entry ticket purchased",

"ticketId": "382c0820-0530-4f4b-99af-13811ad0f17a",

"ticketType": "general",

"ticketDate": "2023-09-07",

"confirmationCode": "ticket-general-e5e5c6-dce78"

}

POST

/tickets

Playground

Authorization

MuseumPlaceholderAuth

Body

Samples

cURL

curl https://redocly.com/_mock/docs/openapi/museum-api/tickets \
  --request POST \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "museum-lover@example.com",
  "ticketId": "a54a57ca-36f8-421b-a6b4-2e8f26858a4c",
  "ticketDate": "2023-10-29",
  "ticketType": "string",
  "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54"
}'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/tickets', {
  method: 'POST',
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'museum-lover@example.com',
    ticketId: 'a54a57ca-36f8-421b-a6b4-2e8f26858a4c',
    ticketDate: '2023-10-29',
    ticketType: 'string',
    eventId: '3be6453c-03eb-4357-ae5a-984a0e574a54'
  })
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/tickets");

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  'email' => 'museum-lover@example.com',
  'ticketId' => 'a54a57ca-36f8-421b-a6b4-2e8f26858a4c',
  'ticketDate' => '2023-10-29',
  'ticketType' => 'string',
  'eventId' => '3be6453c-03eb-4357-ae5a-984a0e574a54'
]));

curl_exec($ch);

curl_close($ch);

Python

requests.post(
    "https://redocly.com/_mock/docs/openapi/museum-api/tickets",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    },
    json={
      "email": "museum-lover@example.com",
      "ticketId": "a54a57ca-36f8-421b-a6b4-2e8f26858a4c",
      "ticketDate": "2023-10-29",
      "ticketType": "string",
      "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54"
    }
)

---

Get ticket QR code

GET

/tickets/{ticketId}/qr

Return an image of your ticket with scannable QR code. Used for event entry.

Authorizations

MuseumPlaceholderAuth

TypeHTTP (basic)

Parameters

Path Parameters

ticketId*

Identifier for a ticket to a museum event. Used to generate ticket image.

Typestring

Required

Examplea54a57ca-36f8-421b-a6b4-2e8f26858a4c

formatuuid

Responses

Scannable event ticket in image format.

Content-Type

image/png

"string"

GET

/tickets/{ticketId}/qr

Playground

Authorization

MuseumPlaceholderAuth

Variables

Key

Value

ticketId*

Samples

cURL

curl https://redocly.com/_mock/docs/openapi/museum-api/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/qr \
  --header 'Authorization: Basic MuseumPlaceholderAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://redocly.com/_mock/docs/openapi/museum-api/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/qr', {
  headers: {
    Authorization: 'Basic MuseumPlaceholderAuth',
    'Content-Type': 'application/json'
  }
})

PHP

$ch = curl_init("https://redocly.com/_mock/docs/openapi/museum-api/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/qr");

curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic MuseumPlaceholderAuth', 'Content-Type: application/json']);

curl_exec($ch);

curl_close($ch);

Python

requests.get(
    "https://redocly.com/_mock/docs/openapi/museum-api/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/qr",
    headers={
      "Authorization": "Basic MuseumPlaceholderAuth",
      "Content-Type": "application/json"
    }
)

---

Powered by VitePress OpenAPI