Skip to main content

Generates a venue seating plan picture with default colors

POST 

/api/v1/catalog/venues/picture

Fetch a PNG image of the venue seating plan with default colors. Returns a picture property as a byte array base64 encoded.

This endpoint uses default colors:

  • Seat color: Magenta (RGB: 255, 0, 255)
  • Border width: 0 (no border)
  • Border color: White (RGB: 255, 255, 255)

SOAP Equivalent: AWSP_VenueGetPictureMap (see docs/developer-guides/api-development/soap-endpoints-reference.md)

Examples

✅ Success (200)

{
"picture": "iVBORw0KGgoAAAANSUhEUgAABkAAAASwCAYAAACdSLH6AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQ...ABJRU5ErkJggg=="
}

❌ Error 400 - Missing x-tenant header

{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Tenant header 'x-tenant' is required",
"instance": "/api/v1/catalog/venues/picture",
"traceId": "00-a1b2c3d4e5f6-7890abcdef-00"
}

❌ Error 422 - Validation failed

{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.23",
"title": "One or more validation errors occurred.",
"status": 422,
"errors": {
"VenueId": ["VenueId must be greater than 0"],
"Zoom": ["Zoom must be between 0.2 and 5.0"],
"Option": ["Option must be 800 (seat numbers and letters) or 801 (numbers only)"]
},
"instance": "/api/v1/catalog/venues/picture",
"traceId": "00-f1e2d3c4b5a6-9876543210-00"
}

❌ Error 404 - Venue not found

{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "No venue found",
"status": 404,
"detail": "The venue id doesn't exist for the client",
"errorCode": 10103,
"instance": "/api/v1/catalog/venues/picture",
"traceId": "00-1a2b3c4d5e6f-0987654321-00"
}

❌ Error 500 - Server error

{
"type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
"title": "An error occurred while processing your request.",
"status": 500,
"detail": "Failed to generate venue image",
"instance": "/api/v1/catalog/venues/picture",
"traceId": "00-9z8y7x6w5v4u-3210fedcba-00"
}

SOAP to REST Field Mapping

REST FieldSOAP FieldNotes
venueIdid_venueVenue unique identifier
optionoption800 (numbers+letters) or 801 (numbers only)
zoomzoomZoom factor (0.2 to 5.0)
picturepicturebytesBase64 encoded PNG image
N/A (default)R, G, BFixed to 255, 0, 255 (magenta)
N/A (default)borderWidthFixed to 0 (no border)
N/A (default)borderR, borderG, borderBFixed to 255, 255, 255 (white)
errorCoderesultError code (0 = success, see SOAP doc Annex 1)

Request

Responses

Returns the venue picture as a byte array in PNG format (base64 encoded in JSON)