getRejectedRoutingTaskResult

post https://rz3.aeb.de/demo1routing/rest/RoutingBFBean/getRejectedRoutingTaskResult

Returns a sorted list of the rejected proposals for the provided task id and its current calculation state.
The rejected proposals are those proposals which were filtered out according to the settings in the rating profile.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).

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

taskId

string

required

The task id is a unique value that was generated for requesting the results of the according routing task. It is returned when the the routing task is created.

length=50

Response

Response body

object

hasErrors

boolean

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

hasOnlyRetryableErrors

boolean

True, if there are any error messages.

Error details are provided in the messages[] array.

hasWarnings

boolean

True, if there are any error messages.

Error details are provided in the messages[] array.

messages

array of objects

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

messages

object

messageType

string

Message type

If not stated otherwise, the possible types are:

ERROR
WARNING
INFO

Maximum length: 50

messageIdentCode

string

Optional identification code for further classification of the message type.

Maximum length: 50

messageTexts

array of objects

Detailed message texts in the requested languages.

messageTexts

object

languageISOCode

string

2-letter ISO code of the language.

length=2

text

string

The translated text.

indentationLevel

int32

The indentation level of the message.

'0' indicates a top level message.

routingTaskResult

object

Contains a list of ranked proposals and information on the current calculation status for for the routing task with the given taskId.

state

string

required

State of current proposal calculation, it can have the following states:
- INPROGRESS: proposals (and ordering) might change in future calls.
- COMPLETE: ordering and entries fixed, all supplements calculated.

taskId

string

required

Unique taskId of the routing task.

length=50

referenceNumber

string

The reference number for the routing task.

length=50

supportedSupplementTypes

array of objects

required

List of supported supplements types that are calculated for this routing task.

supportedSupplementTypes*

object

name

string

required

Unique name of supplement

length=50

dataType

string

required

Class short name of SupplementDataDTO e.g. 'StarRatingSupplementDataDTO'

supportedScheduleType

object

Holds a reference of a schedule configuration.

proposals

array of objects

List of proposals calculated by the Routing engine. Depending on the state, sorting and/or supplements within the proposals might change. The proposals might be empty - even if the calculation has been executed successfully. This depends on the individual service allocations and on the filter settings within the rating profile used for this request.

proposals

object

legs

array of objects

required

The legs ('parts') of a whole transport chain. Typically only one element.

legs*

object

serviceProviderIdentCode

string

required

IdentCode of the service provider.

length = 20 <\p>

serviceIdentCode

string

required

IdentCode of the service

length = 20 <\p>

vasIdentCodes

array of strings

Array of identCodes of value added services.

length = 20 <\p> per ident code

vasIdentCodes

serviceInfoTextIdentCodes

array of strings

Array of identCodes of info texts

length = 20 <\p> per ident code

serviceInfoTextIdentCodes

supplements

array of objects

Array of supplements for this leg proposal.

supplements

object

name

string

required

Name of this supplement as configured the Routing Engine.

state

string

required

Calculation state of this supplement. Can have the following values:
- PROCESSED: Calculation is complete and has valid values.
- ABORTED: Carrier Select returns an exception.
- ERROR: An error was occurred in the subsequent systems. E.g. Logistics Cost Management.

dataType

string

required

Data type contains (simple) name of class of the data holding field in RoutingSupplementDataDTO, i.e.

ServiceVasValidationSupplementDataDTO
PricingSupplementDataDTO
StarRatingSupplementDataDTO
ValueRatingSupplementDataDTO

additionalInfo

array of objects

Additional information about the supplement. Depending on the kind of supplement a text with short and valuable content about the supplement. e.g. additional Information about prices, availabilty or errors that occured.

length of the translated text=280

additionalInfo

object

languageISOCode

string

2-letter ISO code of the language.

length=2

text

string

The translated text.

data

object

Container class for all supplement dependent data for BF. Contains additional data calculated by respective adapters based on a proposal for a routing task. Depending on the type of individual supplements, the data is hold in its respective field. Only one field may be filled at the same time.

startHop

object

required

Representation of an handover point

Has additional fields

endHop

object

required

Representation of an handover point

Has additional fields

legSchedule

object

DTO to provide a leg of a route schedule calculation. It's values are filled depending on the calculation state and the calculation mode.

internalId

string

The unique ID of the leg proposal. Can be used to uniquely identify the leg proposal when requesting the routing task results several times. This is a temporary, unique ID. In very rare cases you may get a different unique ID for the same proposal and same taskId (after server restart).

score

number

required

Score of the proposal. Proposals may have equal score if they are ranked as equal by the rating profile.
length = 15
scale = 3

sortNumber

int32

required

Sort number of the proposal. Unique among the proposals of a fixed routing task result.
length = 10

effectiveSupplements

array of objects

Array of supplements for this routing proposal.

effectiveSupplements

object

name

string

required

Name of this supplement as configured the Routing Engine.

state

string

required

dataType

string

required

Data type contains (simple) name of class of the data holding field in RoutingSupplementDataDTO, i.e.

ServiceVasValidationSupplementDataDTO
PricingSupplementDataDTO
StarRatingSupplementDataDTO
ValueRatingSupplementDataDTO

additionalInfo

array of objects

length of the translated text=280

additionalInfo

object

languageISOCode

string

2-letter ISO code of the language.

length=2

text

string

The translated text.

data

object

routeSchedule

object

DTO to provide a result of a schedule calculation. It's values are filled depending on the calculation state and the calculation mode.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://rz3.aeb.de/demo1routing/rest/RoutingBFBean/getRejectedRoutingTaskResult \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

defaultdefault response