oTMS provides Web Service interfaces in both production and testing environments, where the testing environment is primarily used for integration testing. In both environments, API account credentials must be assigned by the oTMS system administrator before they can be used.
Please use the public interfaces reasonably. If abnormal calls or any issues affecting system performance are detected, we will impose restrictions on the API account calls, or even deactivate them.
Currently, the call limit for this interface is set to a maximum of 10 requests per second per company.
Request
Header Params
Authorization
string
optional
Basic Authorization. If not empty, this value will be used for authentication. Otherwise, the username and password in the request message will be used.
Default:
Body Params application/xml
version
string
optional
Version number of the request
login
string
optional
Username. Used for API caller authentication. If the Authorization header is not empty, this value will be ignored.
password
string
optional
Password. Used for API caller authentication. If the Authorization header is not empty, this value will be ignored.
jobSheets
array[object (JobSheetAssignment) {6}]
optional
List of job sheets to assign drivers. The maximum number of assignments per request is 100.
sequence
integer<int32>
required
Sequence number
jobSheetNumber
string
optional
Job sheet number
externalShipmentId
string
optional
External shipment ID
truckPlate
string
optional
Truck plate number
driverMobile
string
optional
Driver's mobile phone number
ignoreOrderMatch
boolean
optional
Whether to ignore whether the vehicle type matches the order. Default is false.
Default:
false
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><jobSheetAssignmentRequestversion="0.1"login="login"password="password"><jobSheets><jobSheetsequence="1"><jobSheetNumber>JSVIAOCIBJ000015</jobSheetNumber>/////The order needs to include loading information
<externalShipmentId></externalShipmentId><truckPlate>N12041</truckPlate><driverMobile>+622412041</driverMobile></jobSheet></jobSheets></jobSheetAssignmentRequest>
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request PUT 'https://login.otms.com/ws/jobsheet/driver' \
--header'Authorization;' \
--header'Content-Type: application/xml' \
--data-raw'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobSheetAssignmentRequest version="0.1" login="login" password="password">
<jobSheets>
<jobSheet sequence="1">
<jobSheetNumber>JSVIAOCIBJ000015</jobSheetNumber>/////The order needs to include loading information
<externalShipmentId></externalShipmentId>
<truckPlate>N12041</truckPlate>
<driverMobile>+622412041</driverMobile>
</jobSheet>
</jobSheets>
</jobSheetAssignmentRequest>'
Responses
🟢200成功
application/xml
Successful operation
Body
version
string
required
Response version number
responseCode
string
optional
Global feedback code
jobSheets
array[object (JobSheetAssignmentResult) {6}]
optional
Detailed information about job sheet assignment results