---
updatedAt: 2026-05-27T04:03:57.000Z
agentTools:
projectIndex: https://transport-freight-management.docs.developers.aeb.com/llms.txt
---
# waitForRoutingTaskResult
Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state.
If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached.
The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.
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).
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Carrier Select HTTP API",
"description": "Thank you for using our HTTP API documentation.",
"version": "1.0"
},
"servers": [
{
"url": "https://rz3.aeb.de/demo1routing/rest"
}
],
"security": [
{
"SWAGGER_AUTH_KEY": []
},
{
"BASIC_AUTH": []
}
],
"tags": [
{
"name": "Routing",
"description": "API for the handling of routing tasks"
}
],
"paths": {
"/RoutingBFBean/waitForRoutingTaskResult": {
"post": {
"tags": [
"Routing"
],
"summary": "waitForRoutingTaskResult",
"description": "Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state.
If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached.
The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.
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).
",
"operationId": "waitForRoutingTaskResult",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WaitForRoutingTaskResultRequestDTO"
},
"examples": {
"Basic data": {
"description": "Basic data",
"value": {
"clientSystemId": "MY_SYSTEM",
"clientIdentCode": "MY_CLIENT",
"userName": "MY_USERNAME",
"resultLanguageIsoCodes": [
"de"
],
"taskId": "MY_ROUTING_TASK_ID",
"waitingTimeoutInSeconds": 10
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/WaitForRoutingTaskResultRequestDTO"
},
"examples": {
"Basic data": {
"description": "Basic data",
"value": {
"clientSystemId": "MY_SYSTEM",
"clientIdentCode": "MY_CLIENT",
"userName": "MY_USERNAME",
"resultLanguageIsoCodes": [
"de"
],
"taskId": "MY_ROUTING_TASK_ID",
"waitingTimeoutInSeconds": 10
}
}
}
}
}
},
"responses": {
"default": {
"description": "default response",
"content": {
"application/json": {},
"application/xml": {}
}
}
},
"security": [
{
"BASIC_AUTH": []
}
]
}
}
},
"components": {
"schemas": {
"WaitForRoutingTaskResultRequestDTO": {
"type": "object",
"description": "Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.",
"properties": {
"clientSystemId": {
"type": "string",
"description": "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
",
"example": "TEST_ID"
},
"clientIdentCode": {
"type": "string",
"description": "Client identification code.
Maximum length: 10
",
"example": "APITEST"
},
"userName": {
"type": "string",
"description": "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.
",
"example": "API_TEST"
},
"resultLanguageIsoCodes": {
"type": "array",
"description": "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.
",
"example": [
"en",
"de"
],
"items": {
"type": "string"
}
},
"taskId": {
"type": "string",
"description": "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
"
},
"waitingTimeoutInSeconds": {
"type": "integer",
"format": "int32",
"description": "Waiting timeout in seconds. It indicates how long the response is going to take in case the routing task is not finished yet.",
"maximum": 10
}
},
"required": [
"taskId",
"waitingTimeoutInSeconds"
]
}
},
"securitySchemes": {
"SWAGGER_AUTH_KEY": {
"type": "apiKey",
"name": "X-XNSG_WEB_TOKEN",
"in": "header"
},
"BASIC_AUTH": {
"type": "http",
"scheme": "basic"
}
}
},
"x-proxy-enabled": false
}
```