syncConsignments

post

https://rz3.aeb.de/demo1ma/rest/LISBF20Bean/syncConsignments

Allows the synchronization of client system transactions with the engine consignments. By the use of a syncId it is possible to return only consignments that have changed between two syncConsignment calls.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request DTO for consignment synchronization.

clientSystemId

string

Id of the sending client system.

e.g. Installation id of AEB systems.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

syncId

string

For delta-transmissions after initialization.
Fill this field with the syncId returned in the last call of syncConsignments.

length=20

dataExtent

array of strings

Parameter used to request additional data for a consignment. If left empty, only header data for a consignment will be returned.

Possible values: INCLUDE_TRACKINGINFO, INCLUDE_CONSIGNMENT_ITEMS, INCLUDE_TRANSPORTS, INCLUDE_HANDLING_UNITS, INCLUDE_CONSIGNMENT_EVENTS, INCLUDE_TRACKING_EVENTS, INCLUDE_DOCUMENTS, INCLUDE_HU_TRANSPORTS

dataExtent

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultdefault response