Documento completo della mappa (mappa, postazioni, decorazioni)

GET

/api/admin/v1/establishments/{establishmentId}/maps/{mapId}

curl --request GET \
  --url https://example.com/api/admin/v1/establishments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie arenile_session=<arenile_session>

• Stessa origine dell'istanza Arenile

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

establishmentId

required

string format: uuid

mapId

required

string format: uuid

Responses

200

Documento della mappa

Media typeapplication/json

Documento completo della mappa; la versione è anche nell’header ETag.

object

map

required

object

id

required

string format: uuid

name

required

Testo localizzato lingua → testo (es. {“it”: “Prima fila”}); si ricade sulla lingua predefinita.

object

key

additional properties

string

<= 2000 characters

width

required

integer

height

required

integer

grid_size

required

integer

background

Sfondo opzionale della mappa (spec 11.2).

object

type

required

string

Allowed values: image geojson

url

URL dell’immagine (type=image).

string

<= 2048 characters

geojson

Perimetro GeoJSON (type=geojson).

object

key

additional properties

any

scale

number format: double

> 0

rotation

number format: double

offset_x

number format: double

offset_y

number format: double

opacity

number format: double

<= 1

sea_side

required

string

Allowed values: top bottom left right

sort_order

required

integer

spot_count

required

integer

version

required

Versione per la concorrenza ottimistica; coincide con l’ETag.

integer format: int64

>= 1

created_at

required

string format: date-time

updated_at

required

string format: date-time

spots

required

Array<object>

Postazione prenotabile.

object

id

required

string format: uuid

map_id

required

string format: uuid

zone_id

required

string format: uuid

label

required

string

>= 1 characters <= 16 characters

row_label

required

string

<= 8 characters

number

required

integer

kind

required

Famiglia della postazione (semantica: pacchetti e regole possono richiederla). I valori sunbed, daybed, cabana e hammock coprono le famiglie prenotabili del kit mappa (ADR 0012).

string

Allowed values: umbrella gazebo tent palm custom sunbed daybed cabana hammock

asset

Illustrazione del kit mappa (id di assets/map-kits/*/manifest.json, uguali in ogni kit; ADR 0012, 0024). Assente = illustrazione predefinita del tipo. Le postazioni accettano solo illustrazioni prenotabili.

string

/^[a-z][a-z0-9_]{0,63}$/

x

required

number format: double

y

required

number format: double

rotation

required

number format: double

shape

required

object

type

required

string

Allowed values: circle rect

w

required

number format: double

h

required

number format: double

capacity

required

Quantità per codice componente (es. {“umbrella”: 1, “sunbed”: 2}).

object

key

additional properties

integer

max_extra

required

Quantità per codice componente (es. {“umbrella”: 1, “sunbed”: 2}).

object

key

additional properties

integer

price_category_override

string

/^[a-z0-9][a-z0-9_-]{0,31}$/

attributes

required

Array<string>

active

required

boolean

decorations

required

Array<object>

Elemento decorativo non prenotabile.

object

id

required

string format: uuid

map_id

required

string format: uuid

kind

required

string

Allowed values: walkway shower lifeguard bar entrance cabin_block text custom

asset

Illustrazione del kit mappa (id di assets/map-kits/*/manifest.json, uguali in ogni kit; ADR 0012, 0024). Assente = illustrazione predefinita del tipo. Le postazioni accettano solo illustrazioni prenotabili.

string

/^[a-z][a-z0-9_]{0,63}$/

variant

Variante di colore dell’illustrazione, se l’illustrazione ne prevede (bandiera_mare: green, yellow, red).

string

/^[a-z][a-z0-9_]{0,31}$/

x

required

number format: double

y

required

number format: double

rotation

required

number format: double

shape

required

object

type

required

string

Allowed values: circle rect

w

required

number format: double

h

required

number format: double

label

Testo localizzato lingua → testo (es. {“it”: “Prima fila”}); si ricade sulla lingua predefinita.

object

key

additional properties

string

<= 2000 characters

Example

{
  "map": {
    "background": {
      "type": "image"
    },
    "sea_side": "top"
  },
  "spots": [
    {
      "kind": "umbrella",
      "shape": {
        "type": "circle"
      }
    }
  ],
  "decorations": [
    {
      "kind": "walkway",
      "shape": {
        "type": "circle"
      }
    }
  ]
}

Headers

ETag

string

Versione della risorsa ("<version>"), da reinviare in If-Match.

401

Autenticazione assente o non valida

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

403

Permesso negato

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}

404

Risorsa inesistente

Media typeapplication/problem+json

Errore RFC 9457 (application/problem+json).

object

type

required

Slug stabile del tipo di errore. I client devono basarsi su questo valore, mai sul testo di title o detail.

string

Allowed values: bad_request validation_failed unauthorized invalid_credentials totp_required invalid_totp totp_enrolment_required totp_already_enabled forbidden csrf_failed not_found conflict method_not_allowed unsupported_media_type rate_limited idempotency_key_reused idempotency_in_progress internal_error spot_unavailable no_price policy_violation hold_expired version_conflict precondition_required spot_has_future_allocations not_implemented pool_exhausted quota_exceeded invalid_transition cash_session_closed cash_session_already_open booking_outside_period checkout_not_found payment_provider_unavailable webhook_signature_invalid pairing_code_invalid lan_mode_required loopback_required setup_token_invalid setup_completed renewal_expired waitlist_offer_expired waitlist_disabled credit_insufficient season_rollover_conflict test_mode_preview_required import_invalid import_already_applied refund_in_progress zone_full assignment_conflict ticket_number_conflict ticket_voided ticket_already_entered price_changed ticket_owned printing_unavailable printer_address_not_allowed print_route_missing payment_provider_test_mode email_template_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

retry_after

Secondi da attendere (solo per rate_limited).

integer

errors

Array<object>

object

field

required

string

message

required

string

current_version

Versione corrente della risorsa (solo per version_conflict).

integer format: int64

spot_ids

Postazioni con allocazioni future (solo per spot_has_future_allocations).

Array<string>

violations

Vincoli violati (solo per policy_violation).

Array<object>

object

code

required

Codice stabile (es. lead_time_too_short).

string

params

object

key

additional properties

string

conflicts

Mezze giornate non disponibili (solo per spot_unavailable, pool_exhausted, quota_exceeded).

Array<object>

Mezza giornata non disponibile per una risorsa (spec 7.2), restituita in Problem.conflicts e nelle anteprime.

object

spot_id

string format: uuid

pool_id

string format: uuid

zone_id

string format: uuid

date

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

slot

required

Fascia: mattina o pomeriggio.

string

Allowed values: AM PM

reason

required

string

Allowed values: spot_unavailable pool_exhausted quota_exceeded closed inactive

current_status

Stato della prenotazione (spec 10.2).

string

Allowed values: draft held pending_payment awaiting_approval confirmed checked_in completed cancelled no_show expired rejected

existing_customer_id

Cliente già presente con la stessa email o telefono (solo per conflict su createCustomer).

string format: uuid

period

Periodo del soggiorno e data odierna dello stabilimento (solo per booking_outside_period).

object

today

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

starts_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

ends_on

required

Data di calendario YYYY-MM-DD nel fuso dello stabilimento.

string format: date

Example

{
  "type": "bad_request",
  "conflicts": [
    {
      "slot": "AM",
      "reason": "spot_unavailable"
    }
  ],
  "current_status": "draft"
}