Skip to main content

Dokumentation

Version 91

Änderungen seit der letzten Version

  Änderungen an der API:
  • CreateOrUpdateOfferRequest
    • Neues Feld OfferTypeId hinzugefügt. Hier kann eine OrderTypeID aus der Datenbank Tabelle order_types gefüllt werden. Diese wird dann in das Erstellte Angebot als Angebotstyp übernommen und bei der Auftragserstellung automatisch in den Auftragstyp übernommen.
    • Die Beschreibung des Felds OffererAddressId korrigiert um die bestehende Logik besser abzubilden.
    • Der Inhalt des Feldes TotalKm wird ab jetzt auch in Container Angebote (Kalkulationen) übernommen und entsprechend bei der Auftragserstellung in den Auftrag übernommen.
  • AmendAccountingBlockRequest
    • In der Dokumentation wurde die Nullability der Felder PaymentTargetId und BillingCategoryId korrigiert.
  • Endpunkt /Offer/CreateOrderFromOffer
    • Beim Erzeugen einer neuen Angebots-Revision werden die bestehenden Abrechnungsblöcke der vorherigen Revision komplett in die neuste Revision verschoben.
    • Bei erfolgreicher Durchführung steht ab jetzt die OrderID des erzeugten Auftrags in den ProcessMessages des ClientFeedback JSON.
  • /Offer/ContainerCalculation/CreateOrderFromOffer
    • Bei erfolgreicher Durchführung steht ab jetzt eine Nachricht mit der erzeugten Auftragsnummer in der Message des ClientFeedback JSON. (Äquivalent zu /Offer/CreateOrderFromOffer)

Senden von HTTP-Requests



Bemerkung
Basisadressehttps://{cs_Server_Adresse}:{cs_Server_Https_Port}/api/V1

Die Einstellungen für cs_Server_Https_Port (HttpsPort) ist in folgender Datei zu finden: ...\Server\config\appserver.config

Auf dem Windows Server der den cs Appserver hosted muss ein SSL Zertifikat hinterlegt sein und

einmalig folgender Befehl über die Windows Powershell ausgeführt werden um das Zertifikat mit dem Appserver zu verknüpfen:


(Ohne Zeilenumbrüche oder spitze Klammern <>)

POWERSHELL
netsh http add sslcert
ipport=0.0.0.0:<HIER_HTTPS_PORT_EINTRAGEN>
certhash=<HIER_FINGERABDRUCK_DES_SSL_ZERTIFIKATS_EINTRAGEN>
appid='{4753beb9-2f03-4fe9-81e9-923cbe7a841d}'
AuthorizationBasic Auth

Format : https://en.wikipedia.org/wiki/Basic_access_authentication

Username: ein gültiger cargo support Benutzer Login

Passwort: das dazugehörige cargo support Benutzer Passwort

Headers


Authorization

Content-Type

Content-Length

Host

Accept

User-Agent

Beipiel:

Basic QmVudXR6ZXI6UGFzc3dvcnQ=

application/json

<sollte von den meisten REST Clients automatisch erstellt werden>

<sollte von den meisten REST Clients automatisch erstellt werden>

*/*

ExampleApplication/V1.2.3

MethodePOSTFür alle Requests der API ist die Post Methode zu verwenden.
Bodyapplication/jsonJeder Request nimmt einen JSON Body entgegen. Dieser enthält jeweils die für den Request spezifischen Parameter.
Response*/* 

Standardmäßig sind Antworten und Fehlermeldungen der API im JSON Format.

Technische Ausnahmefehler werden im HTML Format zurückgemeldet.

Lesender Zugriff

Endpunkte

Adressecargo support EntitätBemerkungJSON
/Accounting/PaymentTargetsZahlungsziel
DataRequest
/Address/DocumentDokument (Adresse)Download einer in cargo support archivierten Datei. DocumentRequest
/Address/DocumentMetadataDokumenten-Metadaten (Adresse)Im DataRequest Json muss im Options > Params Array ein Element mit dem "Key": "AddressId" und dem "Value": der entsprechenden Datenbank ID der Adresse enthalten sein.DataRequest
/AddressesAdressen
DataRequest
/Addresses/ContactsAnsprechpartner
DataRequest
/ArticlesAbrechnungsartikelBenötigt für das Anlegen/Bearbeiten von Abrechnungspositionen.DataRequest
/CountriesLand
DataRequest
/DocumentTypesDokumententypBenötigt für das Filtern von Dokumenten-Metadaten und Hochladen von Dokumenten.DataRequest
/OffersAngebot
DataRequest
/Offers/WaypointsWegpunkt (Angebot)
DataRequest
/Offer/AccountingBlocksAbrechnungsblock (Angebot)
DataRequest
/Offer/AccountingPositionsAbrechnungspositionen (Angebot)
DataRequest
/Offer/CargoContentsLadungsinhalt (Angebot allgemein)
DataRequest
/Offer/ContainerCalculationsAngebotsbearbeitung - Container
DataRequest
/Offer/ContainerCalculation/TenderOffersAngebotsbearbeitung - Container → Offerten


DataRequest
/Offer/ContainerCalculation/TenderOffer/OrderBillingPositionsAngebotsbearbeitung - Container → Abrechnungspositionen (Auftrag/Angebot)


DataRequest
/Offer/ContainerCalculation/TenderOffer/TripBillingPositionsAngebotsbearbeitung - Container → Abrechnungspositionen (Fahrt)


DataRequest
/Offer/ContainerCalculation/WaypointsAngebotsbearbeitung - Container → Wegpunkte


DataRequest
/OrdersAuftrag
DataRequest
/Orders/AccountingBlocksAbrechnungsblock (Auftrag)
DataRequest
/Orders/AccountingPositionsAbrechnungsposition (Auftrag)
DataRequest
/Orders/CargoContentsLadungsinhalt (Auftrag)
DataRequest
/Orders/DocumentDokument (Auftrag)Download einer in cargo support archivierten Datei. DocumentRequest
/Orders/DocumentMetadataDokumenten-Metadaten (Auftrag)

Im DataRequest Json muss im Options > Params Array ein Element mit dem "Key": "OrderId" und dem "Value": der entsprechenden Datenbank ID des Auftrags enthalten sein.

DataRequest
/Orders/WaypointsWegpunkt (Auftrag)
DataRequest
/OrderTypesAuftragstyp
DataRequest
/SubData/Billing/AccountsKontenVorgaben / Abrechnung / KontenDataRequest
/SubData/Billing/SalesTaxMehrwertsteuer
DataRequest
/SubData/Order/PalletTypesLademitteltypen / Containertypen
DataRequest
/SubData/Order/WaypointTypeWegpunkttypen
DataRequest
/ToursTour
DataRequest
/TripsFahrt
DataRequest
/TripStatesFahrtstatusBenötigt für das Filtern und Bearbeiten von Fahrten und Touren.DataRequest
/Trips/AccountingBlocksAbrechnungsblock (Fahrt)
DataRequest
/Trips/AccountingPositionsAbrechnungsposition (Fahrt)
DataRequest
/Trips/DocumentDokument (Fahrt)Download einer in cargo support archivierten Datei. DocumentRequest
/Trips/DocumentMetadataDokumenten-Metadaten (Fahrt)Im DataRequest Json muss im Options > Params Array ein Element mit dem "Key": "TripId" und dem "Value": der entsprechenden Datenbank ID der Fahrt enthalten sein.DataRequest
/Trips/WaypointsWegpunkt (Fahrt)
DataRequest
/Waypoints/CargoContentsLadungsinhalt (Wegpunkt)
DataRequest

Schreibender Zugriff

Endpunkte

AdresseOperationJSONFeedback / Response
/Accounting/AmendAccountingBlockEin bestehender Abrechnungsblock wird angepasstAmendAccountingBlockRequestClientFeedback
/Accounting/AmendAccountingPositionEine bestehende Abrechnungsposition wird angepasst.AmendAccountingPositionRequestClientFeedback
/Accounting/CreateAccountingPositionEine neue Abrechnungsposition wird angelegt.CreateAccountingPositionRequestClientFeedback
/Accounting/DeleteAccountingPositionEine bestehende Abrechnungsposition wird gelöscht.DeleteAccountingPositionRequestClientFeedback
/AddressContact/CreateOrUpdateAdresskontakt zu einer Adresse anlegen oder anpassen

CreateOrUpdateAddressContactRequest

ClientFeedback
/Address/CreateOrUpdateAdresse in den Stammdaten anlegen oder anpassenCreateOrUpdateAddressRequestClientFeedback
/Address/StoreDocumentEine Datei wird hochgeladen und zu einer Adresse archiviert.StoreAddressDocumentRequestClientFeedback
/DispatchPlan/AmendDispatchTemplateEin Leerdispo Datensatz wird angepasst.AmendDispatchTemplateRequestClientFeedback
/Offer/ContainerCalculation/CreateOrderFromOfferErstellt einen Auftrag aus einem Container Angebot.CreateOrderFromContainerOfferCommandRequestClientFeedback
/Offer/CreateOrderFromOfferErstellt einen Auftrag aus einem allgemeinen Angebot

CreateOrderFromOfferCommandRequest

ClientFeedback
/Offer/CreateOrUpdateAngebot (Container / Allgemein) anlegen oder anpassen

CreateOrUpdateOfferRequest

ClientFeedback
/Orders/AmendOrderFreetextDie Freitextfelder eines Auftrags werden angepasst.AmendOrderFreeTextRequestClientFeedback
/Orders/AmendOrderStateDer Auftragsstatus eines bestehenden Auftrag wird angepasst.SetOrderStateRequestClientFeedback
/Orders/StoreDocumentEine Datei wird hochgeladen und zu einem Auftrag archiviert.StoreOrderDocumentRequestClientFeedback
/Orders/UpdateContainerNumAktualisiert die Containernummer eines Auftrags, sowie aller zugehörigen Auftragswegpunkte und FahrtwegpunkteUpdateOrderContainerNumRequestClientFeedback
/Order/UpdateCargoContentFreeTextFieldsAktualisiert die Freitexte der Ladungsinhalte eines AuftragsUpdateOrderCargoContentFreeTextFieldsCommandRequestClientFeedback
/Tours/AmendTourFreetextDie Freitextfelder einer Tour werden angepasst.AmendTourFreeTextRequestClientFeedback
/Trips/AmendTripFreeTextDie Freitextfelder einer Fahrt werden angepasst.TripAmendTripFreeTextCommandRequestClientFeedback
/Trips/AmendTripStateDer Fahrtstatus einer bestehenden Fahrt wird angepasst.SetTripStateRequestClientFeedback
/Trips/DispatchTripEine Fahrt wird auf einen Frachtführer, Fahrzeug oder Fahrer disponiert.
DispatchTripCommandRequest
ClientFeedback
/Trips/SendToMobileTelematicEine Fahrt wird an die Handy Telematik übermitteltSendTripToMobileTelematicCommandRequestClientFeedback
/Trips/StoreDocumentEine Datei wird hochgeladen und zu einer Fahrt archiviert.StoreTripDocumentRequestClientFeedback
/Waypoints/AmendWaypointStateDer Wegpunktstatus eines bestehenden Wegpunkt wird angepasst.SetWaypointStateRequestClientFeedback
/Waypoints/AmendWaypointTimesDie Wegpunktzeiten eines bestehenden Wegpunkt werden angepasst.SetWaypointTimesRequestClientFeedback
/Waypoint/UpdateBindingNetCargoKgAktualisiert das Netto kg/fp des WegpunktsUpdateWaypointBindingNetCargoKgCommandRequestClientFeedback
/Waypoint/UpdateTotalBindingCargoKgAktualisiert das Maximal kg/fp des WegpunktsUpdateWaypointTotalBindingCargoKgCommandRequestClientFeedback

