length of the translated text=280
items: $ref: '#/components/schemas/TextInLanguageDTO' earliestShippingDate: $ref: '#/components/schemas/DateAndZoneDTO' latestShippingDate: $ref: '#/components/schemas/DateAndZoneDTO' earliestDeliveryDate: $ref: '#/components/schemas/DateAndZoneDTO' latestDeliveryDate: $ref: '#/components/schemas/DateAndZoneDTO' internalId: type: string description: The unique ID of the route schedule. Can be used to uniquely identify the route schedule 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 route schedule and same taskId (after server restart). description: DTO to provide a result of a schedule calculation. It's values are filled depending on the calculation state and the calculation mode. BillingAdditionalFreightCalculationDataDTO: type: object properties: modeOfTransportIdentCode: type: string description: Identifier for the mode of transport. Can be empty, if not needed or if it is not known. distance: $ref: '#/components/schemas/QuantityDTO' goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' numberOfDeliveryNotes: type: integer description: represents the number of delivery notes. format: int32 numberOfInvoices: type: integer description: represents the number of invoices. format: int32 cusBillingFields: type: array description: Custom fields for Logistics Cost Management. Every custom field must also be defined in Logistics Cost Management in a structured type of a Smart-Rules module with the same field name and type. items: $ref: '#/components/schemas/CusBillingFieldDTO' description: The BillingAdditionalFreightCalculationDataDTO provides data to send to Logistics Costs Management. It fills some fields BFreightTransportExtendedDataDTO, but not all. In addition it provides a list of custom fields which must be also customized with the same field name in Logistics Costs Management. RoutingTaskLocationDTO: type: object properties: address: $ref: '#/components/schemas/RoutingAddressDTO' hopRef: $ref: '#/components/schemas/HopReferenceDTO' description: Class for location based routing task data for BF. Contains data of a complete address or a reference to a hand over point and its location/address in the master data. Either the address or the hopRef is required, the other value must be null. RatingProfileDTO: required: - identCode type: object properties: identCode: type: string description: Ident code of the rating profilelength = 50
descriptions: type: array description: Multi-language descriptions of this RatingProfile items: $ref: '#/components/schemas/TextInLanguageDTO' description: DTO representation of a rating profile RoutingTaskHandlingUnitDTO: required: - handlingUnitType - numberOfHandlingUnits - singleDimensions - singleGrossWeight type: object properties: numberOfHandlingUnits: type: integer description: Number of handling units. Maximum value is 999.length=3
format: int32 singleGrossWeight: $ref: '#/components/schemas/QuantityDTO' singleDimensions: $ref: '#/components/schemas/CuboidDimensionsDTO' handlingUnitType: type: string description: The identCode of the handling unit type. length=35 dangerousGoodsCode: $ref: '#/components/schemas/DangerousGoodsCodeDTO' description: Basic data of a handling unit which shall be transported as defined in the RoutingTaskDTO. CarrierDTO: required: - identCode type: object properties: identCode: type: string description: Ident code of a carrierlength = 20
services: type: array description: Array of identCodes of services.length = 20 <\p> per ident code items: $ref: '#/components/schemas/ServiceInfoDTO' valueAddedServices: type: array description: Array of identCodes of value added services.
length = 20 <\p> per ident code
items:
$ref: '#/components/schemas/ValueAddedServiceDTO'
description: Representation of a carrier.
ServiceVasValidationSupplementDataDTO:
required:
- validationResult
type: object
properties:
validationResult:
type: string
description: 'Possible values: OK, UNDEFINED, REJECTED'
description: Result of validation
ServiceDTO:
required:
- serviceIdentCode
- serviceProviderIdentCode
type: object
properties:
serviceIdentCode:
type: string
description: The ID of the service.
serviceProviderIdentCode:
type: string
description: The ID of the provider.
vasIdentCodes:
type: array
description: The IDs of the value added services.
items:
type: string
description: The IDs of the value added services.
description: Representation of a service classified by a service code, a provider code and value-added service codes.
This DTO is used in context of creating a SupplementTask.
GetRoutingTaskResultRequestDTO:
required:
- taskId
type: object
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 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"]' 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
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. GetRoutingRequirementTypesRequestDTO: type: object 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 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"]' description: Request DTO to access all requirement types configured for the given target client in the Routing engine. RoutingSupplementTypeDTO: required: - dataType - name type: object properties: name: type: string description: Unique name of supplementlength=50
dataType: type: string description: Class short name of SupplementDataDTO e.g. 'StarRatingSupplementDataDTO' description: Each supplement is characterized by a unique name defined by the user and its dataType. It defines one type of supplement. RoutingProposalDTO: required: - legs - score - sortNumber type: object properties: legs: type: array description: The legs ('parts') of a whole transport chain. Typically only one element. items: $ref: '#/components/schemas/RoutingLegProposalDTO' score: type: number description: 'Score of the proposal. Proposals may have equal score if they are ranked as equal by the rating profile.Value of the custom field.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
length = 20 <\p> serviceIdentCode: type: string description: IdentCode of the service
length = 20 <\p> vasIdentCodes: type: array description: Array of identCodes of value added services.
length = 20 <\p> per ident code items: type: string description: Array of identCodes of value added services.
length = 20 <\p> per ident code serviceInfoTextIdentCodes: type: array description: Array of identCodes of info texts
length = 20 <\p> per ident code items: type: string description: Array of identCodes of info texts
length = 20 <\p> per ident code
supplements:
type: array
description: Array of supplements for this leg proposal.
items:
$ref: '#/components/schemas/RoutingSupplementDTO'
startHop:
$ref: '#/components/schemas/HopDTO'
endHop:
$ref: '#/components/schemas/HopDTO'
legSchedule:
$ref: '#/components/schemas/RouteLegScheduleDTO'
internalId:
type: string
description: 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).
description: Describes one leg ('part') of a whole transport chain. The entirety of legs describes a set of services of one proposal. In case of direct simple routing, a proposal contains only one leg.
RoutingRequirementDTO:
required:
- requirementCode
- requirementType
type: object
properties:
requirementType:
type: string
description: 'Type of requirement.
for example: serviceLevel, mode of transport, special treatment COD, insurance
length=50
' requirementCode: type: string description: 'Name of requirement.length=50
' description: Representation of a requirement, classified by a requirement type and a requirement code.length=50
description: Holds the value rating. WaitForRoutingTaskResultRequestDTO: required: - taskId - waitingTimeoutInSeconds type: object 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 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"]' 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 description: Waiting timeout in seconds. format: int32 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. RoutingScheduleTypeDTO: type: object properties: configurationIdentCode: type: string description: The configuration ident code for the schedule configuration. Filled when a schedule calculation was configured in the rating profile.length=50
description: Holds a reference of a schedule configuration. AmountOfMoneyDTO: type: object properties: value: type: number description: The value of the amount of money.length=15, scale=2
currencyIso: type: string description: The three letter ISO code of the currency of the amount of money.length=3
description: An amount of money with a value and an currency ISO code. GetRoutingTaskResultResponseDTO: type: object properties: hasErrors: type: boolean description: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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' routingTaskResult: $ref: '#/components/schemas/RoutingTaskResultDTO' description: Response DTO of a routing task request. CreateRoutingTaskRequestDTO: required: - routingTask type: object 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 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"]' routingTask: $ref: '#/components/schemas/RoutingTaskDTO' description: Request DTO for create routing task. HopReferenceDTO: required: - identCode type: object properties: identCode: type: string description: 'IdentCode of the hand over pointId 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 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"]' description: Request DTO to access all handover points existing for the given target client in the Routing engine. GetAllCarriersRequestDTO: type: object 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 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"]' description: Request DTO to access all carriers existing for the given target client in the Routing engine. HopDTO: type: object description: Representation of an handover point HandoverPointDTO: required: - address - identCode type: object properties: identCode: type: string description: Ident code of the handover pointlength = 50
descriptions: type: array description: Multi-language descriptions of the handover point items: $ref: '#/components/schemas/TextInLanguageDTO' address: $ref: '#/components/schemas/RoutingAddressDTO' description: Representation of an handover point. RoutingAddressDTO: required: - city - countryISOCode - name - referenceCode - street type: object properties: referenceCode: type: string description: Reference code,length=50
name: type: string description: First address linelength=40
street: type: string description: Street (line 1) of the address. Is required because some validation requires streets.length=40
postcode: type: string description: Postcode of the address. Postcode is checked with the postcode format of the given country.length=10
city: type: string description: City of the address.length=40
countryISOCode: type: string description: Country of addresslength=2
stateRegion: type: string description: The state or regionlength=40
description: DTO to provide address data RoutingRequirementInTypeDTO: required: - identCode type: object properties: identCode: type: string description: Unique identification code of this requirementlength=50
descriptions: type: array description: Multi-language descriptions of this requirement items: $ref: '#/components/schemas/TextInLanguageDTO' description: DTO representation of a routing requirement contained in a routing requirement type.length=50
routingParms: $ref: '#/components/schemas/RoutingParmsDTO' handlingUnits: type: array description: The handling units of the routing task. items: $ref: '#/components/schemas/RoutingTaskHandlingUnitDTO' parties: type: array description: 'The parties of the routing task. ' items: $ref: '#/components/schemas/RoutingPartyDTO' startLocation: $ref: '#/components/schemas/RoutingTaskLocationDTO' endLocation: $ref: '#/components/schemas/RoutingTaskLocationDTO' decisiveDate: type: string description: The string representation of the Date in the format yyyy-MM-dd. The date is used when it comes to exclude configuration elements that have a validity date.length=10
readyForShippingDate: $ref: '#/components/schemas/DateAndZoneDTO' confirmedDeliveryDate: $ref: '#/components/schemas/DateAndZoneDTO' termsOfDeliveryCode: type: string description: The clients terms of delivery code. Value is not checked in routing but will be checked in carrier validation and is probably needed for freight calculation. *length=20
requirements: type: array description: The requirements of the routing task. items: $ref: '#/components/schemas/RoutingRequirementDTO' isDocumentShipment: type: boolean description: Indicates whether the routing task is a document shipment or goods shipment.length=15, scale = 3
palletPlaces: type: number description: The pallet places of the routing task.length=15, scale = 3
addFreightCalculationData: $ref: '#/components/schemas/BillingAdditionalFreightCalculationDataDTO' procedureIndicator: type: string description: (Special) procedure indicator. deliveryPriority: type: string description: Delivery priority or delivery condition. shippingCondition: type: string description: Shipping condition. description: The RoutingTaskDTO is the main representation of a routing task. The data describes a set of different handling units which shall be transported in one process. Additionally, involved parties, important dates, requirements and other parameters of the request are stored within this DTO.length=50
routingParms: $ref: '#/components/schemas/RoutingParmsDTO' handlingUnits: type: array description: The handling units of the supplement task. items: $ref: '#/components/schemas/RoutingTaskHandlingUnitDTO' parties: type: array description: 'The parties of the supplement task. ' items: $ref: '#/components/schemas/RoutingPartyDTO' startLocation: $ref: '#/components/schemas/RoutingTaskLocationDTO' endLocation: $ref: '#/components/schemas/RoutingTaskLocationDTO' decisiveDate: type: string description: The string representation of the Date in the format yyyy-MM-dd. The date is used when it comes to exclude configuration elements that have a validity date.length=10
readyForShippingDate: $ref: '#/components/schemas/DateAndZoneDTO' confirmedDeliveryDate: $ref: '#/components/schemas/DateAndZoneDTO' termsOfDeliveryCode: type: string description: The clients terms of delivery code. Value is not checked in routing but will be checked in carrier validation and is probably needed for freight calculation. *length=20
isDocumentShipment: type: boolean description: Indicates whether the supplement task is a document shipment or goods shipment.length=15, scale = 3
palletPlaces: type: number description: The pallet places of the supplement task.length=15, scale = 3
addFreightCalculationData: $ref: '#/components/schemas/BillingAdditionalFreightCalculationDataDTO' service: $ref: '#/components/schemas/ServiceDTO' procedureIndicator: type: string description: (Special) procedure indicator. deliveryPriority: type: string description: Delivery priority or delivery condition. shippingCondition: type: string description: Shipping condition. description: The SupplementTaskDTO is the main representation of a supplement task. The data describes a set of different handling units which shall be transported in one process. Additionally, involved parties, important dates and other parameters of the request are stored within this DTO.length = 20
description: Representation of a value-added service. DangerousGoodsCodeDTO: required: - handlingCode type: object properties: handlingCode: type: string description: "Indicates the type of dangerous goods Valid values are:length=50
description: Detailed settings for proposal, supplement and ranking calculations. RouteLegScheduleDTO: type: object properties: earliestShippingDate: $ref: '#/components/schemas/DateAndZoneDTO' latestShippingDate: $ref: '#/components/schemas/DateAndZoneDTO' earliestDeliveryDate: $ref: '#/components/schemas/DateAndZoneDTO' latestDeliveryDate: $ref: '#/components/schemas/DateAndZoneDTO' description: DTO to provide a leg of a route schedule calculation. It's values are filled depending on the calculation state and the calculation mode. GetRoutingRequirementTypesResponseDTO: type: object properties: hasErrors: type: boolean description: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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' types: type: array description: List of all requirement types available for the target client as configured in the Routing engine. items: $ref: '#/components/schemas/RoutingRequirementTypeDTO' description: ResponseDTO for a request of requirement types. GetHandoverPointsResponseDTO: type: object properties: hasErrors: type: boolean description: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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' handoverPoints: type: array description: List of all handover points available for the target client as configured in the Routing engine. items: $ref: '#/components/schemas/HandoverPointDTO' description: ResponseDTO for an access request of handover points. RoutingPartyDTO: required: - address - partyRole type: object properties: address: $ref: '#/components/schemas/RoutingAddressDTO' partyRole: type: string description: 'Role of the location, might be shipping point, consignee.
Possible values are: (may be more in the future).
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 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"]' taskId: type: string description: The task id is a unique value that was generated for requesting the results of the according supplement task. It is returned when the the supplement task is created.length=50
description: Request DTO to get the current calculation status for the supplement task defined by the provided task id. QuantityDTO: type: object properties: value: multipleOf: 0.001 maximum: 999999999999.999 type: number description: The value of the quantity. unit: maxLength: 10 type: string description: " \t\t\tIdentifier of the quantity unit. Use quantity units known from your AEB application or alternatively domain specific or legacy quantity codes, but not the UNECE code.\n \t\t\tFor UNECE unit codes use the 'uneceUnit' field, if supported.\n\n \t\t\tWeight unit codes:\n \t\t\t* kg - Kilogram\n \t* gr - Gram\n \t* t - Metric ton\n \t* lb - Pound\n \t* oz - Ounce\n\n \tLength unit codes:\n \t* m - Meter\n \t* mm - Milimeter\n \t* cm - Centimeter\n \t* dm - Decimeter\n \t* km - Kilometer\n \t* ft - Foot\n \t* in - Inch\n \t* mi - Mile\n \t* nm - Nanometer\n \t* µm - Micrometer\n\n \tVolume unit codes:\n \t* ccm - Cubic centimeter\n \t* cdm - Cubic decimeter\n \t* m3 - Cubic meter\n \t* ml - Milliliter\n \t* cl - Centiliter\n \t* hl - Hectoliter\n \t* l - Liter\n \t* cuin - Cubic inch\n \t* cuft - Cubic foot\n\n \tQuantity unit codes:\n \t* St - Piece\n \t* Paar - Pair\n\n \tDensity unit codes:\n \t* g/ccm - grams per cubic centimeter\n \t* kg/m3 - kilogram per cubic meter\n\n \tTime unit codes:\n \t* h - Hour\n \t* stu - Hour\n \t* std - Hour\n \t* oph - Operational hour\n \t* s - Second\n \t* min - Minute\n \t* 15m - 15 mins\n \t* d - Day\n \t* tag - Day\n \t* wch - Week\n \t* mon - Month\n \t* jhr - Year\n \t* mis - Millisecond\n \t* ms - Microsecond\n \t* ns - Nanosecond\n \t* ps - Picosecond\n\n \tArea unit codes:\n \t\t\t* qm - Square meter\n \t* qmm - Square millimeter\n \t* qcm - Square centimeter\n \t* qdm - Square decimeter\n" example: kg uneceUnit: maxLength: 3 type: string description: " \t\t\tIdentifier of the quantity unit based on 'Recommendation No. 20 - Units of Measure used in International Trade'.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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' profiles: type: array description: List of all rating profiles available for the target client as configured in the Routing engine. items: $ref: '#/components/schemas/RatingProfileDTO' description: ResponseDTO for an access request of rating profiles. ServiceInfoDTO: required: - identCode type: object properties: identCode: type: string description: Ident code of the servicelength = 20
description: DTO to provide service data SupplementTaskResultDTO: required: - service - state - supportedSupplementTypes - taskId type: object properties: state: type: string description: 'Possible states of calculation are:length=50
referenceNumber: type: string description: The reference number for the supplement task.length=50
service: $ref: '#/components/schemas/ServiceDTO' routeSchedule: $ref: '#/components/schemas/RouteScheduleDTO' supplements: type: array description: List of supplements for this service. items: $ref: '#/components/schemas/RoutingSupplementDTO' supportedSupplementTypes: type: array description: List of supported supplements types that are calculated for this supplement task. items: $ref: '#/components/schemas/RoutingSupplementTypeDTO' description: Contains a list of calculated supplements and information on the current calculation status for for the routing task with the given taskId. CreateRoutingTaskResponseDTO: type: object properties: hasErrors: type: boolean description: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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' taskId: type: string description: The taskId is a unique value that is generated for a requested routing task. Use this taskId to request the calculation result in a separate call of getRoutingTaskResult(GetRoutingTaskResultRequestDTO).length=50
description: Response DTO for create routing rask. RoutingRequirementTypeDTO: required: - identCode - requirements type: object properties: identCode: type: string description: Unique requirement type ident code.length=50
descriptions: type: array description: Multi-language descriptions for this type items: $ref: '#/components/schemas/TextInLanguageDTO' requirements: type: array description: Routing requirements contained in this type items: $ref: '#/components/schemas/RoutingRequirementInTypeDTO' description: DTO representation of a routing requirement type.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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' taskId: type: string description: The taskId is a unique value that is generated for a requested supplement task. Use this taskId to request the calculation result in a separate call of getSupplementTaskResult(GetSupplementTaskResultRequestDTO).length=50
description: Response DTO for create supplement task. PricingSupplementDataDTO: required: - currencyIsoCode - settlementPrices - value type: object properties: currencyIsoCode: type: string description: Currency of calculated price in client currency.String representation of the date/time stamp in the format yyyy-MM-dd HH:mm:ss
Length: 19
' timezone: type: string description: 'Time zone of the time stamp.
Examples of valid time zones: "GMT+01:00" or "GMT-02:00".
Maximum length: 50
' description: Date and timezone. GetSupplementTaskResultResponseDTO: type: object properties: hasErrors: type: boolean description: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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' supplementTaskResult: $ref: '#/components/schemas/SupplementTaskResultDTO' description: Response DTO of a supplement task request. RoutingTaskResultDTO: required: - state - supportedSupplementTypes - taskId type: object properties: state: type: string description: 'State of current proposal calculation, it can have the following states:length=50
referenceNumber: type: string description: The reference number for the routing task.length=50
supportedSupplementTypes: type: array description: List of supported supplements types that are calculated for this routing task. items: $ref: '#/components/schemas/RoutingSupplementTypeDTO' supportedScheduleType: $ref: '#/components/schemas/RoutingScheduleTypeDTO' proposals: type: array description: 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. items: $ref: '#/components/schemas/RoutingProposalDTO' description: Contains a list of ranked proposals and information on the current calculation status for for the routing task with the given taskId. GetAllCarriersResponseDTO: type: object properties: hasErrors: type: boolean description: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.
example: false hasOnlyRetryableErrors: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true hasWarnings: type: boolean description:True, if there are any error messages.
Error details are provided in the messages[] array.
example: true messages: type: array description:Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
items: $ref: '#/components/schemas/ResponseMessageDTO' carriers: type: array description: List of all carriers available for the target client as configured in the Routing engine. items: $ref: '#/components/schemas/CarrierDTO' description: ResponseDTO for an access request of carriers. RoutingSupplementDTO: required: - dataType - name - state type: object properties: name: type: string description: Name of this supplement as configured the Routing Engine. state: type: string description: 'Calculation state of this supplement. Can have the following values:length of the translated text=280
items: $ref: '#/components/schemas/TextInLanguageDTO' data: $ref: '#/components/schemas/RoutingSupplementDataDTO' description: This supplement DTO is a container for additional information. One proposal can have multiple supplements. Supplements are calculated individually. A routing task can have multiple proposals whose supplements may not be synchronously calculated. GetRatingProfilesRequestDTO: type: object 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 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"]' description: Request DTO to access all rating profiles configured for the given target client in the Routing engine. CreateSupplementTaskRequestDTO: required: - supplementTask type: object 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 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"]' supplementTask: $ref: '#/components/schemas/SupplementTaskDTO' description: Request DTO for create supplement task. RoutingSupplementDataDTO: type: object properties: validationData: $ref: '#/components/schemas/ServiceVasValidationSupplementDataDTO' pricingData: $ref: '#/components/schemas/PricingSupplementDataDTO' starRatingData: $ref: '#/components/schemas/StarRatingSupplementDataDTO' valueRatingData: $ref: '#/components/schemas/ValueRatingSupplementDataDTO' description: 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. CuboidDimensionsDTO: type: object properties: length: type: number description: Represents the length of the dimensions.2-letter ISO code of the language.
length=2
example: en text: type: string description: The translated text. example: Some free-form text description: A translated text in one of the specified languages. ResponseMessageDTO: type: object properties: messageType: type: string description: 'Message type
If not stated otherwise, the possible types are:
Maximum length: 50
' example: WARNING messageIdentCode: type: string description: 'Optional identification code for further classification of the message type.
Maximum length: 50
' example: '5627' messageTexts: type: array description:Detailed message texts in the requested languages.
items: $ref: '#/components/schemas/TextInLanguageDTO' indentationLevel: type: integer description:The indentation level of the message.
'0' indicates a top level message.
format: int32 example: 0 description: Result messages like errors or warnings. securitySchemes: SWAGGER_AUTH_KEY: type: apiKey name: X-XNSG_WEB_TOKEN in: header BASIC_AUTH: type: http scheme: basic x-refined-from: - aeb-bsm-openapi.json - aeb-carrier-select-openapi.json x-proxy-enabled: false