This method allows you to download a list of announcements.
Authorization and access
Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/dock-scheduler-api/v1/announcement
- Http Method: GET
Headers
- Accept: application/json
- Content-type: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Available filters
Important for shipper role! To get the announcement list, at least warehouse filter has to be used.
List of available filters
- warehouse ids (?filter={“warehouse_ids”: [10]})
- carrier ids (?filter={“carrier_ids”: [1234,1235]})
- shipper ids ( ?filter={“shipper_ids”: [1234,1235]})
- date from (?filter={“date_from”: “2022-03-01”})
- date to (?filter={“date_to”: “2022-03-31”})
- order reference number (?filter={“order”: {“reference_number”: “2022/01/25/9”}})
- time window reference number (?filter={“time_window”: {“reference_number”:”DS/21A645″}})
- freight reference number (?filter={“freight”: {“reference_number”: “FR/2022/09/28/L1D2”}})
- time window external number (?filter={“time_window”: {“external_number”: “1a2b3c”}})
- announcement reference number (?filter={“reference_number”: “DS/21A645/1”})
- stages (?filter={“statuses”: [“LOADING_REFUSED”]}) all available stages can be found here
Example of combined filter: ?filter={“warehouse_ids”:[10],”carrier_ids”: [1234]}
Paging
When calling GET method, page should be added as parameter in the URL, for example:
https://api.platform.trans.eu/ext/dock-scheduler-api/v1/announcement?filter={“warehouse_ids”: [10]}&page=2
Json response example
{
"content": [
{
"arrival_delay": null,
"carrier": {
"id": 10111111,
"legal_name": "Firma Testowa Przewoźnik",
"subcontractor": null,
"type": "REGISTERED"
},
"date_from": "2022-01-26T09:30:00",
"date_to": "2022-01-26T10:00:00",
"driver": {
"document": {
"issuing_authority": "Wojewoda",
"number": "31`123",
"type": "IDENTITY_CARD"
},
"full_name": "Jan Testowy",
"phone_number": "111222333"
},
"id": 5532,
"notes": null,
"operation_type": "LOADING",
"order_reference_number": "2022/01/25/9",
"ramp": {
"id": 3226,
"is_active": true,
"is_locked": false,
"name": "Rampa 1",
"warehouse": {
"address": {
"id": 2529,
"locality": "Wrocław",
"name": "Opolska"
},
"id": 2391,
"is_active": true,
"is_locked": false,
"name": "Opolska",
"time_zone": {
"id": "Europe/Warsaw",
"offset": "+01:00",
"offset_minutes": 60
}
}
},
"reference_number": "DS/21A645/1",
"remarks": null,
"route": {
"loading_place": {
"country": "pl",
"locality": "Wrocław",
"name": "Opolska",
"number": "26",
"postal_code": "11-200",
"street": "Opolska"
},
"unloading_place": {
"country": "pl",
"locality": "Wrocław",
"name": "Magazyn Test",
"number": "2-4",
"postal_code": "53-146",
"street": "Racławicka"
}
},
"shipper": {
"id": 100222,
"legal_name": "Firma Testowa Załadowca"
},
"stage": "NO_VEHICLE",
"status": "FINISHED",
"template": {
"id": 106,
"name": "templatka"
},
"time_window": {
"external_number": "1a2b3c",
"id": 9425,
"reference_number": "DS/21A645"
},
"vehicle": {
"trailer_plate_number": "11111a",
"truck_plate_number": "24312"
}
}
],
"page": 1,
"page_count": 1,
"page_size": 1,
"templates": [
{
"id": 1,
"parameters": [
{
"default_value": null,
"group": "DRIVER",
"is_mandatory": false,
"name": "DRIVER_PHONE_NUMBER"
},
{
"default_value": null,
"group": "VEHICLE",
"is_mandatory": false,
"name": "TRAILER_PLATE_NUMBER"
},
{
"default_value": null,
"group": "DRIVER",
"is_mandatory": false,
"name": "DRIVER_NAME"
},
{
"default_value": null,
"group": "VEHICLE",
"is_mandatory": true,
"name": "TRUCK_PLATE_NUMBER"
},
{
"default_value": null,
"group": "DRIVER",
"is_mandatory": false,
"name": "DRIVER_DOCUMENT_TYPE_AND_NUMBER"
},
{
"default_value": null,
"group": "OTHER",
"is_mandatory": false,
"name": "REMARKS"
}
]
}
],
"total_items": 1
}