JSON

(Für die Validierung gegen die verschiedenen Definitionen eignet sich z.B. https://www.jsonschemavalidator.net/)

DataRequest

Ein generischer Daten Request. Das Format des zurückgegebenen JSON hängt von der Datenquelle des jeweiligen Endpunkt ab.

Durch Verwendung des Parameters "DataSourceDefinition" (vgl. Beipiel 2) kann das aktuelle Schema der Datenquelle zurückgegeben werden.

Datenquellen können zur Laufzeit auf dem Kundensystem konfiguriert werden (Kentnisse über SQL und die cargo support Datenbankstruktur vorausgesetzt) unter:

...\Server\Modules\Velia\Definitions\PublicApiDataSourceConfiguration.xml

Es empfiehlt es sich für Kundenspezifische Änderungen die Datei in einen neuen Unterordner "Custom" zu kopieren:

...\Server\Modules\Velia\Definitions\Custom\PublicApiDataSourceConfiguration.xml

Dieser Custom Ordner bleibt von Updates unberührt und die dort enthaltene Konfigurationsdatei hat Priorität gegenüber der normalen.


Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DataRequest",
  "description": "A generic data request",
  "type": "object",
  "required": ["Options"],
  "properties": {
    "Options": {
      "type": "object",
      "properties": {
        "Skip": {
          "description": "Omits the first X data entries.",
          "type": "integer"
        },
        "Take": {
          "description": "Limits the total amount of data entries returned.",
          "type": "integer",
          "default": 100
        },
        "Where": {
          "description": "A collection of filters applied to the data source.",
          "type": "array",
          "items": {
            "title": "WhereFilter",
            "type": "object",
            "properties": {
              "Field": {
                "description": "Name of the field to be filtered.",
                "type": "string"
              },
              "Operator": {
                "description": "The filter operator.",
                "enum": [
                  "equal",
                  "notequal",
                  "contains",
                  "notcontains",
                  "startswith",
                  "endswith",
                  "greaterthan",
                  "greaterthanorequal",
                  "lessthan",
                  "lessthanorequal"
                ]
              },
              "value": {
                "description": "The value to be filtered for. (Dates should be transmitted as string in ISO 8601 format)",
                "type": [
                  "null",
                  "integer",
                  "number",
                  "string",
                  "boolean"
                ]
              },
              "predicates": {
                "description": "A collection of WhereFilter objects, used to build complex chained filter expressions.",
                "type": "array",
                "items": {
                  "description": "See definition of WhereFilter above.",
                  "title": "WhereFilter",
                  "type": "object"
                }
              },
              "Condition": {
                "description": "The condition by which the WhereFilter objects in predicates will be chained together.",
                "enum": [
                  "or",
                  "and"
                ]
              },
              "IsComplex": {
                "description": "If true: Field, Operator and value are ignored, instead a complex filter will be build from the Condition and predicates array.",
                "type": "boolean"
              }
            }
          }
        },
        "Sorted": {
          "description": "Sorts the data entries by one or more fields",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Name": {
                "description": "Name of the field to be sorted by",
                "type": "string"
              },
              "Direction": {
                "enum": [
                  "ascending",
                  "descending"
                ]
              }
            }
          }
        },
        "Params": {
          "description": "A collection of custom parameters. Supported parameters: Key:'{Any Id Field}' Value:{number} -> same as a simple equal WhereFilter.
						 Key:'DataSourceDefinition' Value:true -> returns a definition of the data source format.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Key": {
                "description": "Name of the parameter",
                "type": "string"
              },
              "Value": {
                "description": "Value of the parameter",
                "type": [
                  "null",
                  "integer",
                  "number",
                  "string",
                  "boolean"
                ]
              }
            }
          }
        }
      }
    }
  }
}

Sucht alle Einträge die nach dem 22.06.21 12:00 Uhr angelegt wurden und bei denen im Feld InternalNote entweder "Sondertransport" oder "Gefahrgut" enthalten ist.

Das Ergebnis wird nach dem Feld FromDate aufsteigend sortiert.

Die ersten 10 (gefilterten und sortierten) Einträge werden ignoriert.

Das gesamte Ergebnis der (gefilterten und sortierten) Einträge wird auf 40 beschränkt.

Beispiel 1

CODE
{
  "Options": {
    "Skip": 10,
    "Take": 40,
    "Where": [
      {
        "Field": "CreatedDate",
        "Operator": "greaterthanorequal",
        "value": "2021-06-22T12:00:00"
      },
      {
        "predicates": [
          {
            "Field": "InternalNote",
            "Operator": "contains",
            "value": "Sondertransport"
          },
          {
            "Field": "InternalNote",
            "Operator": "contains",
            "value": "Gefahrgut"
          }
        ],
        "Condition": "or",
        "IsComplex": true
      }
    ],
    "Sorted": [
      {
        "Name": "FromDate",
        "Direction": "ascending"
      }
    ]
  }
}

Anfrage der Datenquellen Definition:

Beispiel 2

CODE
{
  "Options": {
    "Params": [
      {
        "Key": "DataSourceDefinition",
        "Value": true
      }
    ]
  }
}

DocumentRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DocumentRequest",
  "description": "A request for downloading an archived document file",
  "type": "object",
  "required": ["EntityId","DocumentMetadataId"],
  "properties": {
    "EntityId": {
      "description": "The Id of the order or trip for which the document was archived.",
      "type": "integer"
    },
    "DocumentMetadataId": {
      "description": "The Id of the document metadata entry.",
      "type": "integer"
    }
  }
}

Beispiel

CODE
{
  "EntityId": 6583,
  "DocumentMetadataId": 7432
}

Schemadefinition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ClientFeedback",
  "description": "A client feedback of a process execution via api.",
  "type": "object",
  "properties": {
    "Message": 
    {
      "type": ["string","null"],
      "description": "A message that contains the defined text of a 
					sucessfull process execution result. E.g. the creation 
					of an order from an offer."
    },
    "ProcessMessages":
    {
      "type": "array",
      "items": {
      	"type": "string"
      },
      "description": "Messages that can contain several informations about 
					the executed process. E.g. a result ID, skipped, direct user questions,  
					process preliminary results or states." 
    },
    "ProcessAborted":
    {
      "type": "boolean",
      "description": "A value indicating whether, the process aborted."
    }
  }
}

Beispiel

CODE
{
    "Message": "Der Prozess wurde erfolgreich abgeschlossen.",
    "ProcessAborted": false,
    "ProcessMessages": [
        "19821"
    ]
}


AmendAccountingBlockRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AmendAccountingBlockRequest",
  "description": "A request to amend an accounting block.",
  "type": "object",
  "required": ["AccountingBlockId"],
  "properties": {
    "AccountingBlockId": {
      "description": "The Id of the accounting block.",
      "type": "integer"
    },
    "PaymentTargetId": {
      "description": "The Id of the payment target.",
      "type": ["integer","null"]
    },
    "BillingCategoryId": {
      "description": "The Id of the billing category.",
      "type": ["integer","null"]
    }
  }
}

Beispiel

CODE
{
    "AccountingBlockId": 12985,
    "PaymentTargetId": 5,
    "BillingCategoryId": 1
}

AmendAccountingPositionRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AmendAccountingPositionRequest",
  "description": "A request to amend an accounting positon.",
  "type": "object",
  "required": ["AccountingPositionId"],
  "properties": {
    "AccountingPositionId": {
      "description": "The Id of the accounting position.",
      "type": "integer"
    },
    "ArticleId": {
      "description": "The Id of the billing article.",
      "type": ["integer","null"]
    },
    "Amount": {
      "type": ["number","null"]
    },
    "NetPrice": {
      "description": "Providing a custom net price overrides tariff calculations.",
      "type": ["number","null"]
    }
  }
}

Beispiel

CODE
{
  "AccountingPositionId": 4253,
  "ArticleId": 783,
  "Amount": 3,
  "NetPrice": 64.3
}

CreateAccountingPositionRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateAccountingPositionRequest",
  "description": "A request to create an accounting positon.",
  "type": "object",
  "required": ["AccountingBlockId"]
  "properties": {
    "AccountingBlockId": {
      "description": "The Id of the parent accounting block.",
      "type": "integer"
    },
    "ArticleId": {
      "description": "The Id of the billing article.",
      "type": ["integer","null"]
    },
    "Amount": {
      "type": ["number","null"]
    },
    "NetPrice": {
      "description": "Providing a custom net price overrides automated tariff calculation of the article price.",
      "type": ["number","null"]
    }
  }
}

Beispiel

CODE
{
  "AccountingBlockId": 6004,
  "ArticleId": 483,
  "Amount": 2,
  "NetPrice": 35.5
}

DeleteAccountingPositionRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeleteAccountingPositionRequest",
  "description": "A request to delete an accounting positon.",
  "type": "object",
  "required": ["AccountingPositionId"],
  "properties": {
    "AccountingPositionId": {
      "description": "The Id of the accounting position.",
      "type": "integer"
    }
  }
}

Beispiel

CODE
{
  "AccountingPositionId": 1485
}

CreateOrUpdateAddressContactRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateOrUpdateAddressContactRequest",
  "description": "A request to create or update an address contact.",
  "type": "object",
  "required": ["MatchCode", "Name"],
  "properties": {
    "AddressId": {
      "type": ["integer", "null"]
    },
    "AddressContactId": {
      "type": ["integer", "null"]
    },
    "MatchCode": {
      "type": "string"
    },
    "Title": {
      "type": ["string", "null"]
    },
    "TitleAffix": {
      "type": ["string", "null"]
    },
    "Name": {
      "type": "string"
    },
    "GivenName": {
      "type": ["string", "null"]
    },
    "NameAffix": {
      "type": ["string", "null"]
    },
    "LetterSalutation": {
      "type": ["string", "null"]
    },
    "AddressAffix": {
      "type": ["string", "null"]
    },
    "Street": {
      "type": ["string", "null"]
    },
    "StreetAffix": {
      "type": ["string", "null"]
    },
    "PostCode": {
      "type": ["string", "null"]
    },
    "City": {
      "type": ["string", "null"]
    },
    "CountryId": {
      "type": ["integer", "null"]
    },
    "PostOfficeBoxPostcode": {
      "type": ["string", "null"]
    },
    "PostOfficeBox": {
      "type": ["string", "null"]
    },
    "TelephoneNumber": {
      "type": ["string", "null"]
    },
    "FacsimileNumber": {
      "type": ["string", "null"]
    },
    "MobilePhoneNumber": {
      "type": ["string", "null"]
    },
    "EmailAddress": {
      "type": ["string", "null"]
    },
    "Website": {
      "type": ["string", "null"]
    },
    "Birthday": {
      "type": ["string", "null"]
    },
    "Note": {
      "type": ["string", "null"]
    },
    "Hint": {
      "type": ["string", "null"]
    }
  }
}

