Salta ai contenuti
PortoPorto

Dry-run validation of a map document; nothing is written (harbor.configure)

POST
/api/admin/v1/marinas/{marinaId}/maps/{mapId}/validate
Code sample: Shell / cURL
curl --request POST \
  --url https://example.com/api/admin/v1/marinas/example/maps/example/validate \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie porto_session=<porto_session> \
  --data '{ "kind": "water", "name": { "it": "example", "en": "example" }, "icon": "example", "width_cm": 1, "height_cm": 1, "grid_cm": 1, "sort_order": 1, "background": { "file_id": "example", "content_type": "image/png", "width_px": 1, "height_px": 1, "origin": { "x": 1, "y": 1 }, "scale_mcm_per_px": 1, "rotation_dd": 1, "opacity_pct": 1, "visible": true }, "georef": { "points": [ { "x": 1, "y": 1, "lat_e7": 1, "lon_e7": 1 } ] }, "concession_outline": [ { "x": 1, "y": 1 } ], "water_polygons": [ [ { "x": 1, "y": 1 } ] ], "land_polygons": [ [ { "x": 1, "y": 1 } ] ], "structures": [ { "id": "example", "key": "example", "kind": "quay", "code": "example", "name": "example", "points": [ { "x": 1, "y": 1 } ], "closed": true, "rect": { "anchor": { "x": 1, "y": 1 }, "width_cm": 1, "length_cm": 1, "rotation_dd": 1 }, "width_cm": 1, "parent_id": "example", "sides": [ "left" ], "floating": true, "depth_profile": [ { "from_cm": 1, "to_cm": 1, "depth_cm": 1 } ], "elevation_cm": 1, "bollard_spacing_cm": 1 } ], "berths": [ { "id": "example", "key": "example", "code": "example", "structure_id": "example", "side": "left", "position": 1, "anchor": { "x": 1, "y": 1 }, "rotation_dd": 1, "width_cm": 1, "length_cm": 1, "max_loa_cm": 1, "max_beam_cm": 1, "depth_cm": 1, "max_air_draft_cm": 1, "max_displacement_kg": 1, "mooring_type": "mooring_line", "swing_radius_cm": 1, "overhang_allowed": true, "pedestal_id": "example", "pedestal_socket": "example", "power_a": 16, "power_phase": "single", "water": true, "wifi": true, "price_class": "example", "attributes": [ "example" ], "online_sellable": true, "active": true, "group_ids": [ "example" ] } ], "dynamic_areas": [ { "id": "example", "key": "example", "kind": "linear", "code": "example", "structure_id": "example", "side": "left", "from_cm": 1, "to_cm": 1, "outline": [ { "x": 1, "y": 1 } ], "mooring_mode": "stern_to", "cell_cm": 1, "margin_cm": 1, "max_loa_cm": 1, "max_beam_cm": 1, "max_height_cm": 1, "max_weight_kg": 1, "supports": [ "cradle" ], "depth_profile": [ { "from_cm": 1, "to_cm": 1, "depth_cm": 1 } ], "blocked_cells": [ 1 ], "exits": [ 1 ], "grid_rotation_dd": 0, "price_class": "example", "online_sellable": true, "active": true, "group_ids": [ "example" ] } ], "land_resources": [ { "id": "example", "key": "example", "kind": "parking", "code": "example", "anchor": { "x": 1, "y": 1 }, "rotation_dd": 1, "width_cm": 1, "length_cm": 1, "price_class": "example", "attributes": [ "example" ], "active": true, "group_ids": [ "example" ] } ], "pedestals": [ { "id": "example", "key": "example", "code": "example", "position": { "x": 1, "y": 1 }, "sockets": [ { "code": "example", "kind": "power", "amps": 16, "phase": "single" } ], "meters": [ { "kind": "power", "serial": "example" } ] } ], "decorations": [ { "id": "example", "key": "example", "kind": "symbol", "asset": "example", "variant": "example", "position": { "x": 1, "y": 1 }, "rotation_dd": 1, "size_cm": 1, "points": [ { "x": 1, "y": 1 } ], "label": { "it": "example", "en": "example" }, "depth_cm": 1 } ] }'

Authorizations

Sezione intitolata “Authorizations”

Parameters

Sezione intitolata “Parameters”

Path Parameters

Sezione intitolata “Path Parameters”
marinaId
required
string
mapId
required
string

Request Bodyrequired

Sezione intitolata “Request Bodyrequired”
Media typeapplication/json
object
kind
required
string
Allowed values: water yard shed parking boxes other
name
required
object
it
required
string
>= 1 characters <= 200 characters
en
string
<= 200 characters
icon
required
string
<= 32 characters
width_cm
required
integer format: int64
>= 100 <= 500000
height_cm
required
integer format: int64
>= 100 <= 500000
grid_cm
required
integer format: int64
>= 1 <= 10000
sort_order
required
integer
background
required
One of:
object
file_id
required
string
content_type
required
string
Allowed values: image/png image/jpeg image/svg+xml
width_px
required
integer format: int64
>= 1
height_px
required
integer format: int64
>= 1
origin
required
object
x
required
integer format: int64
y
required
integer format: int64
scale_mcm_per_px
required

Milli-centimetres per image pixel (integer, at least 1)

integer format: int64
>= 1
rotation_dd
required

Angle in tenths of a degree, 0 = +x, 900 = +y (y down, clockwise on screen)

integer format: int64
<= 3599
opacity_pct
required
integer
<= 100
visible
required
boolean
georef
required
One of:

Affine georeference from three non-collinear control points (WGS84 × 1e7)

object
points
required
Array<object>
>= 3 items <= 3 items
object
x
required
integer format: int64
y
required
integer format: int64
lat_e7
required
integer format: int64
>= -900000000 <= 900000000
lon_e7
required
integer format: int64
>= -1800000000 <= 1800000000
concession_outline
required
One of:

Simple polygon in map cm (3 to 10 000 vertices, not closed explicitly)

Array<object>
>= 3 items <= 10000 items
object
x
required
integer format: int64
y
required
integer format: int64
water_polygons
required
Array<Array<object>>
<= 200 items
land_polygons
required
Array<Array<object>>
<= 200 items
structures
required
Array<object>
<= 20000 items
object
id

Saved element id (omit for a new element)

string
key

Client key of a new element, unique in the request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
kind
required
string
Allowed values: quay pier finger breakwater channel walkway
code
required
string
>= 1 characters <= 32 characters
name
string
<= 100 characters
points

Polyline (quay, pier, walkway, breakwater line) or polygon (closed = true)

Array<object>
<= 10000 items
object
x
required
integer format: int64
y
required
integer format: int64
closed
boolean
rect

Rotated rectangle; anchor = midpoint of the mooring (or access) side

object
anchor
required
object
x
required
integer format: int64
y
required
integer format: int64
width_cm
required

Strictly positive length in integer centimetres

integer format: int64
>= 1
length_cm
required

Strictly positive length in integer centimetres

integer format: int64
>= 1
rotation_dd
required

Angle in tenths of a degree, 0 = +x, 900 = +y (y down, clockwise on screen)

integer format: int64
<= 3599
width_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
parent_id

Reference to a map element inside one document: the id of a saved element or the key of a new element of the same request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
sides
Array<string>
<= 3 items
Allowed values: left right head none
floating
boolean
depth_profile
Array<object>
<= 1000 items

Depth along the structure axis, from from_cm to to_cm

object
from_cm
required

Length in integer centimetres

integer format: int64
to_cm
required

Length in integer centimetres

integer format: int64
depth_cm
required

Strictly positive length in integer centimetres

integer format: int64
>= 1
elevation_cm

Length in integer centimetres

integer format: int64
bollard_spacing_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
berths
required
Array<object>
<= 20000 items
object
id

Saved element id (omit for a new element)

string
key

Client key of a new element, unique in the request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
code
required
string
>= 1 characters <= 32 characters
structure_id

Reference to a map element inside one document: the id of a saved element or the key of a new element of the same request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
side
required
string
Allowed values: left right head none
position
required

Order along the structure

integer format: int64
anchor
required
object
x
required
integer format: int64
y
required
integer format: int64
rotation_dd
required

Angle in tenths of a degree, 0 = +x, 900 = +y (y down, clockwise on screen)

integer format: int64
<= 3599
width_cm
required

Side of a berth or land resource rectangle in integer centimetres, at least 2 (layout.MinRectSide)

integer format: int64
>= 2
length_cm
required

Side of a berth or land resource rectangle in integer centimetres, at least 2 (layout.MinRectSide)

integer format: int64
>= 2
max_loa_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
max_beam_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
depth_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
max_air_draft_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
max_displacement_kg
integer format: int64
>= 1
mooring_type
required
string
Allowed values: mooring_line finger alongside piles buoy
swing_radius_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
overhang_allowed
required
boolean
pedestal_id

