Skip to content

GET /tms/equipment-loads/(?P\d+)/return-booking-options

TMS > tms.delivery

What it does

#^/tms/equipment-loads/(?P<id>\d+)/return-booking-options$# accepts GET and is declared in app/systems/TMS/delivery/api_routes.php:2196 as a regex pattern.

The route handler delegates to tmsDeliveryApiReturnBookingOptions(). That function is the owner of this behaviour; the route entry is only dispatch.

Call chain:

  1. → tmsDeliveryApiReturnBookingOptions() — app/systems/TMS/delivery/api_routes.php:823
  2. ↳ tmsDeliveryApiHasOfficeAccess() — app/systems/TMS/delivery/api_routes.php:956
  3. ↳ isSuperAdmin() — config/config.php:1477

Who calls it

No literal caller path was found in frontend/, public/ or new-system/. The endpoint may be called through a constructed path, a helper wrapper, or only by an external client. Treat the route table and owner function as the authority.

Input

Where Key
path id

Request bodies must not use TYPE, ACTION or USERNAME as contract fields.

Output

The response is produced by a shared helper, so the key set is not visible at the route. Read the owner function to confirm the shape before writing a client.

SQL executed

SELECT EQL.ID AS EQUIPMENT_LOAD_ID,

SELECT BK.ID,

Data

Tables reached from the owner function:

  • T_BOOKING
  • T_COMPANY
  • T_EQUIPMENT
  • T_EQUIPMENT_LOAD

Access

  • module-gated on tms.delivery, so tenant module access applies

Validation and failure messages

  • Office access is required to load return bookings.
  • Equipment load id is required.
  • Equipment load row not found.
  • Current container customer is required to select return booking.

These strings come from the owner function and are the messages a client can receive. They are also the cheapest way to tell a rejected request from a broken one.