Beispiel

CODE
{
    "AddressId": 874,
    "AddressContactId": 0,
    "MatchCode": "TEST",
    "Title": "Herr",
	"TitleAffix": "Herr",
    "Name": "TEST",
    "GivenName": "TEST",
    "NameAffix": "TEST",
	"LetterSalutation": "TEST",
	"AddressAffix": "12345",
	"Street": "TEST",
	"StreetAffix": "TEST",
	"PostCode": "12345",
	"City": "TEST",
	"CountryId": 1,
	"PostOfficeBoxPostcode": "TEST",
	"PostOfficeBox": "TEST",
	"TelephoneNumber": "013456789",
	"FacsimileNumber": "013456789",
	"MobilePhoneNumber": "013456789",
	"EmailAddress": "test@test.de",
	"Website": "www.test.de",
	"Birthday": "2023-04-01T10:00:00",
	"Note": "TEST",
	"Hint": "TEST"
}

CreateOrUpdateAddressRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateOrUpdateAddressCommandRequest",
  "description": "A request to create or update an address.",
  "type": "object",
  "required": ["MatchCode", "AddressName"],
  "properties": {
    "AddressId": {
      "type": ["integer", "null"]
    },
    "AddressNum": {
      "type": ["string", "null"]
    },
    "MatchCode": {
      "type": "string"
    },
    "Title": {
      "type": ["string", "null"]
    },
    "TitleAffix": {
      "type": ["string", "null"]
    },
    "AddressName": {
      "type": "string"
    },
    "AddressNameAffix": {
      "type": ["string", "null"]
    },
    "Street": {
      "type": ["string", "null"]
    },
    "StreetAffix": {
      "type": ["string", "null"]
    },
    "PostCode": {
      "type": ["string", "null"]
    },
    "City": {
      "type": ["string", "null"]
    },
    "CountryId": {
      "type": ["integer", "null"]
    },
    "MatchCode": {
      "type": ["string", "null"]
    },
    "CityDistrict": {
      "type": ["string", "null"]
    },
    "PostOfficeBoxPostcode": {
      "type": ["string", "null"]
    },
    "PostOfficeBox": {
      "type": ["string", "null"]
    },
    "InvoiceAddressName": {
      "type": ["string", "null"]
    },
    "InvoiceAddressNameAffix": {
      "type": ["string", "null"]
    },
    "InvoiceAddressAddressAffix": {
      "type": ["string", "null"]
    },
    "InvoiceAddressStreet": {
      "type": ["string", "null"]
    },
    "InvoiceAddressStreetAffix": {
      "type": ["string", "null"]
    },
    "InvoiceAddressPostcode": {
      "type": ["string", "null"]
    },
    "InvoiceAddressCity": {
      "type": ["string", "null"]
    },
    "InvoiceAddressCountryId": {
      "type": ["integer", "null"]
    },
    "BeneficiaryAddressId": {
      "type": ["integer", "null"]
    },
    "TelephoneNumber": {
      "type": ["string", "null"]
    },
    "FacsimileNumber": {
      "type": ["string", "null"]
    },
    "MobilePhoneNumber": {
      "type": ["string", "null"]
    },
    "EmailAddress": {
      "type": ["string", "null"]
    },
    "EmailAddress2": {
      "type": ["string", "null"]
    },
    "EmailAddress3": {
      "type": ["string", "null"]
    },
    "EmailAddress4": {
      "type": ["string", "null"]
    },
    "EmailAddress5": {
      "type": ["string", "null"]
    },
    "EmailAddress6": {
      "type": ["string", "null"]
    },
    "WebsiteURL": {
      "type": ["string", "null"]
    },
    "Remarks": {
      "type": ["string", "null"]
    },
    "ImportantNotice": {
      "type": ["string", "null"]
    },
    "DebtorNumber": {
      "type": "integer"
    },
    "SupplierNumber": {
      "type": "integer"
    },
    "TaxIdentificationNumber": {
      "type": ["string", "null"]
    },
    "IlnNum": {
      "type": ["string", "null"]
    },
    "CompanyRegisterNumber": {
      "type": ["string", "null"]
    },
    "IsCustomerAddress": {
      "type": "boolean"
    },
    "IsLUAddress": {
      "type": "boolean"
    },
    "IsDistributorAddress": {
      "type": "boolean"
    },
    "IsSubcontractorAddress": {
      "type": "boolean"
    },
    "IsProvisionRecipientAddress": {
      "type": "boolean"
    },
    "IsSplitAddress": {
      "type": "boolean"
    },
    "IsFreeport": {
      "type": "boolean"
    },
    "IsPortTerminal": {
      "type": "boolean"
    },
    "PalletExchange": {
      "type": "boolean"
    },
    "IsBlocked": {
      "type": "boolean"
    },
    "MayBookPalletAsLoadingStation": {
      "type": "boolean"
    },
    "AddressAffix": {
      "type": ["string", "null"]
    },
    "ValueAddedTaxIdentificationNumber": {
      "type": ["string", "null"]
    },
    "MinimumWageStatementIssued": {
      "type": "boolean"
    },
    "MinimumWageStatementIssueDate": {
      "type": ["string", "null"]
    },
    "EULicence": {
      "type": "boolean"
    },
    "EULicenceValidDate": {
      "type": ["string", "null"]
    },
    "InsuranceConfirmationExists": {
      "type": "boolean"
    },
    "InsuranceConfirmationExpiryDate": {
      "type": ["string", "null"]
    },
    "FreeText1": {
      "type": ["string", "null"]
    },
    "CMRInsuranceConfirmationExists": {
      "type": "boolean"
    },
    "CMRInsuranceConfirmationExpiryDate": {
      "type": ["string", "null"]
    },
    "IgnoreForPriceInformation": {
      "type": "boolean"
    }
  }
}

Beispiel

CODE
{
    "AddressId": 874,
    "AddressNum": "9999",
    "MatchCode": "TEST",
    "Title": "Herr",
	"TitleAffix": "Herr",
    "AddressName": "TEST",
    "AddressNameAffix": "TEST",
    "Street": "TEST",
	"StreetAffix": "TEST",
	"PostCode": "12345",
	"City": "TEST",
	"CountryId": 1,
	"CityDistrict": "TEST",
	"PostOfficeBoxPostcode": "12345",
	"PostOfficeBox": "TEST",
	"InvoiceAddressName": "TEST",
	"InvoiceAddressNameAffix": "TEST",
	"InvoiceAddressAddressAffix": "TEST",
	"InvoiceAddressStreet": "TEST",
	"InvoiceAddressStreetAffix": "TEST",
	"InvoiceAddressPostcode": "12345",
	"InvoiceAddressCity": "TEST",
	"InvoiceAddressCountryId": 1,
	"BeneficiaryAddressId": 1,
	"TelephoneNumber": "013456789",
	"FacsimileNumber": "123456789",
	"MobilePhoneNumber": "123456789",
	"EmailAddress": "test@test.de",
	"EmailAddress2": "test@test.de",
	"EmailAddress3": "test@test.de",
	"EmailAddress4": "test@test.de",
	"EmailAddress5": "test@test.de",
    "EmailAddress6": "test@test.de",
    "WebsiteURL": "www.test.de",
    "Remarks": "TEST",
    "ImportantNotice": "TEST",
    "DebtorNumber": 123456,
    "SupplierNumber": 123456,
    "TaxIdentificationNumber": "TEST",
    "IlnNum": "TEST",
    "CompanyRegisterNumber": "TEST",
    "IsCustomerAddress": true,
    "IsLUAddress": true,
    "IsDistributorAddress": true,
    "IsSubcontractorAddress": true,
    "IsProvisionRecipientAddress": true,
    "IsSplitAddress": true,
    "IsFreeport": true,
    "IsPortTerminal": true,
    "PalletExchange": true,
    "IsBlocked": true,
    "MayBookPalletAsLoadingStation": true,
    "AddressAffix": "TEST",
    "ValueAddedTaxIdentificationNumber": "TEST",
    "MinimumWageStatementIssued": true,
    "MinimumWageStatementIssueDate": "2023-04-01T10:00:00",
    "EULicence": true,  
    "EULicenceValidDate": "2023-04-01T10:00:00",
    "InsuranceConfirmationExists": true,
    "InsuranceConfirmationExpiryDate": "2023-04-01T10:00:00",
    "FreeText1": "TEST",
    "CMRInsuranceConfirmationExists": true,
    "CMRInsuranceConfirmationExpiryDate": "2023-04-01T10:00:00",
    "IgnoreForPriceInformation": true
}

StoreAddressDocumentRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StoreAddressDocumentRequest",
  "description": "A request to upload and atchive a document to an address.",
  "type": "object",
  "required": [
    "AddressId",
    "DocumentTypeId",
    "FileName",
    "FileContent",
    "FileLength"
  ],
  "properties": {
    "AddressId": {
      "type": "integer"
    },
    "DocumentTypeId": {
      "type": "integer"
    },
    "FileName": {
      "type": "string"
    },
    "FileContent": {
      "description": "The file content encoded as a base 64 string.",
      "type": "string"
    },
    "FileLength": {
      "description": "The length of the file in byte.",
      "type": "number"
    }
  }
}

Beispiel