Reference to a map element inside one document: the id of a saved element or the key of a new element of the same request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
pedestal_socket
string
<= 16 characters
power_a
integer
Allowed values: 16 32 63 125
power_phase
string
Allowed values: single three
water
required
boolean
wifi
required
boolean
price_class
string
<= 16 characters
attributes
required
Array<string>
<= 20 items
online_sellable
required
boolean
active
required
boolean
group_ids
required
Array<string>
<= 50 items
dynamic_areas
required
Array<object>
<= 20000 items
object
id

Saved element id (omit for a new element)

string
key

Client key of a new element, unique in the request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
kind
required
string
Allowed values: linear surface
code
required
string
>= 1 characters <= 32 characters
structure_id

Reference to a map element inside one document: the id of a saved element or the key of a new element of the same request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
side
string
Allowed values: left right head none
from_cm

Length in integer centimetres

integer format: int64
to_cm

Length in integer centimetres

integer format: int64
outline

Simple polygon in map cm (3 to 10 000 vertices, not closed explicitly)

Array<object>
>= 3 items <= 10000 items
object
x
required
integer format: int64
y
required
integer format: int64
mooring_mode
string
Allowed values: stern_to alongside
cell_cm
integer format: int64
>= 10 <= 1000
margin_cm
integer format: int64
<= 1000
max_loa_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
max_beam_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
max_height_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
max_weight_kg
integer format: int64
>= 1
supports
Array<string>
<= 3 items
Allowed values: cradle trailer rack
depth_profile
Array<object>
<= 1000 items

Depth along the structure axis, from from_cm to to_cm

object
from_cm
required

Length in integer centimetres

integer format: int64
to_cm
required

Length in integer centimetres

integer format: int64
depth_cm
required

Strictly positive length in integer centimetres

integer format: int64
>= 1
blocked_cells
required
Array<integer>
<= 1000000 items
exits
required
Array<integer>
<= 10000 items
grid_rotation_dd
required
integer format: int64
Allowed values: 0 900 1800 2700
cell_count

Computed at save

integer format: int64
price_class
string
<= 16 characters
online_sellable

The area is offered by the public booking page and the channels (default false)

boolean
active
required
boolean
group_ids
required
Array<string>
<= 50 items
land_resources
required
Array<object>
<= 20000 items
object
id

Saved element id (omit for a new element)

string
key

Client key of a new element, unique in the request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
kind
required
string
Allowed values: parking box storeroom locker cradle trailer_spot custom
code
required
string
>= 1 characters <= 32 characters
anchor
required
object
x
required
integer format: int64
y
required
integer format: int64
rotation_dd
required

Angle in tenths of a degree, 0 = +x, 900 = +y (y down, clockwise on screen)

integer format: int64
<= 3599
width_cm
required

Side of a berth or land resource rectangle in integer centimetres, at least 2 (layout.MinRectSide)

integer format: int64
>= 2
length_cm
required

Side of a berth or land resource rectangle in integer centimetres, at least 2 (layout.MinRectSide)

integer format: int64
>= 2
price_class
string
<= 16 characters
attributes
required
Array<string>
<= 20 items
active
required
boolean
group_ids
required
Array<string>
<= 50 items
pedestals
required
Array<object>
<= 20000 items
object
id

Saved element id (omit for a new element)

string
key

Client key of a new element, unique in the request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
code
required
string
>= 1 characters <= 32 characters
position
required
object
x
required
integer format: int64
y
required
integer format: int64
sockets
required
Array<object>
<= 16 items
object
code
required
string
>= 1 characters <= 16 characters
kind
required
string
Allowed values: power water
amps
integer
Allowed values: 16 32 63 125
phase
string
Allowed values: single three
meters
required
Array<object>
<= 16 items
object
kind
required
string
Allowed values: power water
serial
required
string
>= 1 characters <= 64 characters
decorations
required
Array<object>
<= 20000 items
object
id

Saved element id (omit for a new element)

string
key

Client key of a new element, unique in the request

string
>= 1 characters <= 64 characters /^[A-Za-z0-9_:-]+$/
kind
required
string
Allowed values: symbol text depth_label north_arrow scale_bar
asset

Illustration kit asset id (kind = symbol)

string
<= 64 characters
variant
string
<= 32 characters
position
object
x
required
integer format: int64
y
required
integer format: int64
rotation_dd

Angle in tenths of a degree, 0 = +x, 900 = +y (y down, clockwise on screen)

integer format: int64
<= 3599
size_cm

Strictly positive length in integer centimetres

