synchronizeResolvedEvents

post

https://xnsg.dc.aeb.com/demo1ces/rest/CarrierEventServiceBFBean/synchronizeResolvedEvents

Synchronizes all resolved events that have occurred since the last synchronization call.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

DTO with parms to synchronize resolved events

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

syncId

string

length ≤ 20

Synchronization ID for delta-transmission.

Pass this field with the value returned in SynchronizeResolvedEventsResponseDTO's syncId. For initializing of delta-transmissions pass simply null and use ageInDays.

length=20

ageInDays

int32

Only for the initializing of delta-transmissions (if SynchronizeResolvedEventsRequestDTO's syncId is null) this field has to be passed.

Start the initializing of delta transmission with this age. Older events will not be synchronized. Journal entries are deleted after 30 days. Events whose processing lies further in the past are no longer synchronized.

blockSize

int32 | null

Defaults to 200

For defining the block size. Can be null. If empty the default block size of 200 is used.

isStandardEventTextIncluded

boolean

Defaults to false

Controls, if the name and description that explain the identCode of the event is included in the response. If this option is set to true, there will be a name and a description for each requested language.

isOriginalDescriptionIncluded

boolean

Defaults to false

Controls, if the description of the carriers codelist that explain the originalIdentCode and originalReason of the event is included in the response. If this option is set to true, there will be a description in the language that depends on the carrier.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

defaultdefault response