Get announcement by ID

This method allows you to down­load details of announce­ment by ID

Authorization and access

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

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/dock-scheduler-api/v1/announcement/{announcementID}
  • Http Method: GET

Headers

  • Accept: application/json
  • Con­tent-type: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Json example request

curl --location 'https://api.platform.trans.eu/ext/dock-scheduler-api/v1/announcement/197883' \

Json response example

{
    "arrival_delay": 0,
    "attachments": null,
    "cargo": null,
    "carrier": {
        "address": {
            "country": "PL",
            "locality": "Oleśnica",
            "postal_code": "53-604",
            "street": "Kucyków 93"
        },
        "email": "bdemczyszak@trans.eu",
        "id": 1013865,
        "legal_name": "Firma Testowa Przewoźnik IIT 2",
        "telephone": "(0048) 633833929",
        "type": "REGISTERED"
    },
    "date_from": "2024-11-18T15:00:00",
    "date_to": "2024-11-18T16:00:00",
    "driver": {
        "country": null,
        "documents": [
            {
                "issuing_authority": null,
                "number": "nrdowodu",
                "type": "IDENTITY_CARD"
            }
        ],
        "first_document": {
            "issuing_authority": null,
            "number": "nrdowodu",
            "type": "IDENTITY_CARD"
        },
        "full_name": "Stasia Stanisławska",
        "languages": [],
        "phone_number": "45645151",
        "second_document": null
    },
    "external_reference_number": null,
    "forward": null,
    "forward_permissions": {
        "allow": true,
        "disallow": null,
        "require_carrier_data": false
    },
    "freight_order": null,
    "id": 81567,
    "notes": [
        {
            "id": 26504,
            "note": "notatka zaladowcy",
            "type": "SHIPPER"
        },
        {
            "id": 26505,
            "note": "wewnetrzna",
            "type": "SHIPPER_INTERNAL"
        }
    ],
    "operation_time": "PT1H",
    "operation_type": "loading",
    "ramp": {
        "id": 3222,
        "is_active": true,
        "is_locked": false,
        "name": "Rampa 2",
        "operation_type": "any",
        "ramp_type": "RAMP",
        "warehouse": {
            "address": {
                "coordinates": {
                    "latitude": 90,
                    "longitude": 999
                },
                "country": "pl",
                "id": 29,
                "locality": "Warszawa",
                "number": "12",
                "postal_code": "00-950",
                "remarks": null,
                "street": "Nowa"
            },
            "configurations": [
                {
                    "id": 274,
                    "quantity_of_slots": 3,
                    "slot": 15,
                    "valid_from": "2018-11-10",
                    "valid_until": null
                }
            ],
            "id": 29,
            "is_active": true,
            "is_locked": false,
            "name": "Magazyn_jeden",
            "operation_type": "any",
            "quantity_of_slots": 3,
            "rules_file_id": null,
            "rules_file_name": null,
            "rules_file_original_name": null,
            "slot": 15,
            "time_zone": {
                "id": "Europe/Warsaw",
                "offset": "+01:00",
                "offset_minutes": 60
            }
        }
    },
    "reason_for_refusing_to_load": "fffc",
    "reference_number": "DS/1759052/1",
    "route": {
        "spots": [
            {
                "address": {
                    "coordinates": {
                        "latitude": 90,
                        "longitude": 999
                    },
                    "country": "pl",
                    "description": null,
                    "locality": "Warszawa",
                    "name": "Magazyn_jeden",
                    "number": "12",
                    "postal_code": "00-950",
                    "street": "Nowa"
                },
                "operations": [
                    {
                        "operation_type": "loading",
                        "order": 1,
                        "time_window_id": null
                    }
                ],
                "order": 1
            }
        ]
    },
    "second_driver": {
        "country": null,
        "documents": [
            {
                "issuing_authority": null,
                "number": "ndjfnh45252",
                "type": "DRIVING_LICENSE"
            }
        ],
        "first_document": {
            "issuing_authority": null,
            "number": "ndjfnh45252",
            "type": "DRIVING_LICENSE"
        },
        "full_name": "drugikiero",
        "languages": [],
        "phone_number": "789558",
        "second_document": null
    },
    "shipper": {
        "address": {
            "country": "PL",
            "locality": "Vhqwtwrqgi",
            "postal_code": "74-507",
            "street": "Orfaliko 03"
        },
        "email": "bdemczyszak@trans.eu",
        "id": 1007386,
        "legal_name": "Firma Testowa Załadowca IIT",
        "telephone": "(0048) 660490583"
    },
    "stage": "REFUSED",
    "status": "FINISHED",
    "template_parameters": [
        {
            "default_value": null,
            "group": "VEHICLE",
            "is_mandatory": true,
            "name": "TRUCK_PLATE_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": "DRIVER",
            "is_mandatory": false,
            "name": "DRIVER_PHONE_NUMBER"
        },
        {
            "default_value": null,
            "group": "DRIVER",
            "is_mandatory": false,
            "name": "DRIVER_DOCUMENT_TYPE_AND_NUMBER"
        },
        {
            "default_value": null,
            "group": "OTHER",
            "is_mandatory": false,
            "name": "SHIPPER_NOTE"
        },
        {
            "default_value": null,
            "group": "OTHER",
            "is_mandatory": false,
            "name": "CARRIER_NOTE"
        },
        {
            "default_value": null,
            "group": "ATTACHMENT",
            "is_mandatory": false,
            "name": "SHIPPER_ATTACHMENT"
        },
        {
            "default_value": null,
            "group": "ATTACHMENT",
            "is_mandatory": false,
            "name": "CARRIER_ATTACHMENT"
        }
    ],
    "time_window": null,
    "trans_task": null,
    "transport": null,
    "vehicle": {
        "combustion_norm": null,
        "trailer_plate_number": "naczepa",
        "truck_plate_number": "pojazd",
        "vehicle_manufacturer": null,
        "weight": null
    }
}