This method allows you to update all data in announcement.
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/{annoucementID}
- Http Method: PATCH
Headers
- Accept: application/json
- Content-type: application/json
- Authorization: Bearer {access_token}
- Api-key: {unique_app_api-key}
Json request body example
{
"date_from": "2024-10-01T15:00:00",
"ramp": {
"id": 3222
},
"carrier": {
"id": 1013865
},
"time_window": null,
"vehicle": {
"truck_plate_number": "pojazd",
"trailer_plate_number": "naczepa",
"vehicle_manufacturer": null,
"combustion_norm": null
},
"driver": {
"country": null,
"languages": [],
"full_name": "basia stasia",
"phone_number": "45645151",
"first_document": {
"type": "IDENTITY_CARD",
"number": "nrdowodu",
"issuing_authority": null
},
"second_document": null
},
"second_driver": {
"country": null,
"languages": [],
"full_name": "drugikiero",
"phone_number": "789558",
"first_document": {
"type": "DRIVING_LICENSE",
"number": "ndjfnh45252",
"issuing_authority": null
},
"second_document": null
},
"notes": [
{
"note": "notatka zaladowcy",
"type": "SHIPPER"
},
{
"note": "wewnetrzna",
"type": "SHIPPER_INTERNAL"
}
],
"stage": "Vehicle_Arrived",
"operation_type": "loading",
"operation_time": "PT1H0M"
}The “stage” field can take the following values:
- Vehicle_Arrived
- Started
- Finished
- Vehicle_Left
Json response example
{
"arrival_delay": null,
"attachments": null,
"cargo": null,
"carrier": {
"address": {
"country": "PL",
"locality": "Tcfwuroyni",
"postal_code": "53-604",
"street": "Kelkcvuw 93"
},
"email": "bdemczyszak@trans.eu",
"id": 1013865,
"legal_name": "Firma Testowa Przewoźnik IIT 2",
"telephone": "(0048) 633833929",
"type": "REGISTERED"
},
"date_from": "2024-10-01T15:00:00",
"date_to": "2024-10-01T16:00:00",
"driver": {
"country": null,
"first_document": {
"issuing_authority": null,
"number": "nrdowodu",
"type": "IDENTITY_CARD"
},
"full_name": "basia stasia",
"languages": [],
"phone_number": "45645151",
"second_document": null
},
"external_reference_number": null,
"forward": null,
"forward_permissions": {
"allow": true,
"disallow": null,
"require_carrier_data": false
},
"id": 77827,
"notes": [
{
"id": 25593,
"note": "notatka zaladowcy",
"type": "SHIPPER"
},
{
"id": 25594,
"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": "+02:00",
"offset_minutes": 120
}
}
},
"reference_number": "DS/E8CB095/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,
"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": null,
"status": "CONFIRMED",
"time_window": null,
"transport": null,
"vehicle": {
"combustion_norm": null,
"trailer_plate_number": "naczepa",
"truck_plate_number": "pojazd",
"vehicle_manufacturer": null,
"weight": null
}
}