Skip to main content

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.


HTTP POST Request

Request TypeExample URL
POST{{url_base}}/PostEnableLinkBetweenTransporterDriver
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostEnableLinkBetweenTransporterDriver"

Input Parameters

ParameterTypeRequiredDescription
TransporterNoString(25)YesExternal code of the transporter
DriverNoString(25)YesExternal code of the driver

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard WebService response information in method execution
TransporterDriverCodeIntegerYesInternal 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.


HTTP POST Request

Request TypeExample URL
POST{{url_base}}/PostDisableAllLinksBetweenTransporterDriver
Examplehttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDisableAllLinksBetweenTransporterDriver"

Input Parameters

ParameterTypeRequiredDescription
TransporterNoString(25)NoExternal code of the Transporter
DriverNoString(25)NoExternal code of the Driver
Note
  • At least one of the parameters must be provided: TransporterNo or DriverNo
warning

The method behavior varies according to the provided parameters:

  • If only the DriverNo parameter is provided, all transporter x driver links related to this driver will be deactivated.
  • If only the TransporterNo parameter is provided, all transporter x driver links related to this transporter will be deactivated.
  • If both are provided (DriverNo and TransporterNo), only the specific link between them will be deactivated.

Return

ParameterTypeRequiredDescription
WebServiceReturnWebServiceReturnYesStandard 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

CodeMessage
DAL‑001The "TransporterNo" parameter and the "DriverNo" parameter were not provided. Provide at least one!