integer format: int64
>= 1
points
Array<object>
<= 10000 items
object
x
required
integer format: int64
y
required
integer format: int64
label
object
it
required
string
>= 1 characters <= 200 characters
en
string
<= 200 characters
depth_cm

Length in integer centimetres

integer format: int64

Responses

Sezione intitolata “Responses”

200

Sezione intitolata “200”

Validation report

Media typeapplication/json
object
errors
required
Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64
warnings
required
Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64

Example 

{
  "errors": [
    {
      "severity": "error"
    }
  ],
  "warnings": [
    {
      "severity": "error"
    }
  ]
}

400

Sezione intitolata “400”

Malformed request or validation failure

Media typeapplication/problem+json
object
type
required
string
Allowed values: bad_request validation_failed weak_password invalid_reset_token invalid_totp pairing_code_invalid invalid_scope invalid_webhook_url unknown_event_type unauthorized invalid_credentials totp_required forbidden csrf_failed totp_enrolment_required totp_required_by_policy not_found method_not_allowed conflict slug_taken already_member last_owner totp_already_enabled totp_not_enrolled endpoint_disabled idempotency_in_progress version_conflict unsupported_media_type idempotency_key_reused precondition_required rate_limited internal_error not_ready map_invalid map_not_empty map_not_georeferenced invalid_file file_too_large csv_invalid customer_anonymized customer_merged download_link_expired no_price promo_not_applicable price_list_invalid price_list_immutable price_list_overlap in_use resource_taken fit_blocked placement_invalid invalid_transition quote_expired hold_expired closure_active undo_unavailable release_invalid customer_required not_implemented renewal_exists proposal_closed signature_open invalid_signature otp_invalid otp_locked otp_rate_limited link_invalid template_invalid template_limits paper_scan_required insurance_required customer_email_missing shares_invalid table_incomplete table_active transfer_requirements mandate_overlap vessel_in_other_fleet vessel_not_in_fleet import_not_undoable provider_unknown code_taken charge_immutable charge_cancelled use_edit match_exceeds refund_exceeds already_reversed credit_insufficient not_deposit nothing_to_settle charge_exists no_termination_amount not_exported export_empty export_too_large charges_not_open release_not_resold cash_session_required cash_session_open cash_session_closed cash_insufficient register_in_use provider_disabled provider_refund_unsupported provider_error billing_item_missing first_run_token_invalid first_run_done lan_port_unavailable lan_no_address backup_in_progress restore_failed restore_backup_newer allocation_changed offline_not_allowed remote_unreachable remote_pin_mismatch peripheral_unavailable claim_expired app_pin_invalid invalid_period invalid_report_filter report_too_large unknown_indicator booking_unavailable booking_rules booking_busy consent_required text_outdated refund_changed price_changed cancellation_not_allowed nothing_due idempotency_mismatch storage_target_invalid storage_no_space area_exits_invalid pinned_invalid too_many_items scenario_window_invalid scenario_not_draft scenario_conflicts movement_not_pending element_invalid maintenance_conflicts task_already_done reading_charged consumption_frozen formula_invalid work_order_closed work_order_has_charges qualification_mismatch capacity_exceeded dependency_violation duration_too_long offline_time_out_of_range timer_already_running return_exceeds_issued nothing_to_bill equipment_slot_taken operator_busy equipment_out_of_service equipment_capacity_exceeded operator_not_enabled outside_lift_window ingest_unauthorized ingest_timestamp_out_of_range invalid_payload segment_overlap resource_has_sensor invalid_sensor_resource alert_stale alert_action_not_allowed profile_incomplete photo_invalid
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
errors
Array<object>
object
field
required
string
code
required
string
message
string
retry_after_seconds
integer
issues

Map validation issues (map_invalid)

Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64
price_list_issues

Price list validation issues (price_list_invalid)

Array<object>
object
code
required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string
severity
required
string
Allowed values: error warning
ref
required
object
kind
required
string
Allowed values: list settings period band rule item
id

Id of the row, or the client key of an unsaved one

string
field
string
params

Codes and integers as strings; never personal data

object
key
additional properties
string
details

Machine-readable details: no_price {item_id, contract_type, night, unit, category, band, reason}; price_list_overlap {conflicts: [{id, code, valid_from, valid_to}]}; in_use {references}; resource_taken ConflictDetail; fit_blocked FitResult; placement_invalid {reason, allocation_id?}; invalid_transition {from, action}; closure_active {closure_id, from_date, to_date}; release_invalid {reason}; allocation_changed {current_resource_id, current_resource_code} (null when the allocation is gone); remote_pin_mismatch {expected_fingerprint, presented_fingerprint}; scenario_conflicts {conflicts: [StorageScenarioConflict]}; maintenance_conflicts {conflicts: [MaintenanceConflict]}; storage_no_space {area_id, from, to}. Ids, codes, dates and integers only.

