syncPickups

post

https://rz3.aeb.de/demo1cai/rest/DLCarrierBFBean/syncPickups

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

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

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

ageInDays

int32

Initializes the delta transmission of pickups (syncId must be null). Only pickups with this age or younger will be synchronized. Relevant date is the shipping date.

If this field is 0, synchronization starts with all pickups.

length=10

syncId

string

For delta-transmissions after initialization (ageInDays must be null).

Fill this field with the DLSyncShipmentPickupsResponseDTO.syncId returned in the last call of synchPickups. As initial value use 0 or 1.

length=20

includeDocuments

boolean

Controls, if the documents should be included in the response. Default is 'false'.

includeDriverSignature

boolean

Controls, if the signature of the driver should be included in the response. Default is 'false'.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response