Skip to content
API Catalog/Train Travel API/
/
List all tickets

Redocly Museum API (1.2.1)

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

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://redocly.com/docs/cli/
E-mail
team@redocly.com
License
MIT
Terms of Service
Languages
Servers
Mock server
https://vlad.redocly.xyz/_mock/apis/museum/openapi
https://redocly.com/_mock/docs/openapi/museum-api

Operations

Operational information about the museum.

Operations

Events

Special events hosted by the museum.

Operations
Webhooks

Tickets

Museum tickets for general entrance or special events.

Operations

List all tickets

Request

Return a list of all tickets.

Security
MuseumPlaceholderAuth
Query
pageinteger

Page number to retrieve.

Default 1
Example: page=2
limitinteger<= 30

Number of days per page.

Default 10
Example: limit=15
curl -i -X GET \
  -u <username>:<password> \
  'https://vlad.redocly.xyz/_mock/apis/museum/openapi/tickets?page=2&limit=15'

Responses

Success.

Bodyapplication/jsonArray [
ticketIdstring(uuid)(TicketId)

Unique identifier for museum ticket. Generated when purchased.

ticketDatestring(date)(Date)required

Date when this ticket can be used for museum entry.

ticketTypestring(TicketType)required

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

Enum"event""general"
eventIdstring(uuid)(EventId)

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

]
Response
application/json
[
  {
    "ticketId": "a54a57ca-36f8-421b-a6b4-2e8f26858a4c",
    "ticketDate": "2023-10-29",
    "ticketType": "event",
    "eventId": "3be6453c-03eb-4357-ae5a-984a0e574a54"
  }
]

Buy museum tickets

Request

Purchase museum tickets for general entry or special events.

Security
MuseumPlaceholderAuth
Bodyapplication/jsonrequired
emailstring(email)(Email)

Email address for ticket purchaser.

ticketIdstring(uuid)(TicketId)

Unique identifier for museum ticket. Generated when purchased.

ticketDatestring(date)(Date)required

Date when this ticket can be used for museum entry.

ticketTypestring(TicketType)required

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

Enum"event""general"
eventIdstring(uuid)(EventId)

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

curl -i -X POST \
  -u <username>:<password> \
  https://vlad.redocly.xyz/_mock/apis/museum/openapi/tickets \
  -H 'Content-Type: application/json' \
  -d '{
    "ticketType": "general",
    "ticketDate": "2023-09-07",
    "email": "todd@example.com"
  }'

Responses

Created.

Bodyapplication/json
ticketIdstring(uuid)(TicketId)

Unique identifier for museum ticket. Generated when purchased.

ticketDatestring(date)(Date)required

Date when this ticket can be used for museum entry.

ticketTypestring(TicketType)required

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

Enum"event""general"
eventIdstring(uuid)(EventId)

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

messagestring(TicketMessage)required

Confirmation message after a ticket purchase.

confirmationCodestring(TicketConfirmation)required

Unique confirmation code used to verify ticket purchase.

Response
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"
}

Get ticket pkpass

Request

Return a pkpass. Used for event entry.

Security
MuseumPlaceholderAuth
Path
ticketIdstring(uuid)required

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

Example: a54a57ca-36f8-421b-a6b4-2e8f26858a4c
curl -i -X GET \
  -u <username>:<password> \
  https://vlad.redocly.xyz/_mock/apis/museum/openapi/tickets/a54a57ca-36f8-421b-a6b4-2e8f26858a4c/pkpass

Responses

New pkpass ticket format.

Bodyapplication/json
eventNamestring

The name of the event

Example: "Museum admission"
datestring(date)(Date)

Date of the event.

Example: "2024-12-31"
timestring^([01]\d|2[0-3]):?([0-5]\d)$

Time of the event. Uses 24 hour time format (HH:mm).

Example: "09:00"
ticketIdstring(uuid)(TicketId)

Unique identifier for museum ticket. Generated when purchased.

Response
application/json
{
  "eventName": "Museum admission",
  "date": "2023-10-29",
  "time": "09:00",
  "ticketId": "a54a57ca-36f8-421b-a6b4-2e8f26858a4c"
}