object
key
additional properties
any

Example 

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}

401

Sezione intitolata “401”

Not authenticated, or invalid credentials

Media typeapplication/problem+json
object
type
required
string
Allowed values: bad_request validation_failed weak_password invalid_reset_token invalid_totp pairing_code_invalid invalid_scope invalid_webhook_url unknown_event_type unauthorized invalid_credentials totp_required forbidden csrf_failed totp_enrolment_required totp_required_by_policy not_found method_not_allowed conflict slug_taken already_member last_owner totp_already_enabled totp_not_enrolled endpoint_disabled idempotency_in_progress version_conflict unsupported_media_type idempotency_key_reused precondition_required rate_limited internal_error not_ready map_invalid map_not_empty map_not_georeferenced invalid_file file_too_large csv_invalid customer_anonymized customer_merged download_link_expired no_price promo_not_applicable price_list_invalid price_list_immutable price_list_overlap in_use resource_taken fit_blocked placement_invalid invalid_transition quote_expired hold_expired closure_active undo_unavailable release_invalid customer_required not_implemented renewal_exists proposal_closed signature_open invalid_signature otp_invalid otp_locked otp_rate_limited link_invalid template_invalid template_limits paper_scan_required insurance_required customer_email_missing shares_invalid table_incomplete table_active transfer_requirements mandate_overlap vessel_in_other_fleet vessel_not_in_fleet import_not_undoable provider_unknown code_taken charge_immutable charge_cancelled use_edit match_exceeds refund_exceeds already_reversed credit_insufficient not_deposit nothing_to_settle charge_exists no_termination_amount not_exported export_empty export_too_large charges_not_open release_not_resold cash_session_required cash_session_open cash_session_closed cash_insufficient register_in_use provider_disabled provider_refund_unsupported provider_error billing_item_missing first_run_token_invalid first_run_done lan_port_unavailable lan_no_address backup_in_progress restore_failed restore_backup_newer allocation_changed offline_not_allowed remote_unreachable remote_pin_mismatch peripheral_unavailable claim_expired app_pin_invalid invalid_period invalid_report_filter report_too_large unknown_indicator booking_unavailable booking_rules booking_busy consent_required text_outdated refund_changed price_changed cancellation_not_allowed nothing_due idempotency_mismatch storage_target_invalid storage_no_space area_exits_invalid pinned_invalid too_many_items scenario_window_invalid scenario_not_draft scenario_conflicts movement_not_pending element_invalid maintenance_conflicts task_already_done reading_charged consumption_frozen formula_invalid work_order_closed work_order_has_charges qualification_mismatch capacity_exceeded dependency_violation duration_too_long offline_time_out_of_range timer_already_running return_exceeds_issued nothing_to_bill equipment_slot_taken operator_busy equipment_out_of_service equipment_capacity_exceeded operator_not_enabled outside_lift_window ingest_unauthorized ingest_timestamp_out_of_range invalid_payload segment_overlap resource_has_sensor invalid_sensor_resource alert_stale alert_action_not_allowed profile_incomplete photo_invalid
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
errors
Array<object>
object
field
required
string
code
required
string
message
string
retry_after_seconds
integer
issues

Map validation issues (map_invalid)

Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64
price_list_issues

Price list validation issues (price_list_invalid)

Array<object>
object
code
required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string
severity
required
string
Allowed values: error warning
ref
required
object
kind
required
string
Allowed values: list settings period band rule item
id

Id of the row, or the client key of an unsaved one

string
field
string
params

Codes and integers as strings; never personal data

object
key
additional properties
string
details

Machine-readable details: no_price {item_id, contract_type, night, unit, category, band, reason}; price_list_overlap {conflicts: [{id, code, valid_from, valid_to}]}; in_use {references}; resource_taken ConflictDetail; fit_blocked FitResult; placement_invalid {reason, allocation_id?}; invalid_transition {from, action}; closure_active {closure_id, from_date, to_date}; release_invalid {reason}; allocation_changed {current_resource_id, current_resource_code} (null when the allocation is gone); remote_pin_mismatch {expected_fingerprint, presented_fingerprint}; scenario_conflicts {conflicts: [StorageScenarioConflict]}; maintenance_conflicts {conflicts: [MaintenanceConflict]}; storage_no_space {area_id, from, to}. Ids, codes, dates and integers only.

