Skip to content

PATCH /tms/loading-planner/(?P\d+)

TMS > tms.transload

What it does

#^/tms/loading-planner/(?P<id>\d+)$# accepts PATCH and is declared in app/systems/TMS/transload/api_routes.php:533 as a regex pattern.

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

Call chain:

  1. → tmsTransloadApiLoadingPlannerUpdate() — app/systems/TMS/transload/planning_command_api_helper.php:93
  2. ↳ tmsTransloadApiLoadingPlannerRow() — app/systems/TMS/transload/planning_query_api_helper.php:372
  3. ↳ array_uppercase() — app/shared/controller/common_post_helper.php:177

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

Key
ID

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

SQL executed

SELECT STATUS FROM T_TRANSLOAD WHERE CLIENT_ID=? AND ID=? AND DELETED_AT IS NULL LIMIT 1

SELECT UNLOADING_EQUIPMENT_LOAD_ID, DOCK_IN_PLAN, LOADER_NAME

Data

Tables reached from the owner function:

  • T_LOADING_PLANNER
  • T_TRANSLOAD

Access

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

Validation and failure messages

  • Planner id is required.
  • Planner payload is required.

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.