Getting information about Transports in realization

Assumptions of the functions of Transports in realization

On the plat­form trans.eu mod­ule “Trans­ports in real­iza­tion” is a place where you will find all infor­ma­tion about trans­port tasks that have been cre­at­ed, car­ried out, com­plet­ed and archived. The func­tion via API works sim­i­lar­ly. Trans­port tasks are part of an accept­ed trans­port order. One trans­port order can con­tain one or more trans­ports car­ried out.

URL parameters and connection settings

• URL: https://api.platform.trans.eu
• End­point: /ex­t/­trans­ports-api/v1/­trans­ports
• Method: GET

Headers:

• Con­tent type: app/json
• Accept: application/json
• Autho­riza­tion: bear­er {access_token}
• API Key: {unique_app_api_key}

Authorization

The autho­riza­tion process is described here. Each API request must also con­sist of a unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Endpoint operation description

End­point is used to get a list of trans­ports being in real­iza­tion.

Getting list of transport tasks

After query­ing the end­point below, we will receive a list of trans­ports in response

/ext/transports-api/v1/transports

The trans­port list con­tains all the details also avail­able when query­ing using the ID

Sample query using filter

GET 
https://api.platform.trans.eu/ext/transports-api/v1/transports?filter={"states":["new","active","completed","archived"]}

Filters available when getting list of transport tasks

fil­ter­ing by trans­port order iden­ti­fi­er

?filter={"order_id":"f68db929-4667-44c6-9496-6bb654cfa500"}

A trans­port order is relat­ed to trans­port tasks, the Uni­ver­sal­ly Unique Iden­ti­fi­er (UUID) of the trans­port order helps to find trans­ports for a giv­en order. A trans­port order can con­tain one or more trans­ports.

Filtering by role in transport

?filter={"role":"shipper"}

The avail­able val­ues ​​for role selec­tion are:

• ship­per, 
• car­ri­er, 
• spec­ta­tor

Filtering by transport status

?filter={"statuses":["1_awaiting_operation_dates","2_awaiting_required_information_for_transport_execution"]}

Avail­able val­ues ​​when select­ing sta­tus are:

• 1_awaiting_operation_dates, 
• 2_awaiting_required_information_for_transport_execution, 
• 3_ready, 
• 4_awaiting_confirmation_of_arrival_for_loading, 
• 5_awaiting_confirmation_of_loading, 
• 6_en_route, 7_awaiting_confirmation_of_arrival_for_unloading, 
• 8_awaiting_confirmation_of_unloading, 
• 9_finished, 
• 10_task_cancelled”

Filtering by vehicle monitoring status on the route

?filter={"states":["new","active"]} 

Avail­able val­ues ​​when select­ing sta­tus are:

• new, 
• active, 
• com­plet­ed, 
• archived