This method allows you to add announcements on a schedule.
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: POST
Headers
- Accept: application/json
- Content-type: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Json request body example
{
"carrier_id": 1013865,
"date_from": "2023-07-14T08:00:00",
"date_to": "2023-07-14T10:00:00",
"ramp_id": 2006,
"warehouse_id": 1567,
"operation_type": "unloading",
"vehicle": {
"truck_plate_number": "123string",
"trailer_plate_number": "456string",
"vehicle_manufacturer": "SCANIA",
"combustion_norm": "EURO 6"
},
"driver": {
"full_name": "Jan Kowalski",
"phone_number": "+48888123456",
"country": "PL",
"languages": [
"Polish"
],
"first_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
},
"second_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
}
},
"second_driver": {
"full_name": "Jan Kowalski",
"phone_number": "+48888123456",
"country": "PL",
"languages": [
"Polish"
],
"first_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
},
"second_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
}
},
"remark": "Example note",
"remark_internal": "Example internal note"
}Json response example
{
"arrival_delay": null,
"attachments": null,
"cargo": null,
"carrier": {
"address": {
"country": "PL",
"locality": "Tcfwuroyni",
"postal_code": "53-604",
"street": "Kelkcvuw 93",
"street_address": "Kelkcvuw 93"
},
"email": "bdemczyszak@trans.eu",
"id": 1013865,
"legal_name": "Firma Testowa Przewoźnik IIT 2",
"subcontractor": null,
"telephone": "(0048) 633833929",
"type": "REGISTERED"
},
"date_from": "2023-07-14T08:00:00",
"date_to": "2023-07-14T10:00:00",
"driver": {
"country": "pl",
"first_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
},
"full_name": "Jan Kowalski",
"languages": [
"Polish"
],
"phone_number": "+48888123456",
"second_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
}
},
"id": 38602,
"notes": null,
"operation_time": "PT2H",
"operation_type": "unloading",
"ramp": {
"id": 2006,
"is_active": true,
"is_locked": false,
"name": "Suwnica A 1",
"operation_type": "unloading",
"ramp_type": "GANTRY",
"warehouse": {
"address": {
"coordinates": {
"latitude": 50,
"longitude": 21
},
"country": "pl",
"id": 1705,
"locality": "Wielogłowy",
"name": "Magazyn Stali",
"number": "153",
"postal_code": "33-311",
"remarks": null,
"street": "Wielogłowy"
},
"configurations": [
{
"id": 1812,
"quantity_of_slots": 3,
"slot": 15,
"valid_from": "2018-11-10",
"valid_until": null
}
],
"id": 1567,
"is_active": true,
"is_locked": false,
"name": "Magazyn Stali",
"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": "+02:00",
"offset_minutes": 120
}
}
},
"reference_number": "DS/16365BE/1",
"route": {
"spots": [
{
"address": {
"coordinates": {
"latitude": 50,
"longitude": 21
},
"country": "pl",
"locality": "Wielogłowy",
"name": "Magazyn Stali",
"number": "153",
"postal_code": "33-311",
"street": "Wielogłowy"
},
"operations": [
{
"operation_type": "unloading",
"order": 1,
"time_window_id": null
}
],
"order": 1
}
]
},
"second_driver": {
"country": "pl",
"first_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
},
"full_name": "Jan Kowalski",
"languages": [
"Polish"
],
"phone_number": "+48888123456",
"second_document": {
"issuing_authority": "string",
"number": "string",
"type": "IDENTITY_CARD"
}
},
"shipper": {
"address": {
"country": "PL",
"locality": "Vhqwtwrqgi",
"postal_code": "74-507",
"street": "Orfaliko 03",
"street_address": "Orfaliko 03"
},
"email": "bde@trans.eu",
"id": 1007386,
"legal_name": "Firma Testowa Załadowca IIT",
"telephone": "(0048) 660490583"
},
"stage": null,
"status": "CONFIRMED",
"time_window": null,
"vehicle": {
"combustion_norm": "EURO 6",
"trailer_plate_number": "456string",
"truck_plate_number": "123string",
"vehicle_manufacturer": "SCANIA",
"weight": null
}
}