CODE
{
  "AddressId": 5567,
  "DocumentTypeId": 43,
  "FileName": "Testfile.pdf",
  "FileContent": "JVBERi0xLjINJeLjz9MNCjMgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDUgDS9IIFsgNzYwIDE1NyBdIA0vTCAzOTA4IA0vRSAzNjU4I
A0vTiAxIA0vVCAzNzMxIA0+PiANZW5kb2JqDSAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB4cmVmD
TMgMTUgDTAwMDAwMDAwMTYgMDAwMDAgbg0KMDAwMDAwMDY0NCAwMDAwMCBuDQowMDAwMDAwOTE3IDAwMDAwIG4NCjAwMDAwMDEwNjggMDAwMDAgbg0KMDAwMDAwMTIyNCA
wMDAwMCBuDQowMDAwMDAxNDEwIDAwMDAwIG4NCjAwMDAwMDE1ODkgMDAwMDAgbg0KMDAwMDAwMTc2OCAwMDAwMCBuDQowMDAwMDAyMTk3IDAwMDAwIG4NCjAwMDAwMDIzO
DMgMDAwMDAgbg0KMDAwMDAwMjc2OSAwMDAwMCBuDQowMDAwMDAzMTcyIDAwMDAwIG4NCjAwMDAwMDMzNTEgMDAwMDAgbg0KMDAwMDAwMDc2MCAwMDAwMCBuDQowMDAwMDAw
ODk3IDAwMDAwIG4NCnRyYWlsZXINPDwNL1NpemUgMTgNL0luZm8gMSAwIFIgDS9Sb290IDQgMCBSIA0vUHJldiAzNzIyIA0vSURbPGQ3MGY0NmM1YmE0ZmU4YmQ0OWE5ZGQ
wNTk5YjBiMTUxPjxkNzBmNDZjNWJhNGZlOGJkNDlhOWRkMDU5OWIwYjE1MT5dDT4+DXN0YXJ0eHJlZg0wDSUlRU9GDSAgICAgIA00IDAgb2JqDTw8IA0vVHlwZSAvQ2F0YWx
vZyANL1BhZ2VzIDIgMCBSIA0vT3BlbkFjdGlvbiBbIDUgMCBSIC9YWVogbnVsbCBudWxsIG51bGwgXSANL1BhZ2VNb2RlIC9Vc2VOb25lIA0+PiANZW5kb2JqDTE2IDAgb2J
qDTw8IC9TIDM2IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggMTcgMCBSID4+IA1zdHJlYW0NCkiJYmBg4GVgYPrBAAScFxiwAQ4oLQDE3FDMwODHwKkyubctWLfmpsm
imQ5AEYAAAwC3vwe0DWVuZHN0cmVhbQ1lbmRvYmoNMTcgMCBvYmoNNTMgDWVuZG9iag01IDAgb2JqDTw8IA0vVHlwZSAvUGFnZSANL1BhcmVudCAyIDAgUiANL1Jlc291cmNl
cyA2IDAgUiANL0NvbnRlbnRzIDEwIDAgUiANL01lZGlhQm94IFsgMCAwIDYxMiA3OTIgXSANL0Nyb3BCb3ggWyAwIDAgNjEyIDc5MiBdIA0vUm90YXRlIDAgDT4+IA1lbmRvY
moNNiAwIG9iag08PCANL1Byb2NTZXQgWyAvUERGIC9UZXh0IF0gDS9Gb250IDw8IC9UVDIgOCAwIFIgL1RUNCAxMiAwIFIgL1RUNiAxMyAwIFIgPj4gDS9FeHRHU3RhdGUgPD
wgL0dTMSAxNSAwIFIgPj4gDS9Db2xvclNwYWNlIDw8IC9DczUgOSAwIFIgPj4gDT4+IA1lbmRvYmoNNyAwIG9iag08PCANL1R5cGUgL0ZvbnREZXNjcmlwdG9yIA0vQXNjZW5
0IDg5MSANL0NhcEhlaWdodCAwIA0vRGVzY2VudCAtMjE2IA0vRmxhZ3MgMzQgDS9Gb250QkJveCBbIC01NjggLTMwNyAyMDI4IDEwMDcgXSANL0ZvbnROYW1lIC9UaW1lc05ld
1JvbWFuIA0vSXRhbGljQW5nbGUgMCANL1N0ZW1WIDAgDT4+IA1lbmRvYmoNOCAwIG9iag08PCANL1R5cGUgL0ZvbnQgDS9TdWJ0eXBlIC9UcnVlVHlwZSANL0ZpcnN0Q2hhciA
zMiANL0xhc3RDaGFyIDMyIA0vV2lkdGhzIFsgMjUwIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL1RpbWVzTmV3Um9tYW4gDS9Gb250RGVzY3Jpc
HRvciA3IDAgUiANPj4gDWVuZG9iag05IDAgb2JqDVsgDS9DYWxSR0IgPDwgL1doaXRlUG9pbnQgWyAwLjk1MDUgMSAxLjA4OSBdIC9HYW1tYSBbIDIuMjIyMjEgMi4yMjIyMSA
yLjIyMjIxIF0gDS9NYXRyaXggWyAwLjQxMjQgMC4yMTI2IDAuMDE5MyAwLjM1NzYgMC43MTUxOSAwLjExOTIgMC4xODA1IDAuMDcyMiAwLjk1MDUgXSA+PiANDV0NZW5kb2JqD
TEwIDAgb2JqDTw8IC9MZW5ndGggMzU1IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+IA1zdHJlYW0NCkiJdJDBTsMwEETv/oo92ohuvXHsJEeggOCEwDfEIU1SCqIJIimIv2dthyJV
QpGc0Xo88+xzL5beZ0DgN4IIq6oCzd8sK43amAyK3GKmTQV+J5YXo4VmjDYNYyOW1w8Ez6PQ4JuwfAkJyr+yXNgSSwt+NU+4Kp+rcg4uy9Q1a6MdarLcpgvUeUGh7RBFSLk1f1
n+5FgsHJaZttFqA+tKLJhfZ3kEY+VcoHuUfvui2O3kCL9COSwk1Ok3deMEd6srUCVa2Q7Nftf1Ewar5a4nfxuu4v59NcLMGAKXlcjMLtwj1BsTQCITUSK52cC3IoNGDnto6l5Vm
Ev4YAwjO8VWJ+s2DSeGttw/qmA/PZyLu3vY1p9p0MGZIs2iHdZxjwdNSkzedT0pJiW+CWl5H0O7uu2SB1JLn8rHlMkH2F+/xa20Rjp+nAQ39Ec8c1gz7KJ4T3H7uXnuwvSWl17
8CDAA/bGPlAplbmRzdHJlYW0NZW5kb2JqDTExIDAgb2JqDTw8IA0vVHlwZSAvRm9udERlc2NyaXB0b3IgDS9Bc2NlbnQgOTA1IA0vQ2FwSGVpZ2h0IDAgDS9EZXNjZW50IC0yM
TEgDS9GbGFncyAzMiANL0ZvbnRCQm94IFsgLTYyOCAtMzc2IDIwMzQgMTA0OCBdIA0vRm9udE5hbWUgL0FyaWFsLEJvbGQgDS9JdGFsaWNBbmdsZSAwIA0vU3RlbVYgMTMzIA
0+PiANZW5kb2JqDTEyIDAgb2JqDTw8IA0vVHlwZSAvRm9udCANL1N1YnR5cGUgL1RydWVUeXBlIA0vRmlyc3RDaGFyIDMyIA0vTGFzdENoYXIgMTE3IA0vV2lkdGhzIFsgMjc4ID
AgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgDTAgMCAwIDAgMCA3MjIgMCA2MTEgMCAwIDAgMCAwIDAgMCAwIDAgN
jY3IDAgMCAwIDYxMSAwIDAgMCAwIDAgMCANMCAwIDAgMCAwIDAgNTU2IDAgNTU2IDYxMSA1NTYgMCAwIDYxMSAyNzggMCAwIDAgODg5IDYxMSA2MTEgMCAwIA0wIDU1NiAzMzMg
NjExIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL0FyaWFsLEJvbGQgDS9Gb250RGVzY3JpcHRvciAxMSAwIFIgDT4+IA1lbmRvYmoNMTMgMCBvYmoN
PDwgDS9UeXBlIC9Gb250IA0vU3VidHlwZSAvVHJ1ZVR5cGUgDS9GaXJzdENoYXIgMzIgDS9MYXN0Q2hhciAxMjEgDS9XaWR0aHMgWyAyNzggMCAwIDAgMCAwIDAgMCAwIDAgMCAw
IDI3OCAwIDI3OCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCANMCAwIDAgNjY3IDAgMCAwIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCA3MjIgMCAwIDAgMCAwIDAg
MCAwIA0wIDAgMCAwIDAgMCA1NTYgNTU2IDUwMCA1NTYgNTU2IDI3OCAwIDU1NiAyMjIgMCAwIDIyMiA4MzMgNTU2IDU1NiANNTU2IDAgMzMzIDUwMCAyNzggNTU2IDUwMCAwIDAg
NTAwIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL0FyaWFsIA0vRm9udERlc2NyaXB0b3IgMTQgMCBSIA0+PiANZW5kb2JqDTE0IDAgb2JqDTw8IA0vV
HlwZSAvRm9udERlc2NyaXB0b3IgDS9Bc2NlbnQgOTA1IA0vQ2FwSGVpZ2h0IDAgDS9EZXNjZW50IC0yMTEgDS9GbGFncyAzMiANL0ZvbnRCQm94IFsgLTY2NSAtMzI1IDIwMjggMTA
zNyBdIA0vRm9udE5hbWUgL0FyaWFsIA0vSXRhbGljQW5nbGUgMCANL1N0ZW1WIDAgDT4+IA1lbmRvYmoNMTUgMCBvYmoNPDwgDS9UeXBlIC9FeHRHU3RhdGUgDS9TQSBmYWxzZSAN
L1NNIDAuMDIgDS9UUiAvSWRlbnRpdHkgDT4+IA1lbmRvYmoNMSAwIG9iag08PCANL1Byb2R1Y2VyIChBY3JvYmF0IERpc3RpbGxlciA0LjA1IGZvciBXaW5kb3dzKQ0vQ3JlYXRvci
AoTWljcm9zb2Z0IFdvcmQgOS4wKQ0vTW9kRGF0ZSAoRDoyMDAxMDgyOTA5NTUwMS0wNycwMCcpDS9BdXRob3IgKEdlbmUgQnJ1bWJsYXkpDS9UaXRsZSAoVGhpcyBpcyBhIHRlc3Qg
UERGIGRvY3VtZW50KQ0vQ3JlYXRpb25EYXRlIChEOjIwMDEwODI5MDk1NDU3KQ0+PiANZW5kb2JqDTIgMCBvYmoNPDwgDS9UeXBlIC9QYWdlcyANL0tpZHMgWyA1IDAgUiBdIA0vQ29
1bnQgMSANPj4gDWVuZG9iag14cmVmDTAgMyANMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAzNDI5IDAwMDAwIG4NCjAwMDAwMDM2NTggMDAwMDAgbg0KdHJhaWxlcg08PA0vU2l6ZS
AzDS9JRFs8ZDcwZjQ2YzViYTRmZThiZDQ5YTlkZDA1OTliMGIxNTE+PGQ3MGY0NmM1YmE0ZmU4YmQ0OWE5ZGQwNTk5YjBiMTUxPl0NPj4Nc3RhcnR4cmVmDTE3Mw0lJUVPRg0=",
  "FileLength": 3908
}

AmendDispatchTemplateRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AmendDispatchTemplateRequest",
  "description": "A request to amend a dispatch template.",
  "type": "object",
  "required": ["DispatchTemplateId"],
  "properties": {
    "DispatchTemplateId": {
      "type": "integer"
    },
    "DispatchGroupId": {
      "type": ["integer", "null"]
    }
  }
}

Beispiel

CODE
{
    "DispatchTemplateId": 36,
    "DispatchGroupId": 21
}

CreateOrderFromContainerOfferCommandRequest

Schemadefinition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateOrderFromContainerOfferCommandRequest",
  "description": "A request to create an order from a container offer.",
  "type": "object",
  "required": ["ContainerOfferId"],
  "properties": {
    "ContainerOfferId": 
    {
      "type": "integer",
      "description": "ID of an existing container offer calculation."
    }
  }
}

Beispiel

CODE
{
    "ContainerOfferId": 36
}

CreateOrderFromOfferCommandRequest

Schemadefinition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateOrderFromOfferCommandRequest",
  "description": "A request to create an order from a common offer.",
  "type": "object",
  "required": ["OfferId","UserId"],
  "properties": {
    "OfferId": 
    {
      "type": "integer",
      "description": "ID of a common, existing offer."
    },
    "UserId":
    {
      "type": "integer",
      "description": "ID of the the cargo support user.
					From the users table in the csd2 database." 
    }
  }
}

Beispiel

CODE
{
    "OfferId": 36,
    "UserId": 21
}

CreateOrUpdateOfferRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateOrUpdateOfferRequest",
  "description": "A request to create or update an offer.",
  "type": "object",
  "required": ["IsCommonOffer"],
  "properties": {
    "OfferId": 
    {
      "type": ["integer", "null"],
      "description": "ID of the existing common or container offer. If null then a new offer is created."
    },
    "BranchId":
    {
      "type": ["integer", "null"],
      "description": "Identifier of the branch which to be assigned to this offer. 
					This information has affect to the offer number calculation on 
					creating an offer. This ID should be set, otherwise the server session branch is used." 
    },
    "IsCommonOffer": {
      "type": "boolean",
      "description": "This information is used to mark a offer as generally. 
					Otherwise this offer is identified as container offer."  
    },
    "ContainerCalculationName": {
      "description": "Name of the container offer calculation. On conainer offers required only. 
					Default is set in case of null",
      "type": ["string", "null"]
    },
    "FreeText2": {
      "type": ["string", "null"]
    },
    "ImportExport": {
      "description": "The import/export/repositioning enum integer value of a container transport. IMPORT = 0, EXPORT = 1, REPOSITIONING = 2",
      "type": ["integer", "null"]
    },
    "LoadingWaypoint": {
      "description": "Contains the loading waypoint data.",
      "type": ["object", "null"],
      "required": ["PostCode", "WaypointDetailTypeId"],
      "properties":
      {
        "WaypointDetailTypeId": {"type": "integer", "description": "Requires a valid id value from the waypoint_detail_type table."},
        "PostCode": {"type": "string"},
        "AddressName": 
        {
          "description": "This value is compared to the AddressName of existing addresses.
                    	If a match is found then Street, PostCode, City and Country of the existing address is used instead of the values provided here.",
          "type": ["string", "null"], 
        },
        "Street": {"type": ["string", "null"]},
        "City": {"type": ["string", "null"]},
        "Country": {"type": ["string", "null"], "description": "Country code, as string in  ISO 3166-1 alpha-2 format."},
        "Latitude": {"type": ["number", "null"]},
        "Longitude": {"type": ["number", "null"]},
        "From": {"type": ["string", "null"], "description": "DateTime of from, as string in ISO 8601 format."},
        "To": {"type": ["string", "null"], "description": "DateTime of to, as string in ISO 8601 format."},
        "Hint": {"type": ["string", "null"]},
        "Contact":
        {
          "description": "Contains the loading waypoint contact data.",
          "type": ["object", "null"],
          "required": ["ContactLastName"],
          "properties":
          {
            "ContactGivenName": {"type": ["string", "null"]},
        	"ContactLastName": {"type": "string"},
        	"ContactEmailAddress": {"type": ["string", "null"]},
        	"ContactTelephoneNumber": {"type": ["string", "null"]},
          }
        }
      }
    },
    "UnLoadingWaypoint": {
      "description": "Contains the unloading waypoint data.",
      "type": ["object", "null"],
      "required": ["PostCode", "WaypointDetailTypeId"],
      "properties":
      {
        "WaypointDetailTypeId": {"type": "integer", "description": "Requires a valid id value from the waypoint_detail_type table."},
        "PostCode": {"type": "string"},
        "AddressName": 
        {
          "description": "This value is compared to the AddressName of existing addresses.
                    	If a match is found then Street, PostCode, City and Country of the existing address is used instead of the values provided here.",
          "type": ["string", "null"], 
        },
        "Street": {"type": ["string", "null"]},
        "City": {"type": ["string", "null"]},
        "Country": {"type": ["string", "null"], "description": "Country code, as string in  ISO 3166-1 alpha-2 format."},
        "Latitude": {"type": ["number", "null"]},
        "Longitude": {"type": ["number", "null"]},
        "From": {"type": ["string", "null"], "description": "DateTime of from, as string in ISO 8601 format."},
        "To": {"type": ["string", "null"], "description": "DateTime of to, as string in ISO 8601 format."},
        "Hint": {"type": ["string", "null"]},
        "Contact":
        {
          "description": "Contains the loading waypoint contact data.",
          "type": ["object", "null"],
          "required": ["ContactLastName"],
          "properties":
          {
            "ContactGivenName": {"type": ["string", "null"]},
        	"ContactLastName": {"type": "string"},
        	"ContactEmailAddress": {"type": ["string", "null"]},
        	"ContactTelephoneNumber": {"type": ["string", "null"]},
          }
        }
      }
    },
    "ReturnWaypoint": {
      "description": "Contains the return waypoint data.",
      "type": ["object", "null"],
      "required": ["PostCode", "WaypointDetailTypeId"],
      "properties":
      {
        "WaypointDetailTypeId": {"type": "integer", "description": "Requires a valid id value from the waypoint_detail_type table."},
        "PostCode": {"type": "string"},
        "AddressName": 
        {
          "description": "This value is compared to the AddressName of existing addresses.
                    	If a match is found then  Street, PostCode, City and Country of the existing address is used instead of the values provided here.",
          "type": ["string", "null"], 
        },
        "Street": {"type": ["string", "null"]},
        "City": {"type": ["string", "null"]},
        "Country": {"type": ["string", "null"], "description": "Country code, as string in  ISO 3166-1 alpha-2 format."},
        "Latitude": {"type": ["number", "null"]},
        "Longitude": {"type": ["number", "null"]},
        "From": {"type": ["string", "null"], "description": "DateTime of from, as string in ISO 8601 format."},
        "To": {"type": ["string", "null"], "description": "DateTime of to, as string in ISO 8601 format."},
        "Hint": {"type": ["string", "null"]},
        "Contact":
        {
          "description": "Contains the loading waypoint contact data.",
          "type": ["object", "null"],
          "required": ["ContactLastName"],
          "properties":
          {
            "ContactGivenName": {"type": ["string", "null"]},
        	"ContactLastName": {"type": "string"},
        	"ContactEmailAddress": {"type": ["string", "null"]},
        	"ContactTelephoneNumber": {"type": ["string", "null"]},
          }
        }
      }
    },
    "CargoContents": {
      "description": "These values are only relevant/used if IsCommonOffer = true. Otherwise they are ignored.",
      "type": ["array", "null"],
      "items":
      {
        "type": "object",
		"required": ["Amount"],
        "properties":
        {
          "CargoContentId":
          {
            "type": ["integer", "null"],
            "description": "If null then a new cargo content is created. Else the cargo content with the provided id is updated."
          },
          "Amount": {"type": "number"},
          "PalletTypeId": {"type": ["integer", "null"]},
          "CargoContentLength": {"type": ["number", "null"]},
          "CargoContentWidth": {"type": ["number", "null"]},
          "CargoContentHeight": {"type": ["number", "null"]},
          "LoadingMeter": {"type": "number"},
          "BindingCargoKg": {"type": ["number", "null"]},
        }
      }
    },
    "TotalKm": {
      "type": ["number", "null"]
    },
    "OffererAddressId": {
      "description": "If left empty or filled with null an address with matchcode
					'NEUKUNDE' or 'NEW CUSTOMER' is searched in the existing addresses. 
					If none exists then such a dummy address is created automatically.",
      "type": ["integer", "null"]
    },
    "OfferContactId": {
      "type": ["integer", "null"]
    },
    "OfferContact":
    {
      "description": "Contains the offer contact data.",
      "type": ["object", "null"],
      "required": ["ContactLastName"],
      "properties":
      {
        "ContactGivenName": {"type": ["string", "null"]},
        "ContactLastName": {"type": "string"},
        "ContactEmailAddress": {"type": ["string", "null"]},
        "ContactTelephoneNumber": {"type": ["string", "null"]},
      }
    },
    "TotalBindingCargoKg": {
      "type": "number", "description": "Necessary on container offers only."
    },
    "IsAdr": {
      "type": "boolean"
    },
    "IsNCTS": {
      "type": "boolean"
    },
    "FreeCheckBox1": {
      "type": "boolean"
    },
    "TruckTypeId": {
      "type": ["integer", "null"]
    },
    "ContainerPalletTypeId": {
      "type": ["integer", "null"], "description": "Necessary on container offers only."
    },
    "RearFlush": {
      "type": "boolean"
    },
    "IsActiveCooling": {
      "type": "boolean"
    },
    "ResponsibleUserId": {
      "type": ["integer", "null"]
    },
    "OfferTypeId": {
      "description": "Can be filled with an OrderTypeID from the table order_types. OfferType and OrderType mean contextually the same thing.",
      "type": ["integer", "null"]
    }
  }
}

Beispiel

CODE
{
    "OfferId": 874,
	"BranchId": 1,
    "IsCommonOffer": true,
    "ContainerCalculationName": "TEST",
    "FreeText2": "Vimasoft - Order ID",
    "ImportExport": 1,
    "LoadingWaypoint":
    {
      "WaypointDetailTypeId": 1,
      "PostCode": "12345",
      "AddressName": "TEST",
      "City": "TEST",
      "Country": "DE",
      "Street": "EXAMPLE str",
      "Latitude": 14.04,
      "Longitude": 55.55,
      "From": "2023-04-01T10:00:00",
      "To": "2023-04-01T10:00:00",
      "Hint": "TEST",
      "Contact":
      {
        "ContactGivenName": "TEST",
        "ContactLastName": "TEST",
        "ContactEmailAddress": "test@test.de",
        "ContactTelephoneNumber": "0123456789"
      }
    },
    "CargoContents":
  	[
      {
        "CargoContentId": 1,
        "Amount": 123,
        "PalletTypeId": 1,
        "CargoContentLength": 213,
        "CargoContentWidth": 1,
        "CargoContentHeight": 2,
        "LoadingMeter": 13,
        "BindingCargoKg": 123
      }
    ],
	"TotalKm": 1234,
    "OffererAddressId": 1,
    "OfferContactId": 1,
    "OfferContact":
    {
        "ContactGivenName": "TEST",
        "ContactLastName": "TEST",
        "ContactEmailAddress": "test@test.de",
        "ContactTelephoneNumber": "0123456789"
    },
	"TotalBindingCargoKg": 123,
	"IsAdr": true,
	"IsNCTS": true,
	"FreeCheckBox1": true,
	"TruckTypeId": 1,
	"ContainerPalletTypeId": 1,
	"RearFlush": true,
	"IsActiveCooling": true,
	"ResponsibleUserId": 1,
	"OfferTypeId": 2
}

AmendOrderFreeTextRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AmendOrderFreeTextRequest",
  "description": "A request to amend the free text fields of a given order.",
  "type": "object",
  "required": ["OrderId"],
  "properties": {
    "OrderId": {
      "type": "integer"
    },
    "FreeText1": {
      "type": ["string","null"]
    },
    "FreeText2": {
      "type": ["string","null"]
    },
    "FreeText3": {
      "type": ["string","null"]
    }
  }
}

Beispiel

CODE
{
  "OrderId": 4937,
  "FreeText1": "https://tracking.sitra-spedition.de/?tid=xxxxxxxxxxxxxxxxxxxxxxxx",
  "FreeText2": "https://tracking.sitra-spedition.de/?tid=xxxxxxxxxxxxxxxxxxxxxxxx",
  "FreeText3": "Beispiel Bemerkung"
}

SetOrderStateRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SetOrderStateRequest",
  "description": "A request to alter the state of an order.",
  "type": "object",
  "required": ["OrderId","OrderState"],
  "properties": {
    "OrderId": {
      "description": "The Id of the order.",
      "type": "integer"
    },
    "OrderState": {
      "description": "The order state enum integer value. To view possible OrderState enum values request the datasource definition of /Orders",
      "type": "integer"
    }
  }
}