object
key
additional properties
any

Example 

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}

403

Sezione intitolata “403”

Authenticated but not allowed

Media typeapplication/problem+json
object
type
required
string
Allowed values: bad_request validation_failed weak_password invalid_reset_token invalid_totp pairing_code_invalid invalid_scope invalid_webhook_url unknown_event_type unauthorized invalid_credentials totp_required forbidden csrf_failed totp_enrolment_required totp_required_by_policy not_found method_not_allowed conflict slug_taken already_member last_owner totp_already_enabled totp_not_enrolled endpoint_disabled idempotency_in_progress version_conflict unsupported_media_type idempotency_key_reused precondition_required rate_limited internal_error not_ready map_invalid map_not_empty map_not_georeferenced invalid_file file_too_large csv_invalid customer_anonymized customer_merged download_link_expired no_price promo_not_applicable price_list_invalid price_list_immutable price_list_overlap in_use resource_taken fit_blocked placement_invalid invalid_transition quote_expired hold_expired closure_active undo_unavailable release_invalid customer_required not_implemented renewal_exists proposal_closed signature_open invalid_signature otp_invalid otp_locked otp_rate_limited link_invalid template_invalid template_limits paper_scan_required insurance_required customer_email_missing shares_invalid table_incomplete table_active transfer_requirements mandate_overlap vessel_in_other_fleet vessel_not_in_fleet import_not_undoable provider_unknown code_taken charge_immutable charge_cancelled use_edit match_exceeds refund_exceeds already_reversed credit_insufficient not_deposit nothing_to_settle charge_exists no_termination_amount not_exported export_empty export_too_large charges_not_open release_not_resold cash_session_required cash_session_open cash_session_closed cash_insufficient register_in_use provider_disabled provider_refund_unsupported provider_error billing_item_missing first_run_token_invalid first_run_done lan_port_unavailable lan_no_address backup_in_progress restore_failed restore_backup_newer allocation_changed offline_not_allowed remote_unreachable remote_pin_mismatch peripheral_unavailable claim_expired app_pin_invalid invalid_period invalid_report_filter report_too_large unknown_indicator booking_unavailable booking_rules booking_busy consent_required text_outdated refund_changed price_changed cancellation_not_allowed nothing_due idempotency_mismatch storage_target_invalid storage_no_space area_exits_invalid pinned_invalid too_many_items scenario_window_invalid scenario_not_draft scenario_conflicts movement_not_pending element_invalid maintenance_conflicts task_already_done reading_charged consumption_frozen formula_invalid work_order_closed work_order_has_charges qualification_mismatch capacity_exceeded dependency_violation duration_too_long offline_time_out_of_range timer_already_running return_exceeds_issued nothing_to_bill equipment_slot_taken operator_busy equipment_out_of_service equipment_capacity_exceeded operator_not_enabled outside_lift_window ingest_unauthorized ingest_timestamp_out_of_range invalid_payload segment_overlap resource_has_sensor invalid_sensor_resource alert_stale alert_action_not_allowed profile_incomplete photo_invalid
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
errors
Array<object>
object
field
required
string
code
required
string
message
string
retry_after_seconds
integer
issues

Map validation issues (map_invalid)

Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64
price_list_issues

Price list validation issues (price_list_invalid)

Array<object>
object
code
required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string
severity
required
string
Allowed values: error warning
ref
required
object
kind
required
string
Allowed values: list settings period band rule item
id

Id of the row, or the client key of an unsaved one

string
field
string
params

Codes and integers as strings; never personal data

object
key
additional properties
string
details

Machine-readable details: no_price {item_id, contract_type, night, unit, category, band, reason}; price_list_overlap {conflicts: [{id, code, valid_from, valid_to}]}; in_use {references}; resource_taken ConflictDetail; fit_blocked FitResult; placement_invalid {reason, allocation_id?}; invalid_transition {from, action}; closure_active {closure_id, from_date, to_date}; release_invalid {reason}; allocation_changed {current_resource_id, current_resource_code} (null when the allocation is gone); remote_pin_mismatch {expected_fingerprint, presented_fingerprint}; scenario_conflicts {conflicts: [StorageScenarioConflict]}; maintenance_conflicts {conflicts: [MaintenanceConflict]}; storage_no_space {area_id, from, to}. Ids, codes, dates and integers only.

object
key
additional properties
any

Example 

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}

404

Sezione intitolata “404”

