Redocly Museum API (1.1.1)

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

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

Operations

Operational information about the museum.

Operations

Events

Special events hosted by the museum.

Operations

Tickets

Museum tickets for general entrance or special events.

Operations

Buy museum tickets

Request

Purchase museum tickets for general entry or special events.

Bodyapplication/jsonrequired
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)

Identifier for a special event.

ticketDatestring(date)(Date)required

Date that the ticket is valid for.

emailstring(email)(Email)required

Email address for ticket purchaser.

phonestring(Phone)

Phone number for the ticket purchaser (optional).

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

Responses

Created.

Bodyapplication/json
messagestring(TicketMessage)required

Confirmation message after a ticket purchase.

eventNamestring(EventName)

Name of the special event.

ticketIdstring(uuid)(TicketId)required

Unique identifier for museum ticket. Generated when purchased.

ticketTypestring(TicketType)required

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

Enum"event""general"
ticketDatestring(date)(Date)required

Date the ticket is valid for.

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 QR code

Request

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

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://redocly.com/_mock/docs/openapi/museum-api/tickets/{ticketId}/qr'

Responses

Scannable event ticket in image format.

Bodyimage/png
string(binary)(GetTicketCodeResponse)

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

Response
application/problem+json
{
  "type": "object",
  "title": "Validation failed"
}