Beispiel

CODE
{
  "OrderId": 2785,
  "OrderState": 40
}

StoreOrderDocumentRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StoreOrderDocumentRequest",
  "description": "A request to upload and atchive a document to an order.",
  "type": "object",
  "required": [
    "OrderId",
    "DocumentTypeId",
    "FileName",
    "FileContent",
    "FileLength"
  ],
  "properties": {
    "OrderId": {
      "type": "integer"
    },
    "DocumentTypeId": {
      "type": "integer"
    },
    "FileName": {
      "type": "string"
    },
    "FileContent": {
      "description": "The file content encoded as a base 64 string.",
      "type": "string"
    },
    "FileLength": {
      "description": "The length of the file in byte.",
      "type": "number"
    }
  }
}

Beispiel

CODE
{
  "OrderId": 7389,
  "DocumentTypeId": 24,
  "FileName": "Testfile.pdf",
  "FileContent": "JVBERi0xLjINJeLjz9MNCjMgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDUgDS9IIFsgNzYwIDE1NyBdIA0vTCAzOTA4IA0vRSAzNjU4I
A0vTiAxIA0vVCAzNzMxIA0+PiANZW5kb2JqDSAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB4cmVmD
TMgMTUgDTAwMDAwMDAwMTYgMDAwMDAgbg0KMDAwMDAwMDY0NCAwMDAwMCBuDQowMDAwMDAwOTE3IDAwMDAwIG4NCjAwMDAwMDEwNjggMDAwMDAgbg0KMDAwMDAwMTIyNCA
wMDAwMCBuDQowMDAwMDAxNDEwIDAwMDAwIG4NCjAwMDAwMDE1ODkgMDAwMDAgbg0KMDAwMDAwMTc2OCAwMDAwMCBuDQowMDAwMDAyMTk3IDAwMDAwIG4NCjAwMDAwMDIzO
DMgMDAwMDAgbg0KMDAwMDAwMjc2OSAwMDAwMCBuDQowMDAwMDAzMTcyIDAwMDAwIG4NCjAwMDAwMDMzNTEgMDAwMDAgbg0KMDAwMDAwMDc2MCAwMDAwMCBuDQowMDAwMDAw
ODk3IDAwMDAwIG4NCnRyYWlsZXINPDwNL1NpemUgMTgNL0luZm8gMSAwIFIgDS9Sb290IDQgMCBSIA0vUHJldiAzNzIyIA0vSURbPGQ3MGY0NmM1YmE0ZmU4YmQ0OWE5ZGQ
wNTk5YjBiMTUxPjxkNzBmNDZjNWJhNGZlOGJkNDlhOWRkMDU5OWIwYjE1MT5dDT4+DXN0YXJ0eHJlZg0wDSUlRU9GDSAgICAgIA00IDAgb2JqDTw8IA0vVHlwZSAvQ2F0YWx
vZyANL1BhZ2VzIDIgMCBSIA0vT3BlbkFjdGlvbiBbIDUgMCBSIC9YWVogbnVsbCBudWxsIG51bGwgXSANL1BhZ2VNb2RlIC9Vc2VOb25lIA0+PiANZW5kb2JqDTE2IDAgb2J
qDTw8IC9TIDM2IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggMTcgMCBSID4+IA1zdHJlYW0NCkiJYmBg4GVgYPrBAAScFxiwAQ4oLQDE3FDMwODHwKkyubctWLfmpsm
imQ5AEYAAAwC3vwe0DWVuZHN0cmVhbQ1lbmRvYmoNMTcgMCBvYmoNNTMgDWVuZG9iag01IDAgb2JqDTw8IA0vVHlwZSAvUGFnZSANL1BhcmVudCAyIDAgUiANL1Jlc291cmNl
cyA2IDAgUiANL0NvbnRlbnRzIDEwIDAgUiANL01lZGlhQm94IFsgMCAwIDYxMiA3OTIgXSANL0Nyb3BCb3ggWyAwIDAgNjEyIDc5MiBdIA0vUm90YXRlIDAgDT4+IA1lbmRvY
moNNiAwIG9iag08PCANL1Byb2NTZXQgWyAvUERGIC9UZXh0IF0gDS9Gb250IDw8IC9UVDIgOCAwIFIgL1RUNCAxMiAwIFIgL1RUNiAxMyAwIFIgPj4gDS9FeHRHU3RhdGUgPD
wgL0dTMSAxNSAwIFIgPj4gDS9Db2xvclNwYWNlIDw8IC9DczUgOSAwIFIgPj4gDT4+IA1lbmRvYmoNNyAwIG9iag08PCANL1R5cGUgL0ZvbnREZXNjcmlwdG9yIA0vQXNjZW5
0IDg5MSANL0NhcEhlaWdodCAwIA0vRGVzY2VudCAtMjE2IA0vRmxhZ3MgMzQgDS9Gb250QkJveCBbIC01NjggLTMwNyAyMDI4IDEwMDcgXSANL0ZvbnROYW1lIC9UaW1lc05ld
1JvbWFuIA0vSXRhbGljQW5nbGUgMCANL1N0ZW1WIDAgDT4+IA1lbmRvYmoNOCAwIG9iag08PCANL1R5cGUgL0ZvbnQgDS9TdWJ0eXBlIC9UcnVlVHlwZSANL0ZpcnN0Q2hhciA
zMiANL0xhc3RDaGFyIDMyIA0vV2lkdGhzIFsgMjUwIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL1RpbWVzTmV3Um9tYW4gDS9Gb250RGVzY3Jpc
HRvciA3IDAgUiANPj4gDWVuZG9iag05IDAgb2JqDVsgDS9DYWxSR0IgPDwgL1doaXRlUG9pbnQgWyAwLjk1MDUgMSAxLjA4OSBdIC9HYW1tYSBbIDIuMjIyMjEgMi4yMjIyMSA
yLjIyMjIxIF0gDS9NYXRyaXggWyAwLjQxMjQgMC4yMTI2IDAuMDE5MyAwLjM1NzYgMC43MTUxOSAwLjExOTIgMC4xODA1IDAuMDcyMiAwLjk1MDUgXSA+PiANDV0NZW5kb2JqD
TEwIDAgb2JqDTw8IC9MZW5ndGggMzU1IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+IA1zdHJlYW0NCkiJdJDBTsMwEETv/oo92ohuvXHsJEeggOCEwDfEIU1SCqIJIimIv2dthyJV
QpGc0Xo88+xzL5beZ0DgN4IIq6oCzd8sK43amAyK3GKmTQV+J5YXo4VmjDYNYyOW1w8Ez6PQ4JuwfAkJyr+yXNgSSwt+NU+4Kp+rcg4uy9Q1a6MdarLcpgvUeUGh7RBFSLk1f1
n+5FgsHJaZttFqA+tKLJhfZ3kEY+VcoHuUfvui2O3kCL9COSwk1Ok3deMEd6srUCVa2Q7Nftf1Ewar5a4nfxuu4v59NcLMGAKXlcjMLtwj1BsTQCITUSK52cC3IoNGDnto6l5Vm
Ev4YAwjO8VWJ+s2DSeGttw/qmA/PZyLu3vY1p9p0MGZIs2iHdZxjwdNSkzedT0pJiW+CWl5H0O7uu2SB1JLn8rHlMkH2F+/xa20Rjp+nAQ39Ec8c1gz7KJ4T3H7uXnuwvSWl17
8CDAA/bGPlAplbmRzdHJlYW0NZW5kb2JqDTExIDAgb2JqDTw8IA0vVHlwZSAvRm9udERlc2NyaXB0b3IgDS9Bc2NlbnQgOTA1IA0vQ2FwSGVpZ2h0IDAgDS9EZXNjZW50IC0yM
TEgDS9GbGFncyAzMiANL0ZvbnRCQm94IFsgLTYyOCAtMzc2IDIwMzQgMTA0OCBdIA0vRm9udE5hbWUgL0FyaWFsLEJvbGQgDS9JdGFsaWNBbmdsZSAwIA0vU3RlbVYgMTMzIA
0+PiANZW5kb2JqDTEyIDAgb2JqDTw8IA0vVHlwZSAvRm9udCANL1N1YnR5cGUgL1RydWVUeXBlIA0vRmlyc3RDaGFyIDMyIA0vTGFzdENoYXIgMTE3IA0vV2lkdGhzIFsgMjc4ID
AgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgDTAgMCAwIDAgMCA3MjIgMCA2MTEgMCAwIDAgMCAwIDAgMCAwIDAgN
jY3IDAgMCAwIDYxMSAwIDAgMCAwIDAgMCANMCAwIDAgMCAwIDAgNTU2IDAgNTU2IDYxMSA1NTYgMCAwIDYxMSAyNzggMCAwIDAgODg5IDYxMSA2MTEgMCAwIA0wIDU1NiAzMzMg
NjExIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL0FyaWFsLEJvbGQgDS9Gb250RGVzY3JpcHRvciAxMSAwIFIgDT4+IA1lbmRvYmoNMTMgMCBvYmoN
PDwgDS9UeXBlIC9Gb250IA0vU3VidHlwZSAvVHJ1ZVR5cGUgDS9GaXJzdENoYXIgMzIgDS9MYXN0Q2hhciAxMjEgDS9XaWR0aHMgWyAyNzggMCAwIDAgMCAwIDAgMCAwIDAgMCAw
IDI3OCAwIDI3OCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCANMCAwIDAgNjY3IDAgMCAwIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCA3MjIgMCAwIDAgMCAwIDAg
MCAwIA0wIDAgMCAwIDAgMCA1NTYgNTU2IDUwMCA1NTYgNTU2IDI3OCAwIDU1NiAyMjIgMCAwIDIyMiA4MzMgNTU2IDU1NiANNTU2IDAgMzMzIDUwMCAyNzggNTU2IDUwMCAwIDAg
NTAwIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL0FyaWFsIA0vRm9udERlc2NyaXB0b3IgMTQgMCBSIA0+PiANZW5kb2JqDTE0IDAgb2JqDTw8IA0vV
HlwZSAvRm9udERlc2NyaXB0b3IgDS9Bc2NlbnQgOTA1IA0vQ2FwSGVpZ2h0IDAgDS9EZXNjZW50IC0yMTEgDS9GbGFncyAzMiANL0ZvbnRCQm94IFsgLTY2NSAtMzI1IDIwMjggMTA
zNyBdIA0vRm9udE5hbWUgL0FyaWFsIA0vSXRhbGljQW5nbGUgMCANL1N0ZW1WIDAgDT4+IA1lbmRvYmoNMTUgMCBvYmoNPDwgDS9UeXBlIC9FeHRHU3RhdGUgDS9TQSBmYWxzZSAN
L1NNIDAuMDIgDS9UUiAvSWRlbnRpdHkgDT4+IA1lbmRvYmoNMSAwIG9iag08PCANL1Byb2R1Y2VyIChBY3JvYmF0IERpc3RpbGxlciA0LjA1IGZvciBXaW5kb3dzKQ0vQ3JlYXRvci
AoTWljcm9zb2Z0IFdvcmQgOS4wKQ0vTW9kRGF0ZSAoRDoyMDAxMDgyOTA5NTUwMS0wNycwMCcpDS9BdXRob3IgKEdlbmUgQnJ1bWJsYXkpDS9UaXRsZSAoVGhpcyBpcyBhIHRlc3Qg
UERGIGRvY3VtZW50KQ0vQ3JlYXRpb25EYXRlIChEOjIwMDEwODI5MDk1NDU3KQ0+PiANZW5kb2JqDTIgMCBvYmoNPDwgDS9UeXBlIC9QYWdlcyANL0tpZHMgWyA1IDAgUiBdIA0vQ29
1bnQgMSANPj4gDWVuZG9iag14cmVmDTAgMyANMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAzNDI5IDAwMDAwIG4NCjAwMDAwMDM2NTggMDAwMDAgbg0KdHJhaWxlcg08PA0vU2l6ZS
AzDS9JRFs8ZDcwZjQ2YzViYTRmZThiZDQ5YTlkZDA1OTliMGIxNTE+PGQ3MGY0NmM1YmE0ZmU4YmQ0OWE5ZGQwNTk5YjBiMTUxPl0NPj4Nc3RhcnR4cmVmDTE3Mw0lJUVPRg0=",
  "FileLength": 3908
}