Not found (or not visible to the principal)

Media typeapplication/problem+json
object
type
required
string
Allowed values: bad_request validation_failed weak_password invalid_reset_token invalid_totp pairing_code_invalid invalid_scope invalid_webhook_url unknown_event_type unauthorized invalid_credentials totp_required forbidden csrf_failed totp_enrolment_required totp_required_by_policy not_found method_not_allowed conflict slug_taken already_member last_owner totp_already_enabled totp_not_enrolled endpoint_disabled idempotency_in_progress version_conflict unsupported_media_type idempotency_key_reused precondition_required rate_limited internal_error not_ready map_invalid map_not_empty map_not_georeferenced invalid_file file_too_large csv_invalid customer_anonymized customer_merged download_link_expired no_price promo_not_applicable price_list_invalid price_list_immutable price_list_overlap in_use resource_taken fit_blocked placement_invalid invalid_transition quote_expired hold_expired closure_active undo_unavailable release_invalid customer_required not_implemented renewal_exists proposal_closed signature_open invalid_signature otp_invalid otp_locked otp_rate_limited link_invalid template_invalid template_limits paper_scan_required insurance_required customer_email_missing shares_invalid table_incomplete table_active transfer_requirements mandate_overlap vessel_in_other_fleet vessel_not_in_fleet import_not_undoable provider_unknown code_taken charge_immutable charge_cancelled use_edit match_exceeds refund_exceeds already_reversed credit_insufficient not_deposit nothing_to_settle charge_exists no_termination_amount not_exported export_empty export_too_large charges_not_open release_not_resold cash_session_required cash_session_open cash_session_closed cash_insufficient register_in_use provider_disabled provider_refund_unsupported provider_error billing_item_missing first_run_token_invalid first_run_done lan_port_unavailable lan_no_address backup_in_progress restore_failed restore_backup_newer allocation_changed offline_not_allowed remote_unreachable remote_pin_mismatch peripheral_unavailable claim_expired app_pin_invalid invalid_period invalid_report_filter report_too_large unknown_indicator booking_unavailable booking_rules booking_busy consent_required text_outdated refund_changed price_changed cancellation_not_allowed nothing_due idempotency_mismatch storage_target_invalid storage_no_space area_exits_invalid pinned_invalid too_many_items scenario_window_invalid scenario_not_draft scenario_conflicts movement_not_pending element_invalid maintenance_conflicts task_already_done reading_charged consumption_frozen formula_invalid work_order_closed work_order_has_charges qualification_mismatch capacity_exceeded dependency_violation duration_too_long offline_time_out_of_range timer_already_running return_exceeds_issued nothing_to_bill equipment_slot_taken operator_busy equipment_out_of_service equipment_capacity_exceeded operator_not_enabled outside_lift_window ingest_unauthorized ingest_timestamp_out_of_range invalid_payload segment_overlap resource_has_sensor invalid_sensor_resource alert_stale alert_action_not_allowed profile_incomplete photo_invalid
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
errors
Array<object>
object
field
required
string
code
required
string
message
string
retry_after_seconds
integer
issues

Map validation issues (map_invalid)

Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64
price_list_issues

Price list validation issues (price_list_invalid)

Array<object>
object
code
required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string
severity
required
string
Allowed values: error warning
ref
required
object
kind
required
string
Allowed values: list settings period band rule item
id

Id of the row, or the client key of an unsaved one

string
field
string
params

Codes and integers as strings; never personal data

object
key
additional properties
string
details

Machine-readable details: no_price {item_id, contract_type, night, unit, category, band, reason}; price_list_overlap {conflicts: [{id, code, valid_from, valid_to}]}; in_use {references}; resource_taken ConflictDetail; fit_blocked FitResult; placement_invalid {reason, allocation_id?}; invalid_transition {from, action}; closure_active {closure_id, from_date, to_date}; release_invalid {reason}; allocation_changed {current_resource_id, current_resource_code} (null when the allocation is gone); remote_pin_mismatch {expected_fingerprint, presented_fingerprint}; scenario_conflicts {conflicts: [StorageScenarioConflict]}; maintenance_conflicts {conflicts: [MaintenanceConflict]}; storage_no_space {area_id, from, to}. Ids, codes, dates and integers only.

object
key
additional properties
any

Example 

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}

413

Sezione intitolata “413”

Request body above the operation’s limit, or file above 15 MiB (file_too_large)

