Salta ai contenuti
PortoPorto

Terminate an active contract from effective_on: later nights are freed (contracts.write)

POST
/api/admin/v1/marinas/{marinaId}/contracts/{contractId}/terminate
Code sample: Shell / cURL
curl --request POST \
  --url https://example.com/api/admin/v1/marinas/example/contracts/example/terminate \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie porto_session=<porto_session> \
  --data '{ "effective_on": "2026-04-15", "reason": "example" }'

Authorizations

Sezione intitolata “Authorizations”

Parameters

Sezione intitolata “Parameters”

Path Parameters

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

Header Parameters

Sezione intitolata “Header Parameters”
Idempotency-Key
string
>= 8 characters <= 128 characters /^[A-Za-z0-9_\-:.]+$/

8 to 128 characters of [A-Za-z0-9_-:.]; the response is replayed for 24 hours, 7 days for offline operations (x-porto-offline).

If-Match
string

The ETag of the version being changed. Missing is 428, stale is 412.

Request Bodyrequired

Sezione intitolata “Request Bodyrequired”
Media typeapplication/json
object
effective_on
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
reason
required
string
>= 1 characters <= 500 characters

Example generated

{
  "effective_on": "2026-04-15",
  "reason": "example"
}

Responses

Sezione intitolata “Responses”

200

Sezione intitolata “200”

OK

Media typeapplication/json

A mooring contract or a transit

object
id
required
string
code
required

ORM-2026-0001, TRN-2026-0001

string
kind
required
string
Allowed values: mooring transit storage charter
term
string
Allowed values: annual seasonal monthly period
number
required
integer format: int64
year
required
integer
status
required

Mooring statuses (draft..suspended) and transit statuses (held..awaiting_approval)

string
Allowed values: draft awaiting_signature active expired renewed terminated cancelled suspended held pending_payment confirmed arrived departed no_show awaiting_approval
customer

The customer embedded in views; display_name only with customers.read

object
id
required
string
display_name
string
billing_customer

The customer embedded in views; display_name only with customers.read

object
id
required
string
display_name
string
vessel
required

The vessel embedded in occupancy and contract views (no registration, no owner)

object
id
required
string
name
required
string
loa_cm
required

Length in integer centimetres

integer format: int64
beam_cm
required

Length in integer centimetres

integer format: int64
hull_type
required
string
Allowed values: monohull_motor monohull_sail catamaran trimaran rib gozzo other
draft_cm

Length in integer centimetres

integer format: int64
starts_on
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
ends_on
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
channel
required
string
Allowed values: desk online api external
quote_id
string
price_list_id
string
total_cents
required

Amount in integer cents of the marina currency

integer format: int64
deposit_cents
required

Amount in integer cents of the marina currency

integer format: int64
engine_version
required
integer
breakdown
object
engine_version
required
integer
price_list_id
required
string
catalog_hash
required
string
contract_type
required
string
Allowed values: annual seasonal monthly transit storage charter
nights
required
integer
lines
required
Array<object>
object
seq
required
integer
kind
required
string
Allowed values: berth service included
item_id
required
string
item_code
required
string
item_type
required
string
Allowed values: berth_fee service utility product labour material fee deposit
revenue_class
string
external_code
string
qty_milli
required
integer format: int64
blocks
required
Array<object>
object
from
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
to
required

Exclusive; may be after the departure (best_combination overshoot)

string format: date
unit
required

Hour, half_day and day (and week) are accepted only on flat base rules of items with revenue class rental (M11, priced by RentalQuote, ignored by the mooring engine)

string
Allowed values: night week month season year stay hour half_day day
nights
required
integer
period
string
rule_id
required
string
base_cents
required
integer format: int64
modifiers
required
Array<object>
object
rule_id
required
string
delta_cents
required
integer format: int64
amount_cents
required
integer format: int64
base_cents
required
integer format: int64
modifier_total_cents
required
integer format: int64
discounts
required
Array<object>
object
rule_id
required
string
delta_cents
required
integer format: int64
amount_cents
required
integer format: int64
rounding_share_cents
required
integer format: int64
gross_cents
required
integer format: int64
net_cents
required
integer format: int64
vat_cents
required
integer format: int64
vat_rate_bp
required
integer format: int64
vat_nature
string
price_includes_vat
required
boolean
service_from
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
service_to
required

Last night (inclusive)

