Skip to content

GET /tms/loading-planner/step1-availability

TMS > tms.transload

What it does

/tms/loading-planner/step1-availability accepts GET and is declared in app/systems/TMS/transload/api_routes.php:375 as a path.

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

Call chain:

  1. → tmsTransloadApiLoadingPlannerStep1Availability() — app/systems/TMS/transload/planning_query_api_helper.php:328
  2. ↳ loading_booking_number_list() — app/systems/TMS/delivery/query_helper.php:732
  3. ↳ ctcCommodityBookingMatchesInbound() — app/shared/commodity_compatibility_helper.php:63

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

No named input key is visible in the handler or its owner function. The endpoint either takes no parameters or reads them through a shared helper in app/shared/api/.

Output

Key
DOMESTIC_EQUIPMENT_COUNT
TRANSLOAD_CONTAINER_COUNT
UNLOAD_SPARE_QUANTITY

Success is { "data": …, "requestId": "…" }. Failure is { "error": { "code", "message" }, "requestId": "…" }.

SQL executed

SELECT BILLING_COMPANY_ID, INITIAL_COMMODITY_NAME, PO_NUMBER FROM T_TRANSLOAD WHERE CLIENT_ID=? AND ID=? AND DELETED_AT IS NULL LIMIT 1

Data

Tables reached from the owner function:

  • T_TRANSLOAD

Access

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

Validation and failure messages

  • Transload not found.

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.