Media typeapplication/problem+json
object
type
required
string
Allowed values: bad_request validation_failed weak_password invalid_reset_token invalid_totp pairing_code_invalid invalid_scope invalid_webhook_url unknown_event_type unauthorized invalid_credentials totp_required forbidden csrf_failed totp_enrolment_required totp_required_by_policy not_found method_not_allowed conflict slug_taken already_member last_owner totp_already_enabled totp_not_enrolled endpoint_disabled idempotency_in_progress version_conflict unsupported_media_type idempotency_key_reused precondition_required rate_limited internal_error not_ready map_invalid map_not_empty map_not_georeferenced invalid_file file_too_large csv_invalid customer_anonymized customer_merged download_link_expired no_price promo_not_applicable price_list_invalid price_list_immutable price_list_overlap in_use resource_taken fit_blocked placement_invalid invalid_transition quote_expired hold_expired closure_active undo_unavailable release_invalid customer_required not_implemented renewal_exists proposal_closed signature_open invalid_signature otp_invalid otp_locked otp_rate_limited link_invalid template_invalid template_limits paper_scan_required insurance_required customer_email_missing shares_invalid table_incomplete table_active transfer_requirements mandate_overlap vessel_in_other_fleet vessel_not_in_fleet import_not_undoable provider_unknown code_taken charge_immutable charge_cancelled use_edit match_exceeds refund_exceeds already_reversed credit_insufficient not_deposit nothing_to_settle charge_exists no_termination_amount not_exported export_empty export_too_large charges_not_open release_not_resold cash_session_required cash_session_open cash_session_closed cash_insufficient register_in_use provider_disabled provider_refund_unsupported provider_error billing_item_missing first_run_token_invalid first_run_done lan_port_unavailable lan_no_address backup_in_progress restore_failed restore_backup_newer allocation_changed offline_not_allowed remote_unreachable remote_pin_mismatch peripheral_unavailable claim_expired app_pin_invalid invalid_period invalid_report_filter report_too_large unknown_indicator booking_unavailable booking_rules booking_busy consent_required text_outdated refund_changed price_changed cancellation_not_allowed nothing_due idempotency_mismatch storage_target_invalid storage_no_space area_exits_invalid pinned_invalid too_many_items scenario_window_invalid scenario_not_draft scenario_conflicts movement_not_pending element_invalid maintenance_conflicts task_already_done reading_charged consumption_frozen formula_invalid work_order_closed work_order_has_charges qualification_mismatch capacity_exceeded dependency_violation duration_too_long offline_time_out_of_range timer_already_running return_exceeds_issued nothing_to_bill equipment_slot_taken operator_busy equipment_out_of_service equipment_capacity_exceeded operator_not_enabled outside_lift_window ingest_unauthorized ingest_timestamp_out_of_range invalid_payload segment_overlap resource_has_sensor invalid_sensor_resource alert_stale alert_action_not_allowed profile_incomplete photo_invalid
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
errors
Array<object>
object
field
required
string
code
required
string
message
string
retry_after_seconds
integer
issues

Map validation issues (map_invalid)

Array<object>
object
code
required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string
severity
required
string
Allowed values: error warning
element_type
required
string
refs
required
Array<string>
field
string
params

Numbers only (cm, counts)

object
key
additional properties
integer format: int64
price_list_issues

Price list validation issues (price_list_invalid)

Array<object>
object
code
required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string
severity
required
string
Allowed values: error warning
ref
required
object
kind
required
string
Allowed values: list settings period band rule item
id

Id of the row, or the client key of an unsaved one

string
field
string
params

Codes and integers as strings; never personal data

object
key
additional properties
string
details

Machine-readable details: no_price {item_id, contract_type, night, unit, category, band, reason}; price_list_overlap {conflicts: [{id, code, valid_from, valid_to}]}; in_use {references}; resource_taken ConflictDetail; fit_blocked FitResult; placement_invalid {reason, allocation_id?}; invalid_transition {from, action}; closure_active {closure_id, from_date, to_date}; release_invalid {reason}; allocation_changed {current_resource_id, current_resource_code} (null when the allocation is gone); remote_pin_mismatch {expected_fingerprint, presented_fingerprint}; scenario_conflicts {conflicts: [StorageScenarioConflict]}; maintenance_conflicts {conflicts: [MaintenanceConflict]}; storage_no_space {area_id, from, to}. Ids, codes, dates and integers only.

object
key
additional properties
any

Example 

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}
diCoste360.itCoste360.it

Porto è sviluppato da Coste360 SRL. Codice sorgente disponibile con licenza BSL 1.1; il marchio Porto è escluso dalla licenza.