VitePress OpenAPI

Appearance

v1.2.1

Redocly Museum API​

Download OpenAPI Document

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

Contact​

Contact/team@redocly.com

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
Example"2023-02-23"
Format"date"
page

Page number to retrieve.

Typeinteger
Example2
Default1
limit

Number of days per page.

Typeinteger
Example15
Default10
Maximum30

Responses​

Success.

application/json
object[]

List of museum operating hours for a date range.

Date the operating hours apply to.

Format"date"

Time the museum opens on a specific date. Uses 24 hour time format (HH:mm).

Pattern"^([01]\\d|2[0-3]):?([0-5]\\d)$"

Time the museum closes on a specific date. Uses 24 hour time format (HH:mm).

Pattern"^([01]\\d|2[0-3]):?([0-5]\\d)$"

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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
Example"2023-02-23"
Format"date"
endDate

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

Typestring
Example"2023-04-18"
Format"date"
page

Page number to retrieve.

Typeinteger
Example2
Default1
limit

Number of days per page.

Typeinteger
Example15
Default10
Maximum30

Responses​

Success.

application/json
object[]

List of upcoming special events.

Identifier for a special event.

Format"uuid"

Name of the special event.

Location where the special event is held.

Description of the special event.

string[]
Required

List of planned dates for the special event.

Price of a ticket for the special event.

Format"float"

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Create special events​

POST
/special-events

Creates a new special event for the museum.

Authorizations​

MuseumPlaceholderAuth
TypeHTTP (basic)

Request Body​

application/json
object

Identifier for a special event.

Format"uuid"

Name of the special event.

Location where the special event is held.

Description of the special event.

string[]
Required

List of planned dates for the special event.

Price of a ticket for the special event.

Format"float"

Responses​

Created.

application/json
object

Identifier for a special event.

Format"uuid"

Name of the special event.

Location where the special event is held.

Description of the special event.

string[]
Required

List of planned dates for the special event.

Price of a ticket for the special event.

Format"float"

Playground​

Authorization
Body

Samples​

cURL
JavaScript
PHP
Python

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
Example"dad4bce8-f5cb-4078-a211-995864315e39"
Format"uuid"

Responses​

Success.

application/json
object

Identifier for a special event.

Format"uuid"

Name of the special event.

Location where the special event is held.

Description of the special event.

string[]
Required

List of planned dates for the special event.

Price of a ticket for the special event.

Format"float"

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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
Example"dad4bce8-f5cb-4078-a211-995864315e39"
Format"uuid"

Responses​

Success - no content.

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

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
Example"dad4bce8-f5cb-4078-a211-995864315e39"
Format"uuid"

Request Body​

application/json
object

Name of the special event.

Location where the special event is held.

Description of the special event.

List of planned dates for the special event.

Price of a ticket for the special event.

Format"float"

Responses​

Success.

application/json
object

Identifier for a special event.

Format"uuid"

Name of the special event.

Location where the special event is held.

Description of the special event.

string[]
Required

List of planned dates for the special event.

Price of a ticket for the special event.

Format"float"

Playground​

Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python

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​

application/json
object

Data to purchase a ticket.

Email address for ticket purchaser.

Format"email"

Unique identifier for museum ticket. Generated when purchased.

Format"uuid"

Date when this ticket can be used for museum entry.

Format"date"

Type of ticket being purchased. Use general for regular museum entry and event for tickets to special events.

Valid values"event""general"

Unique identifier for a special event. Required if purchasing tickets for the museum's special events.

Format"uuid"

Responses​

Created.

application/json
object

Details for a museum ticket after a successful purchase.

Unique identifier for museum ticket. Generated when purchased.

Format"uuid"

Date when this ticket can be used for museum entry.

Format"date"

Type of ticket being purchased. Use general for regular museum entry and event for tickets to special events.

Valid values"event""general"

Unique identifier for a special event. Required if purchasing tickets for the museum's special events.

Format"uuid"

Confirmation message after a ticket purchase.

Unique confirmation code used to verify ticket purchase.

Playground​

Authorization
Body

Samples​

cURL
JavaScript
PHP
Python

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
Example"a54a57ca-36f8-421b-a6b4-2e8f26858a4c"
Format"uuid"

Responses​

Scannable event ticket in image format.

image/png

Image of a ticket with a QR code used for museum or event entry.

Format"binary"

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python
Powered by VitePress OpenAPI