go back to CarrierDispatchService

POST /carrierDispatch/lockMovement/{movementId}

Request a lock to be placed on the specified move. If successful, a lock will be placed on the movement for the time period specified in the dispatch control file field "lock_clock_minutes".

Roles that can access this endpoint are Users.

Parameters

name description type default type
movementId ID of the movement to be locked path String

Result

Response of type: text/plain

a response containing the success or failure message of the lock

Try It Out

Request

- Authentication Help
- String