string format: date
subtotal_cents
required
integer format: int64
discount_total_cents
required
integer format: int64
rounding_total_cents
required
integer format: int64
total_cents
required
integer format: int64
net_cents
required
integer format: int64
vat_cents
required
integer format: int64
vat_summary
required
Array<object>
object
vat_rate_bp
required
integer format: int64
vat_nature
string
net_cents
required
integer format: int64
vat_cents
required
integer format: int64
gross_cents
required
integer format: int64
deposit_cents
required
integer format: int64
trace
required
Array<object>
object
code
required

Trace code (pricing/trace.go), shown as pricingEnums:trace.

string
line
required
integer
block
required
integer
rule_id
string
params
object
key
additional properties
string
warnings
required
Array<string>
resolved

What the simulator used after resolving ids; never names or contact data.

object
price_list_id
required
string
price_list_code
required
string
item_id
required
string
loa_cm
integer format: int64
beam_cm
integer format: int64
hull_type
string
Allowed values: monohull_motor monohull_sail catamaran trimaran rib gozzo other
category
string
berth_length_cm
integer format: int64
berth_width_cm
integer format: int64
group_ids
Array<string>
customer_category
string
Allowed values: member resident affiliated charter yard
channel
required
string
Allowed values: desk online api external
quoted_on
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
dimension_origin
required
string
Allowed values: declared measured input none
policy

Versioned contract policy (m3-plan §4.7); unknown keys are rejected

object
version

V1 rows are read as v2 with the defaults (M4)

integer
Allowed values: 1 2
reprice_on_move
boolean
release_policy
string
Allowed values: never with_consent
allow_segments
boolean
payment
object
deposit
One of:

Deposit at signature, a share (bp, half-even) or a fixed amount (at most the total)

object
bp
integer format: int64
<= 10000
cents
integer format: int64
deposit_due_days
integer
<= 365
schedule
object
mode
required
string
Allowed values: fixed_dates interval single
dates
Array<object>
<= 24 items
object
due_on
required

MM-DD (rolled into the contract period) or YYYY-MM-DD

string
<= 10 characters
bp
required
integer format: int64
<= 10000
every_months
integer
>= 1 <= 12
count
integer
>= 1 <= 24
first_due_offset_months
integer
<= 24
due_offset_days
integer
<= 365
issue_days_before_due
integer
<= 365
rounding_unit_cents
integer format: int64
Allowed values: 1 100 1000
early_payment
One of:
object
discount_bp
required
integer format: int64
<= 10000
pay_by_offset_days
required
integer
<= 365
sepa
boolean
renewal
object
tacit
boolean
notice_days
integer
<= 365
cancellation
object
notice_days
integer
<= 365
refund
string
Allowed values: pro_rata none
penalty_bp
integer format: int64
<= 10000
expected_arrival_time

Local time HH:MM in the marina timezone

string
/^([01][0-9]|2[0-3]):[0-5][0-9]$/
expected_departure_time

Local time HH:MM in the marina timezone

string
/^([01][0-9]|2[0-3]):[0-5][0-9]$/
notes
string
hold_lost
required
boolean
hold_expires_at
string format: date-time
activated_at
string format: date-time
signed_on_paper
required
boolean
confirmed_at
string format: date-time
confirmation_source
string
Allowed values: manual provider
confirmation_ref

Only with contracts.write or transits.desk

string
pay_at_departure
required
boolean
cancelled_at
string format: date-time
cancel_reason
string
terminated_on

Calendar date YYYY-MM-DD in the marina timezone

string format: date
terminate_reason
string
signed_at
string format: date-time
signed_document_id
string
signature_request_id
string
suspended_at
string format: date-time
suspend_reason
string
renewed_at
string format: date-time
termination_amount_cents

Refund (negative) or penalty (positive) from the cancellation policy; charged in M5

integer format: int64
installment_plan_version
integer
charter
object
fleet_id
required
string
fleet_name
string
changeover_weekday
required
integer
pricing_mode
required
string
Allowed values: per_berth per_vessel flat
out_nights
required
Array<object>
object
from
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
to
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
berth_id
string
<= 36 characters
renewal_proposal_id

The open renewal proposal of this contract

string
successor_contract_id
string
warnings
Array<string>
Allowed values: insurance_missing transfer_requirements hold_lost berth_unavailable
lines
required
Array<object>
object
id
required
string
seq
required
integer
line_kind
required
string
Allowed values: resource service
item_id
string
resource_type
string
Allowed values: berth dynamic_area land_resource
resource_id
string
resource_code
string
qty_milli
required