Schemadefinition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UpdateOrderContainerNumRequest",
  "description": "A request to update the container number of an 
				order and all related order waypoints and trip waypoints.",
  "type": "object",
  "required": ["OrderId"],
  "properties": {
    "OrderId": 
    {
      "type": "integer",
      "description": "The primary key of the order."
    },
    "ContainerNum":
    {
      "type": ["string","null"],
      "description": "The container number." 
    }
  }
}

Beispiel

CODE
{
    "OrderId": 1,
    "ContainerNum": "MSCU5285725"
}

Schemadefinition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UpdateOrderCargoContentFreeTextFieldsCommandRequest",
  "description": "A request to update the freetext fields of an order cargo content.",
  "type": "object",
  "properties": {
    "CargoContentId": 
    {
      "type": "integer",
      nullable: true,
      "description": "The primary key of the order cargo content."
    },
    "FreeText1":
    {
      "type": "string",
      nullable: true,
      "description": "The free text 1 field." 
    },
    "FreeText2":
    {
      "type": "string",
      nullable: true,
      "description": "The free text 2 field." 
    },
    "FreeText3":
    {
      "type": "string",
      nullable: true,
      "description": "The free text 3 field." 
    },
    "FreeTextField":
    {
      "type": "string",
      nullable: true,
      "description": "The free text field." 
    }
  }
}

Beispiel

CODE
{
    "CargoContentId": 1,
    "FreeText1": "Feel free 1.",
    "FreeText2": "Feel free 2.",
    "FreeText3": "Feel free 3.",
    "FreeTextField": "Feel free.",
}

AmendTourFreeTextRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AmendTourFreeTextRequest",
  "description": "A request to amend the free text fields of a given tour.",
  "type": "object",
  "required": ["TourId"],
  "properties": {
    "TourId": {
      "type": "integer"
    },
    "FreeText1": {
      "type": ["string","null"]
    },
    "FreeText2": {
      "type": ["string","null"]
    },
    "FreeText3": {
      "type": ["string","null"]
    }
  }
}

Beispiel

CODE
{
  "TourId": 4937,
  "FreeText1": "https://tracking.sitra-spedition.de/?tid=xxxxxxxxxxxxxxxxxxxxxxxx",
  "FreeText2": "https://tracking.sitra-spedition.de/?tid=xxxxxxxxxxxxxxxxxxxxxxxx",
  "FreeText3": "Beispiel Bemerkung"
}

TripAmendTripFreeTextCommandRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TripAmendTripFreeTextCommandRequest",
  "description": "A request to alter the free text fields of a trip.",
  "type": "object",
  "required": [
    "TripId"
  ],
  "properties": {
    "TripId": {
      "type": "integer"
    },
    "FreeText1": {
      "description": "If null or not defined then the value will remain unchanged.",
      "type": ["string", "null"]
    },
    "FreeText2": {
      "description": "If null or not defined then the value will remain unchanged.",
      "type": ["string", "null"]
    },
    "FreeText3": {
      "description": "If null or not defined then the value will remain unchanged.",
      "type": ["string", "null"]
    },
  }
}

Beispiel

CODE
{
    "TripId": 8661,
    "FreeText1": "example1",
    "FreeText2": "example2",
    "FreeText3": "example3"
}

SetTripStateRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SetTripStateRequest",
  "description": "A request to alter the state of a trip.",
  "type": "object",
  "required": [
    "TripId",
    "TripStateId"
  ],
  "properties": {
    "TripId": {
      "type": "integer"
    },
    "TripStateId": {
      "type": "integer"
    }
  }
}

Beispiel

CODE
{
  "TripId": 864,
  "TripStateId": 2
}

DispatchTripCommandRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DispatchTripCommandRequest",
  "description": "A request to dispatch a trip. If no AgentAddressId, TruckId, DriverId, TrainScheduleId is transmitted the dispatch will be revoked.",
  "type": "object",
  "required": [
    "TripId"
  ],
  "properties": {
    "TripId": {
      "type": "integer"
    },
    "AgentAddressId": {
      "type": ["integer", "null"]
    },
    "TruckId": {
      "type": ["integer", "null"]
    },
    "DriverId": {
      "type": ["integer", "null"]
    },
    "TrainScheduleId": {
      "type": ["integer", "null"]
    },
    "DesiredStart": {
      "description": "DateTime of desired start, as string in ISO 8601 format.",
      "type": ["string", "null"]
    },
    "SendTripToCsDrive": {
      "type": ["boolean", "null"]
    },
    "DoNotChangeTripMandator": {
      "type": ["boolean", "null"]
    },
    "TripSetting": {
      "description": "Client specific trip settings.",
      "type": ["object", "null"],
      "properties":
      {
        "AllwaysChangeSubcontractor": {
          "description": "Wether the agent address id should be reset when dispatching to a new driver or truck.",
          "type": ["boolean", "null"],
          "default": false
        }
      }
    },
    "DispatchPlanSetting": {
      "description": "Client specific dispatch plan settings.",
      "type": ["object", "null"],
      "properties":
      {
        "DispatchRestrictionType": {
          "description": "Prevents dispatching based on accounting blocks. Possible values: TripAnyBillCreated, TripAnyBillFloating, WithoutRestriction",
          "type": ["string", "null"],
          "default": "TripAnyBillCreated"
        },
        "TrailerRemainsAvailable": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "KeepDayScheduleValuesAfterReScheduling": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": true
        },
        "TakeValueFromOldTailer": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "TakeValueFromOldDriver1": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "TakeValueFromOldDriver2": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "TakeValueFromOldCran": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "TakeValueFromOldForklift": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "TakeValueFromOldSwapTrailer1": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "TakeValueFromOldSwapTrailer2": {
          "description": "Carry over values when re-dispatching",
          "type": ["boolean", "null"],
          "default": false
        },
        "UseTrailerFromLastTrip": {
          "description": "Carry over trailer from preceding trip",
          "type": ["boolean", "null"],
          "default": false
        }
      }
    }
  }
}

Beispiel

CODE
{
    "TripId": 8661,
    "DriverId": 199,
    "DispatchPlanSetting":
    {
        "DispatchRestrictionType": "TripAnyBillCreated"
    }
}

SendTripToMobileTelematicCommandRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SendTripToMobileTelematicCommandRequest",
  "description": "Send a trip to the mobile telematic.",
  "type": "object",
  "required": [
    "TripId"
  ],
  "properties": {
    "TripId": {
      "type": "integer"
    }
  }
}

Beispiel

CODE
{
    "TripId": 8661
}

StoreTripDocumentRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "StoreTripDocumentRequest",
  "description": "A request to upload and atchive a document to a trip.",
  "type": "object",
  "required": [
    "TripId",
    "DocumentTypeId",
    "FileName",
    "FileContent",
    "FileLength"
  ],
  "properties": {
    "TripId": {
      "type": "integer"
    },
    "DocumentTypeId": {
      "type": "integer"
    },
    "FileName": {
      "type": "string"
    },
    "FileContent": {
      "description": "The file content encoded as a base 64 string.",
      "type": "string"
    },
    "FileLength": {
      "description": "The length of the file in byte.",
      "type": "number"
    }
  }
}

Beispiel

