Transporter x Driver Link
The PostEnableLinkBetweenTransporterDriver endpoint is responsible for registering or activating the link between a Transporter and a Driver in the MIMS system and can be viewed on screen CAD145.
How to register link between Transporter x Driver
HTTP POST Request
| Request Type | Example URL |
|---|---|
| POST | {{url_base}}/PostEnableLinkBetweenTransporterDriver |
| Example | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostEnableLinkBetweenTransporterDriver" |
Input Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransporterNo | String(25) | Yes | External code of the transporter |
| DriverNo | String(25) | Yes | External code of the driver |
Return
| Parameter | Type | Required | Description |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Yes | Standard WebService response information in method execution |
| TransporterDriverCode | Integer | Yes | Internal link code between Transporter x Driver generated in the MIMS system |
Request Example
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostEnableLinkBetweenTransporterDriver"' \
--header 'Content-Type: application/json' \
--data '{
"TransporterNo": "TRANS123",
"DriverNo": "DRV456"
}'
Response Example
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"TransporterDriverCode": 789
}
Disable Transporter x Driver Links
The PostDisableAllLinksBetweenTransporterDriver endpoint is responsible for disabling links between a Transporter and a Driver in the MIMS system.
How to disable link between Transporter x Driver
HTTP POST Request
| Request Type | Example URL |
|---|---|
| POST | {{url_base}}/PostDisableAllLinksBetweenTransporterDriver |
| Example | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDisableAllLinksBetweenTransporterDriver" |
Input Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransporterNo | String(25) | No | External code of the Transporter |
| DriverNo | String(25) | No | External code of the Driver |
Note
- At least one of the parameters must be provided:
TransporterNoorDriverNo
warning
The method behavior varies according to the provided parameters:
- If only the
DriverNoparameter is provided, all transporter x driver links related to this driver will be deactivated. - If only the
TransporterNoparameter is provided, all transporter x driver links related to this transporter will be deactivated. - If both are provided (
DriverNoandTransporterNo), only the specific link between them will be deactivated.
Return
| Parameter | Type | Required | Description |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Yes | Standard WebService response information in method execution |
Request Example
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDisableAllLinksBetweenTransporterDriver"' \
--header 'Content-Type: application/json' \
--data '{
"TransporterNo": "TRANS123",
"DriverNo": "DRV456"
}'
Response Example
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Possible Errors
| Code | Message |
|---|---|
| DAL‑001 | The "TransporterNo" parameter and the "DriverNo" parameter were not provided. Provide at least one! |