Quantity in thousandths (1.5 = 1500)

integer format: int64
amount_cents
required

Amount in integer cents of the marina currency

integer format: int64
allocations
required
Array<object>
object
id
required
string
contract_line_id
string
contract_id
string
vessel_id
string
resource_type
required
string
Allowed values: berth dynamic_area land_resource
resource_id
required
string
resource_code
string
map_id
required
string
x_cm

Length in integer centimetres

integer format: int64
y_cm

Length in integer centimetres

integer format: int64
rotation_dd

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

integer format: int64
<= 3599
first_night
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
last_night
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
kind
required
string
Allowed values: hold contract transit owner block maintenance
status
required
string
Allowed values: active cancelled expired superseded
expires_at
string format: date-time
fit_override
object
user_id
required
string
reason
required
string
codes
required
Array<string>
block_reason
string
moved_from_id
string
released
required
Array<object>

Inclusive range of nights

object
from
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
to
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
version
required
integer
releases
required
Array<object>
object
id
required
string
allocation_id
required
string
contract_id
required
string
resource_type
required
string
Allowed values: berth dynamic_area land_resource
resource_id
required
string
resource_code
string
from_night
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
to_night
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
status
required
string
Allowed values: active revoked
source
required
string
Allowed values: customer_phone customer_desk customer_link dock office system
resold_allocation_id
string
resold_nights
required
integer
credit_cents
required

Amount in integer cents of the marina currency

integer format: int64
notes

Only with customers.read

string
created_at
required
string format: date-time
revoked_at
string format: date-time
version
required
integer
presences
required
Array<object>
object
id
required
string
vessel
required

The vessel embedded in occupancy and contract views (no registration, no owner)

object
id
required
string
name
required
string
loa_cm
required

Length in integer centimetres

integer format: int64
beam_cm
required

Length in integer centimetres

integer format: int64
hull_type
required
string
Allowed values: monohull_motor monohull_sail catamaran trimaran rib gozzo other
draft_cm

Length in integer centimetres

integer format: int64
allocation_id
string
contract_id
string
event
required
string
Allowed values: arrived departed hauled_out launched
at
required
string format: date-time
night
required

Calendar date YYYY-MM-DD in the marina timezone

string format: date
source
required
string
Allowed values: staff sensor customer
user_id
string
notes

Only with customers.read

string
has_photo
required
boolean
created_at
required
string format: date-time
version
required
integer

Example 

{
  "kind": "mooring",
  "term": "annual",
  "status": "draft",
  "vessel": {
    "hull_type": "monohull_motor"
  },
  "channel": "desk",
  "breakdown": {
    "contract_type": "annual",
    "lines": [
      {
        "kind": "berth",
        "item_type": "berth_fee",
        "blocks": [
          {
            "unit": "night"
          }
        ]
      }
    ],
    "resolved": {
      "hull_type": "monohull_motor",
      "customer_category": "member",
      "channel": "desk",
      "dimension_origin": "declared"
    }
  },
  "policy": {
    "version": 1,
    "release_policy": "never",
    "payment": {
      "schedule": {
        "mode": "fixed_dates"
      },
      "rounding_unit_cents": 1
    },
    "cancellation": {
      "refund": "pro_rata"
    }
  },
  "confirmation_source": "manual",
  "charter": {
    "pricing_mode": "per_berth"
  },
  "warnings": [
    "insurance_missing"
  ],
  "lines": [
    {
      "line_kind": "resource",
      "resource_type": "berth"
    }
  ],
  "allocations": [
    {
      "resource_type": "berth",
      "kind": "hold",
      "status": "active"
    }
  ],
  "releases": [
    {
      "resource_type": "berth",
      "status": "active",
      "source": "customer_phone"
    }
  ],
  "presences": [
    {
      "vessel": {
        "hull_type": "monohull_motor"
      },
      "event": "arrived",
      "source": "staff"
    }
  ]
}

Headers

Sezione intitolata “Headers”
ETag
string

Version of the resource, quoted (“3”)

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

409

Sezione intitolata “409”

Conflict with the current state

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

412

Sezione intitolata “412”

If-Match does not match the current version

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

428

Sezione intitolata “428”

If-Match is required

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.