CODE
{
  "TripId": 5567,
  "DocumentTypeId": 43,
  "FileName": "Testfile.pdf",
  "FileContent": "JVBERi0xLjINJeLjz9MNCjMgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDUgDS9IIFsgNzYwIDE1NyBdIA0vTCAzOTA4IA0vRSAzNjU4I
A0vTiAxIA0vVCAzNzMxIA0+PiANZW5kb2JqDSAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB4cmVmD
TMgMTUgDTAwMDAwMDAwMTYgMDAwMDAgbg0KMDAwMDAwMDY0NCAwMDAwMCBuDQowMDAwMDAwOTE3IDAwMDAwIG4NCjAwMDAwMDEwNjggMDAwMDAgbg0KMDAwMDAwMTIyNCA
wMDAwMCBuDQowMDAwMDAxNDEwIDAwMDAwIG4NCjAwMDAwMDE1ODkgMDAwMDAgbg0KMDAwMDAwMTc2OCAwMDAwMCBuDQowMDAwMDAyMTk3IDAwMDAwIG4NCjAwMDAwMDIzO
DMgMDAwMDAgbg0KMDAwMDAwMjc2OSAwMDAwMCBuDQowMDAwMDAzMTcyIDAwMDAwIG4NCjAwMDAwMDMzNTEgMDAwMDAgbg0KMDAwMDAwMDc2MCAwMDAwMCBuDQowMDAwMDAw
ODk3IDAwMDAwIG4NCnRyYWlsZXINPDwNL1NpemUgMTgNL0luZm8gMSAwIFIgDS9Sb290IDQgMCBSIA0vUHJldiAzNzIyIA0vSURbPGQ3MGY0NmM1YmE0ZmU4YmQ0OWE5ZGQ
wNTk5YjBiMTUxPjxkNzBmNDZjNWJhNGZlOGJkNDlhOWRkMDU5OWIwYjE1MT5dDT4+DXN0YXJ0eHJlZg0wDSUlRU9GDSAgICAgIA00IDAgb2JqDTw8IA0vVHlwZSAvQ2F0YWx
vZyANL1BhZ2VzIDIgMCBSIA0vT3BlbkFjdGlvbiBbIDUgMCBSIC9YWVogbnVsbCBudWxsIG51bGwgXSANL1BhZ2VNb2RlIC9Vc2VOb25lIA0+PiANZW5kb2JqDTE2IDAgb2J
qDTw8IC9TIDM2IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggMTcgMCBSID4+IA1zdHJlYW0NCkiJYmBg4GVgYPrBAAScFxiwAQ4oLQDE3FDMwODHwKkyubctWLfmpsm
imQ5AEYAAAwC3vwe0DWVuZHN0cmVhbQ1lbmRvYmoNMTcgMCBvYmoNNTMgDWVuZG9iag01IDAgb2JqDTw8IA0vVHlwZSAvUGFnZSANL1BhcmVudCAyIDAgUiANL1Jlc291cmNl
cyA2IDAgUiANL0NvbnRlbnRzIDEwIDAgUiANL01lZGlhQm94IFsgMCAwIDYxMiA3OTIgXSANL0Nyb3BCb3ggWyAwIDAgNjEyIDc5MiBdIA0vUm90YXRlIDAgDT4+IA1lbmRvY
moNNiAwIG9iag08PCANL1Byb2NTZXQgWyAvUERGIC9UZXh0IF0gDS9Gb250IDw8IC9UVDIgOCAwIFIgL1RUNCAxMiAwIFIgL1RUNiAxMyAwIFIgPj4gDS9FeHRHU3RhdGUgPD
wgL0dTMSAxNSAwIFIgPj4gDS9Db2xvclNwYWNlIDw8IC9DczUgOSAwIFIgPj4gDT4+IA1lbmRvYmoNNyAwIG9iag08PCANL1R5cGUgL0ZvbnREZXNjcmlwdG9yIA0vQXNjZW5
0IDg5MSANL0NhcEhlaWdodCAwIA0vRGVzY2VudCAtMjE2IA0vRmxhZ3MgMzQgDS9Gb250QkJveCBbIC01NjggLTMwNyAyMDI4IDEwMDcgXSANL0ZvbnROYW1lIC9UaW1lc05ld
1JvbWFuIA0vSXRhbGljQW5nbGUgMCANL1N0ZW1WIDAgDT4+IA1lbmRvYmoNOCAwIG9iag08PCANL1R5cGUgL0ZvbnQgDS9TdWJ0eXBlIC9UcnVlVHlwZSANL0ZpcnN0Q2hhciA
zMiANL0xhc3RDaGFyIDMyIA0vV2lkdGhzIFsgMjUwIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL1RpbWVzTmV3Um9tYW4gDS9Gb250RGVzY3Jpc
HRvciA3IDAgUiANPj4gDWVuZG9iag05IDAgb2JqDVsgDS9DYWxSR0IgPDwgL1doaXRlUG9pbnQgWyAwLjk1MDUgMSAxLjA4OSBdIC9HYW1tYSBbIDIuMjIyMjEgMi4yMjIyMSA
yLjIyMjIxIF0gDS9NYXRyaXggWyAwLjQxMjQgMC4yMTI2IDAuMDE5MyAwLjM1NzYgMC43MTUxOSAwLjExOTIgMC4xODA1IDAuMDcyMiAwLjk1MDUgXSA+PiANDV0NZW5kb2JqD
TEwIDAgb2JqDTw8IC9MZW5ndGggMzU1IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlID4+IA1zdHJlYW0NCkiJdJDBTsMwEETv/oo92ohuvXHsJEeggOCEwDfEIU1SCqIJIimIv2dthyJV
QpGc0Xo88+xzL5beZ0DgN4IIq6oCzd8sK43amAyK3GKmTQV+J5YXo4VmjDYNYyOW1w8Ez6PQ4JuwfAkJyr+yXNgSSwt+NU+4Kp+rcg4uy9Q1a6MdarLcpgvUeUGh7RBFSLk1f1
n+5FgsHJaZttFqA+tKLJhfZ3kEY+VcoHuUfvui2O3kCL9COSwk1Ok3deMEd6srUCVa2Q7Nftf1Ewar5a4nfxuu4v59NcLMGAKXlcjMLtwj1BsTQCITUSK52cC3IoNGDnto6l5Vm
Ev4YAwjO8VWJ+s2DSeGttw/qmA/PZyLu3vY1p9p0MGZIs2iHdZxjwdNSkzedT0pJiW+CWl5H0O7uu2SB1JLn8rHlMkH2F+/xa20Rjp+nAQ39Ec8c1gz7KJ4T3H7uXnuwvSWl17
8CDAA/bGPlAplbmRzdHJlYW0NZW5kb2JqDTExIDAgb2JqDTw8IA0vVHlwZSAvRm9udERlc2NyaXB0b3IgDS9Bc2NlbnQgOTA1IA0vQ2FwSGVpZ2h0IDAgDS9EZXNjZW50IC0yM
TEgDS9GbGFncyAzMiANL0ZvbnRCQm94IFsgLTYyOCAtMzc2IDIwMzQgMTA0OCBdIA0vRm9udE5hbWUgL0FyaWFsLEJvbGQgDS9JdGFsaWNBbmdsZSAwIA0vU3RlbVYgMTMzIA
0+PiANZW5kb2JqDTEyIDAgb2JqDTw8IA0vVHlwZSAvRm9udCANL1N1YnR5cGUgL1RydWVUeXBlIA0vRmlyc3RDaGFyIDMyIA0vTGFzdENoYXIgMTE3IA0vV2lkdGhzIFsgMjc4ID
AgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgDTAgMCAwIDAgMCA3MjIgMCA2MTEgMCAwIDAgMCAwIDAgMCAwIDAgN
jY3IDAgMCAwIDYxMSAwIDAgMCAwIDAgMCANMCAwIDAgMCAwIDAgNTU2IDAgNTU2IDYxMSA1NTYgMCAwIDYxMSAyNzggMCAwIDAgODg5IDYxMSA2MTEgMCAwIA0wIDU1NiAzMzMg
NjExIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL0FyaWFsLEJvbGQgDS9Gb250RGVzY3JpcHRvciAxMSAwIFIgDT4+IA1lbmRvYmoNMTMgMCBvYmoN
PDwgDS9UeXBlIC9Gb250IA0vU3VidHlwZSAvVHJ1ZVR5cGUgDS9GaXJzdENoYXIgMzIgDS9MYXN0Q2hhciAxMjEgDS9XaWR0aHMgWyAyNzggMCAwIDAgMCAwIDAgMCAwIDAgMCAw
IDI3OCAwIDI3OCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCANMCAwIDAgNjY3IDAgMCAwIDAgMCAwIDAgMjc4IDAgMCAwIDAgMCAwIDAgMCA3MjIgMCAwIDAgMCAwIDAg
MCAwIA0wIDAgMCAwIDAgMCA1NTYgNTU2IDUwMCA1NTYgNTU2IDI3OCAwIDU1NiAyMjIgMCAwIDIyMiA4MzMgNTU2IDU1NiANNTU2IDAgMzMzIDUwMCAyNzggNTU2IDUwMCAwIDAg
NTAwIF0gDS9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nIA0vQmFzZUZvbnQgL0FyaWFsIA0vRm9udERlc2NyaXB0b3IgMTQgMCBSIA0+PiANZW5kb2JqDTE0IDAgb2JqDTw8IA0vV
HlwZSAvRm9udERlc2NyaXB0b3IgDS9Bc2NlbnQgOTA1IA0vQ2FwSGVpZ2h0IDAgDS9EZXNjZW50IC0yMTEgDS9GbGFncyAzMiANL0ZvbnRCQm94IFsgLTY2NSAtMzI1IDIwMjggMTA
zNyBdIA0vRm9udE5hbWUgL0FyaWFsIA0vSXRhbGljQW5nbGUgMCANL1N0ZW1WIDAgDT4+IA1lbmRvYmoNMTUgMCBvYmoNPDwgDS9UeXBlIC9FeHRHU3RhdGUgDS9TQSBmYWxzZSAN
L1NNIDAuMDIgDS9UUiAvSWRlbnRpdHkgDT4+IA1lbmRvYmoNMSAwIG9iag08PCANL1Byb2R1Y2VyIChBY3JvYmF0IERpc3RpbGxlciA0LjA1IGZvciBXaW5kb3dzKQ0vQ3JlYXRvci
AoTWljcm9zb2Z0IFdvcmQgOS4wKQ0vTW9kRGF0ZSAoRDoyMDAxMDgyOTA5NTUwMS0wNycwMCcpDS9BdXRob3IgKEdlbmUgQnJ1bWJsYXkpDS9UaXRsZSAoVGhpcyBpcyBhIHRlc3Qg
UERGIGRvY3VtZW50KQ0vQ3JlYXRpb25EYXRlIChEOjIwMDEwODI5MDk1NDU3KQ0+PiANZW5kb2JqDTIgMCBvYmoNPDwgDS9UeXBlIC9QYWdlcyANL0tpZHMgWyA1IDAgUiBdIA0vQ29
1bnQgMSANPj4gDWVuZG9iag14cmVmDTAgMyANMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAzNDI5IDAwMDAwIG4NCjAwMDAwMDM2NTggMDAwMDAgbg0KdHJhaWxlcg08PA0vU2l6ZS
AzDS9JRFs8ZDcwZjQ2YzViYTRmZThiZDQ5YTlkZDA1OTliMGIxNTE+PGQ3MGY0NmM1YmE0ZmU4YmQ0OWE5ZGQwNTk5YjBiMTUxPl0NPj4Nc3RhcnR4cmVmDTE3Mw0lJUVPRg0=",
  "FileLength": 3908
}

SetWaypointStateRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SetWaypointStateRequest",
  "description": "A request to set the state of a waypoint.",
  "type": "object",
  "required": ["WaypointId","WaypointStateId"],
  "properties": {
    "WaypointId": {
      "type": "integer"
    },
    "WaypointStateId": {
      "type": "integer"
    }
  }
}

Beispiel

CODE
{
  "WaypointId": 7641,
  "WaypointStateId": 4
}

SetWaypointTimesRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SetWaypointTimesRequest",
  "description": "A request to update the actual times of a waypoint.",
  "type": "object",
  "required": ["WaypointId"]
  "properties": {
    "WaypointId": {
      "type": "integer"
    },
    "Arrival": {
      "description": "DateTime of arrival, as string in ISO 8601 format.",
      "type": ["string", "null"]
    },
    "LoadingStart": {
      "description": "DateTime when loading began, as string in ISO 8601 format.",
      "type": ["string", "null"]
    },
    "LoadingEnd": {
      "description": "DateTime when loading ended, as string in ISO 8601 format.",
      "type": ["string", "null"]
    },
    "Departure": {
      "description": "DateTime of departure, as string in ISO 8601 format.",
      "type": ["string", "null"]
    }
  }
}

Beispiel

CODE
{
  "WaypointId": 7641,
  "Arrival": "2021-07-22T12:30:00"
}

UpdateWaypointBindingNetCargoKgCommandRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UpdateWaypointBindingNetCargoKgCommandRequest",
  "description": "A request to update the binding net cargo kg of the waypoint.",
  "type": "object",
  "required": ["WaypointId","Value"],
  "properties": {
    "WaypointId": 
    {
      "type": "integer",
      "description": "ID of the existing waypoint."
    },
    "Value":
    {
      "type": "number",
      "description": "Decimal value to update" 
    }
  }
}

Beispiel

CODE
{
    "WaypointId": 36,
    "Value": 21
}

UpdateWaypointTotalBindingCargoKgCommandRequest

Schema Definition

CODE
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "UpdateWaypointTotalBindingCargoKgCommandRequest",
  "description": "A request to update the total binding cargo kg of the waypoint.",
  "type": "object",
  "required": ["WaypointId","Value"],
  "properties": {
    "WaypointId": 
    {
      "type": "integer",
      "description": "ID of the existing waypoint."
    },
    "Value":
    {
      "type": "number",
      "description": "Decimal value to update" 
    }
  }
}

Beispiel

CODE
{
    "WaypointId": 36,
    "Value": 21
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.