syncShipments or getShipments call.",
"operationId" : "createShipment",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreateShipmentRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreateShipmentRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreateShipmentResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreateShipmentResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/deleteItem" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "deleteItem",
"description" : "Deletes an existing item. Packages containing items remain in the shipment and can be packed again with processShipment. Deleting a item is not always possible. It mainly depends on the status of the package containing the item and the shipment.",
"operationId" : "deleteItem",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeleteItemRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeleteItemRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeleteItemResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeleteItemResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/deletePackage" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "deletePackage",
"description" : "Deletes an existing package. Packed items remain unpacked in the shipment and can be packaged again with processShipment. Deleting a package is not always possible. It mainly depends on the status of the package and the shipment.",
"operationId" : "deletePackage",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePackageRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePackageRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePackageResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePackageResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/deletePickup" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "deletePickup",
"description" : "Cancels an existing pickup. All shipments are removed from the pickup and must be assigned to a new pickup by another createPickup call.processPackage call, a syncShipments or getShipments call.",
"operationId" : "processPackage",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/processPackageReturnEnclosedLabel" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "processPackageReturnEnclosedLabel",
"description" : "Returns a return enclosed label in case of a return shipment.",
"operationId" : "processPackageReturnEnclosedLabel",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageReturnEnclosedLabelRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageReturnEnclosedLabelRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageReturnEnclosedLabelResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPackageReturnEnclosedLabelResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/processPickup" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "processPickup",
"description" : "Prints or reprints the manifest documents for the pickup. Mainly to be used, when manifest documents were not printed with the createPickup call or if a reprint of the documents is necessary.",
"operationId" : "processPickup",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPickupRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPickupRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPickupResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessPickupResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/processShipment" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "processShipment",
"description" : "Allows to add packages or perform various operations on an existing shipment. Especially document preparation and document (label) output can be triggered.syncShipments or getShipments call.",
"operationId" : "processShipment",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessShipmentRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessShipmentRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessShipmentResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLProcessShipmentResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/syncPickups" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "syncPickups",
"description" : "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.",
"operationId" : "syncPickups",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncPickupsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncPickupsRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncPickupsResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncPickupsResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/syncShipments" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "syncShipments",
"description" : "Allows the synchronization of client system transactions with the engine shipments. By the use of a syncId it is possible to return only shipments that have changed between two syncShipments calls.",
"operationId" : "syncShipments",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncShipmentsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncShipmentsRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncShipmentsResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLSyncShipmentsResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/updateCustomsData" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "updateCustomsData",
"description" : "Updates customs data for one existing shipment. Updates data on shipment and item level. Updates customs relevant data only.",
"operationId" : "updateCustomsData",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLUpdateCustomsDataRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLUpdateCustomsDataRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLUpdateCustomsDataResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLUpdateCustomsDataResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/validateShipment" : {
"post" : {
"tags" : [ "Shipping" ],
"summary" : "validateShipment",
"description" : "Validates a shipment with the data specified in the shipment request.clientSystemId are returned (mandatory field)clientSystemId and businessObjectType (both mandatory fields).clientSystemId and businessObjectType (both mandatory fields).The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } } } }, "DLInvalidValueDTO" : { "type" : "object", "properties" : { "possibleValues" : { "type" : "array", "description" : "A possible value for the interface.", "items" : { "$ref" : "#/components/schemas/DLPossibleValuesDTO" } }, "invalidValue" : { "type" : "string", "description" : "The invalid value that is to be changed." }, "maxTextLength" : { "type" : "integer", "format" : "int32", "description" : "The maximum length of the text in the value that is to be changed." } } }, "DLMustBeFilledDTO" : { "type" : "object", "properties" : { "possibleValues" : { "type" : "array", "description" : "A possible value for the interface.", "items" : { "$ref" : "#/components/schemas/DLPossibleValuesDTO" } }, "maxTextLength" : { "type" : "integer", "format" : "int32", "description" : "The maximum length of the text in the value that is to be changed." } } }, "DLObjectiveTextsDTO" : { "type" : "object", "properties" : { "languageISOCode" : { "type" : "string", "description" : "Language of the texts.", "example" : "en" }, "cause" : { "type" : "string", "description" : "Cause of the objective." }, "message" : { "type" : "string", "description" : "Message of the objective." }, "solution" : { "type" : "string", "description" : "Solution of the objective." } } }, "DLPossibleValuesDTO" : { "type" : "object", "properties" : { "value" : { "type" : "string", "description" : "The type of the value that is to be changed." } } }, "DLShipmentObjectivePathSegmentDTO" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The id of previus path segment.", "example" : "packageTransactionId of the package" }, "segment" : { "type" : "string", "description" : "One segment of the path." } } }, "GetShipmentObjectivesResponse" : { "type" : "object", "description" : "The determined objectives of a shipment.", "properties" : { "reachedBoStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO", "description" : "The actual status of the shipment." }, "objectives" : { "type" : "array", "description" : "The objectives of the shipment.", "items" : { "$ref" : "#/components/schemas/ShipmentObjective" } } } }, "ShipmentObjective" : { "type" : "object", "description" : "All accessible data of an Objective.", "properties" : { "objectiveType" : { "type" : "string", "description" : "Type of the objective.", "example" : "MUST_BE_FILLED" }, "objectiveTexts" : { "$ref" : "#/components/schemas/DLObjectiveTextsDTO", "description" : "Info texts of the objective." }, "path" : { "type" : "array", "description" : "The path of the objective.", "items" : { "$ref" : "#/components/schemas/DLShipmentObjectivePathSegmentDTO" } }, "invalidValue" : { "$ref" : "#/components/schemas/DLInvalidValueDTO", "description" : "The data for fields with invalid values." }, "mustBeFilled" : { "$ref" : "#/components/schemas/DLMustBeFilledDTO", "description" : "The data for fields that must be filled." } } }, "TextInLanguageDTO" : { "type" : "object", "description" : "A translated text in one of the specified languages.", "properties" : { "languageISOCode" : { "type" : "string", "description" : "2-letter ISO code of the language.
length=2
", "example" : "en" }, "text" : { "type" : "string", "description" : "The translated text.", "example" : "Some free-form text" } } }, "AmountOfMoneyDTO" : { "type" : "object", "description" : "An amount of money with a value and an currency ISO code.", "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
" } } }, "DLContainerDataDTO" : { "type" : "object", "description" : "DTO containing data for container package types.", "properties" : { "verifiedGrossMass" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Total gross mass from the tare weight of a container and the (individual) weights of all packages and cargo items, including pallets, stowage material and other packaging and securing materials loaded into a container. " }, "verificationMethod" : { "type" : "string", "description" : "Method for verifying the gross mass of the container. Valid values are:length=8
" }, "verificationContactName" : { "type" : "string", "description" : "Name of the person responsible for determining and passing on the VGM.length = 35
" } } }, "DLCuboidDimensionsDTO" : { "type" : "object", "description" : "DLCuboidDimensionsDTO with length, width, height and identCode.", "properties" : { "length" : { "type" : "number", "description" : "Represents the length of the dimensions.length=15, scale=2
" }, "width" : { "type" : "number", "description" : "Represents the width of the dimensions.length=15, scale=2
" }, "height" : { "type" : "number", "description" : "Represents the height of the dimensions.length=15, scale=2
" }, "identCode" : { "type" : "string", "description" : "Identifier of the quantity unit (must be unique). Only \"cm\" is supported yet.length=10
" } }, "required" : [ "height", "identCode", "length", "width" ] }, "DLHazardousGoodsItemRequestDataDTO" : { "type" : "object", "description" : "DTO for request information of a DLHazardousGoodsItem.", "properties" : { "transactionId" : { "type" : "string", "description" : "The shipment wide unique id for the hazardous goods item.
length=50
" }, "unNumber" : { "type" : "string", "description" : "UN numberlength=8
" }, "hazardRegulation" : { "type" : "string", "description" : "Hazardous regulation to be applied. Valid values are:
length=10
" }, "technicalName" : { "type" : "string", "description" : "Technical name
length=250
" }, "hazardAdditionalDescription" : { "type" : "string", "description" : "Additional description
length=250
" }, "hazardousGoodsType" : { "type" : "string", "description" : "Indicates the type of hazardous goods packaged in the package. Valid values are:
length=10
" }, "subriskClass1" : { "type" : "string", "description" : "Sub risk 1 hazardous class. Valid values are:
length=10
" }, "subriskClass2" : { "type" : "string", "description" : "Sub risk 2 hazardous class. Valid values are:
length=10
" }, "classificationCode" : { "type" : "string", "description" : "Classification code
length=4
" }, "tunnelCode" : { "type" : "string", "description" : "Tunnel restriction code
length=10
" }, "packagingGroup" : { "type" : "string", "description" : "Hazardous packaging group. Valid Values are:
length=10
" }, "packingInstruction" : { "type" : "string", "description" : "IATA packing instruction. Consists of the instruction code (up to three digits with optional prefix Y) optionally followed by a section identification (up to two upper case characters). Instruction code and section must be separated by an underscore. The section identification is mandatory for lithium batteries otherwise the instruction code alone is sufficient. Example Values are:
length=10
" }, "specialProvision" : { "type" : "string", "description" : "Special provisions for the carriage of hazardous goods. Consists of the provision code (up to three digits) or the chapter specification (up to three digits), optionally followed by sub-chapters (up to two digits or one digit and an upper case character). Chapter and subchapters must be separated by a dot. Also possible are 3 capital letters + hyphen, followed by further numbers or letters or 1 capital letter followed by numbers. Example Values are:length=20
" }, "multiplicator" : { "type" : "string", "description" : "Hazardous multiplicator. Valid Values are:length=10
" }, "packageTypeIdentCode" : { "type" : "string", "description" : "IdentCode of the package type. Valid values are depending on the client's package types in the master file data.
length=20
" }, "hazardWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The specific weight of the hazardous material." }, "hazardNetQuantity" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The net quantity of the hazardous material. Can be net weight or volume like liter." }, "netExplosiveWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The net explosive weight value of the hazardous material." }, "numberOfPackages" : { "type" : "integer", "format" : "int32", "description" : "Number of packageslength=10
" }, "hazardLabel" : { "type" : "string", "description" : "Hazardous labellength=10
" }, "transportCategory" : { "type" : "string", "description" : "Transport category. Valid Values are:length=4
" }, "specialSubstanceType" : { "type" : "string", "description" : "Special Substance type. Valid Values are:
length=30
" }, "hazardPoints" : { "type" : "integer", "format" : "int32", "description" : "Hazardous points
length=5
" }, "flashPoint" : { "type" : "string", "description" : "Flash pointlength=20
" }, "specialProvisionMarking" : { "type" : "string", "description" : "Indicates if the special provision has to be marked. Valid Values are:length=20
" }, "emergencyContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Emergency contact person." }, "transportAuthorization" : { "type" : "string", "description" : "Transport authorization. Additional information that may be required by regulation about a hazardous material such as DOT-SP number (Special Permit), LAA number...
length=250
" }, "packingInstructionMarking" : { "type" : "string", "description" : "Indicates if the packing instruction has to be marked. Valid Values are:length=20
" }, "marinePollutant" : { "type" : "string", "description" : "Indicates if the substance is a marine pollutant according to IMDG or CFR. When no value is given, default is NO_POLLUTANT. Valid Values are:
length=20
" }, "controlTemperature" : { "type" : "string", "description" : "The control temperature according to IMDG or CFR.
length=4
" }, "emergencyTemperature" : { "type" : "string", "description" : "The emergency temperature according to IMDG or CFR.
length=4
"
},
"isEnvironmentallyHazardous" : {
"type" : "boolean",
"description" : "Indicates if the substance is environmentally hazardous according to ADR or IATA."
},
"isReportableQuantity" : {
"type" : "boolean",
"description" : "Indicates if package contains hazardous materials in an amount that needs to be reported."
},
"isTransportByCargoAircraftOnly" : {
"type" : "boolean",
"description" : "Indicates if the transportation is only allowed in the cargo aircraft."
},
"isNotRegulated" : {
"type" : "boolean",
"description" : "Indicates if no hazardous goods exist in accordance with the regulations."
},
"additionalValues" : {
"$ref" : "#/components/schemas/GenericDataRecordDTO",
"description" : "Additional values for the hazardous goods item. The definition of the included fields depends on the carrier. Only field names defined in the carrier customizing are allowed here.
Use the getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
}
},
"required" : [ "hazardRegulation" ]
},
"DLPackageCumulationRequestDataDTO" : {
"type" : "object",
"description" : "DTO for package cumulation data.",
"properties" : {
"numberOfPackages" : {
"type" : "integer",
"format" : "int32",
"description" : "The number of packages.
length=3
" }, "packageTypeIdentCode" : { "type" : "string", "description" : "IdentCode of the package type. Valid values are depending on the client's package types in the master file data.length=20
" }, "packageSpecificeContents" : { "type" : "string", "description" : "The content description of the package. If left empty, the content description supplied in field 'contents' on shipment level will be used for this package.length=250
" }, "weight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Weight" }, "volume" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Volume" }, "loadingMeters" : { "type" : "number", "description" : "The loading meters needed for the packages.length=10, scale=3
" }, "palletPlaces" : { "type" : "number", "description" : "The pallet places needed for the packages.length=10, scale=3
" } }, "required" : [ "numberOfPackages", "packageTypeIdentCode" ] }, "DLPackageHazardousGoodsDataRequestDTO" : { "type" : "object", "description" : "Holds hazardous goods data concerning the package.", "properties" : { "hazardousGoodsType" : { "type" : "string", "description" : "Indicates the type of hazardous goods packaged in the package. Valid values are:length=2, scale=1
" } }, "required" : [ "hazardousGoodsType" ] }, "DLPackageRequestDataDTO" : { "type" : "object", "description" : "DTO for package data.", "properties" : { "packageTypeIdentCode" : { "type" : "string", "description" : "IdentCode of the package type. Valid values are depending on the client's package types in the master file data.length=20
" }, "packageSpecificeContents" : { "type" : "string", "description" : "The content description of the package. If left empty, the content description supplied in field 'contents' on shipment level will be used for this package.length=250
" }, "packageNumber" : { "type" : "integer", "format" : "int32", "description" : "The serial number of the package within the shipment. This number is mainly used to sort the packages in lists or in business logic (e.g. to detect the \"first\" package as master package).length=5
" }, "packageTransactionId" : { "type" : "string", "description" : "The shipment wide unique id for the package. Is included in the response.
length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "Package reference number. Is included in the response.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Second package reference numberlength=50
" }, "extCarrierPackNum" : { "type" : "string", "description" : "The external carrier tracking number of the packagelength=50
" }, "extCarrierPackNumBasic" : { "type" : "string", "description" : "The basic external carrier tracking number of the packagelength=50
" }, "extCarrierPackNumReturn" : { "type" : "string", "description" : "The external carrier return tracking number of the packagelength=50
" }, "extCarrierPackNumBasicReturn" : { "type" : "string", "description" : "The basic external return carrier tracking number of the packagelength=50
" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Gross weight" }, "dimensions" : { "$ref" : "#/components/schemas/DLCuboidDimensionsDTO", "description" : "Dimensions" }, "alternativeVolume" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The alternative volume of the package. When filled, this field overwrites the volume which is computed from the dimensions of the package." }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "The cash on delivery value." }, "insuranceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Insurance value of the package" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "Additional values for the package. The definition of the included fields depends on the carrier. Only field names defined in the carrier customizing are allowed here.getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
},
"containedItems" : {
"type" : "array",
"description" : "The items the package contains. Only item references are used here, the items themselves must already exist. An error will be returned, when one of the referenced items does not exist.length=50" }, "stackability" : { "type" : "string", "description" : "The possibility to stack packages. Valid values are:
length=10
" }, "nmfcSubCode" : { "type" : "string", "description" : "The NMFC subcode of the package. Relevant for US carriers.length=2
" }, "loadingMeters" : { "type" : "number", "description" : "The loading meters needed for the package.length=10, scale=3
" }, "palletPlaces" : { "type" : "number", "description" : "The pallet places needed for the package.length=10, scale=3
" } }, "required" : [ "grossWeight", "packageTransactionId", "packageTypeIdentCode" ] }, "DLPartyDTO" : { "type" : "object", "description" : "DLPartyDTO containing address data", "properties" : { "companyNumber" : { "type" : "string", "description" : "Company Numberlength=20
" }, "name" : { "type" : "string", "description" : "Name of the company (first address line)length=40
" }, "name2" : { "type" : "string", "description" : "Address name line 2length=40
" }, "name3" : { "type" : "string", "description" : "Address name line 3length=40
" }, "name4" : { "type" : "string", "description" : "Address name line 4length=40
" }, "street" : { "type" : "string", "description" : "Street (line 1) of the address.length=40
" }, "street2" : { "type" : "string", "description" : "Street (line 2) of the address.length=40
" }, "postcode" : { "type" : "string", "description" : "Postcode of the street address.length=10
" }, "city" : { "type" : "string", "description" : "City of the address.length=40
" }, "district" : { "type" : "string", "description" : "District (city line 2) of the address.length=40
" }, "countryISOCode" : { "type" : "string", "description" : "Country of addresslength=2
" }, "county" : { "type" : "string", "description" : "County of the addresslength=40
" }, "poBox" : { "type" : "string", "description" : "PO-Box.length=10
" }, "postcodePOBox" : { "type" : "string", "description" : "Postcode of the poBox address.length=10
" }, "cityPOBox" : { "type" : "string", "description" : "City of the po-box address.length=40
" }, "emailAddress" : { "type" : "string", "description" : "Email address of the address.length=256
" }, "phone" : { "type" : "string", "description" : "Phone number of receptionlength=20
" }, "fax" : { "type" : "string", "description" : "Fax number of receptionlength=20
" }, "initFromCompanyMasterFileData" : { "type" : "boolean", "description" : "Flag controlling how the party will be filled.The type of the reference number or text. Valid values are:
length=15
" }, "value" : { "type" : "string", "description" : "The value of the reference number or text.length=500
" } } }, "DLShipmentCarrierInfoTextDTO" : { "type" : "object", "description" : "DTO specifying a carrier's info text for a shipment.", "properties" : { "identCode" : { "type" : "string", "description" : "Carrier info text ident code.length=20
" }, "parameter" : { "type" : "string", "description" : "An (optional) parameter for the info text.length=512
" } }, "required" : [ "identCode" ] }, "DLShipmentItemReferenceDTO" : { "type" : "object", "description" : "DTO for uniquely identifying an item within a shipment.", "properties" : { "packedItemTransactionId" : { "type" : "string", "description" : "The shipment wide unique id for the packed shipment item.
length=50
" }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO", "description" : "The shipment containing the item." }, "itemTransactionId" : { "type" : "string", "description" : "The number of the client system uniquely referencing an item in a shipment.length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "Another item reference number. May be used, when an item was not created by the client system and therefore has noitemTransactionId. If both fields are filled, they both must match the item. length=50
" }, "quantityValue" : { "type" : "number", "description" : "It is not supported in case of deleting an item.\nThe type of the reference number or text. Valid values are:\n
length=30
\n" }, "value" : { "type" : "string", "description" : "The value of the reference number or text.length=500
" } } }, "DLShipmentItemRequestDataDTO" : { "type" : "object", "description" : "DTO for shipment item data in a request.", "properties" : { "itemNumber" : { "type" : "integer", "format" : "int32", "description" : "The serial number of the item within the shipment. This number is mainly used to sort the items in lists or in business logic.length=4
" }, "itemTransactionId" : { "type" : "string", "description" : "The shipment wide unique id for the item. Is included in the response.
length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "Item reference number. Is included in the response.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Second item reference numberlength=50
" }, "customsTariffNumber" : { "type" : "string", "description" : "The customs tariff number of the shipping item's contents.length=11
" }, "description" : { "type" : "string", "description" : "The shipping item's description.length=250
" }, "exportLicense" : { "type" : "string", "description" : "Export license.length=50
" }, "countryOfOriginsISOCode" : { "type" : "string", "description" : "Country of origins.length=2
" }, "certificateOfOrigins" : { "type" : "string", "description" : "Certificate of origins.length=50
" }, "quantity" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Quantity." }, "netWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Net weight" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Gross weight" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Total customs value of all item articles." }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Total goods value of all item articles." }, "despatchProcedureIdentCode" : { "type" : "string", "description" : "The despatch procedure. Possible values are:
length=10
" }, "referencesTexts" : { "type" : "array", "description" : "Further references texts for the item. Multiple references texts with same type are allowed.", "items" : { "$ref" : "#/components/schemas/DLShipmentItemReferenceTextDTO" } }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "Additional values for the shipping item. The definition of the included fields depends on the carrier. Only field names defined in the carrier customizing are allowed here.getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
},
"hazardousGoodsItems" : {
"type" : "array",
"description" : "Hazardous goods items.",
"items" : {
"$ref" : "#/components/schemas/DLHazardousGoodsItemRequestDataDTO"
}
}
},
"required" : [ "itemTransactionId" ]
},
"DLShipmentReferenceDTO" : {
"type" : "object",
"description" : "DTO for uniquely identifying a DLShipment within a specific client.",
"properties" : {
"transactionId" : {
"type" : "string",
"description" : "ID of the corresponding transaction in the client system.length=250
" }, "referenceNumber1" : { "type" : "string", "description" : "Another client system system reference number for the shipment.length=50
" }, "shipmentNumber" : { "type" : "string", "description" : "The shipment number internally generated by the carrier engine.length=20
" } } }, "DLShipmentRequestDataDTO" : { "type" : "object", "description" : "DTO for shipment data in a request.", "properties" : { "transactionId" : { "type" : "string", "description" : "ID uniquely referencing the corresponding business transaction in the client system.
length=250
" }, "transactionLabel" : { "type" : "string", "description" : "Human readable text which identifies a business transaction (not necessarily unique).
length=250
" }, "organizationUnitClientSystem" : { "type" : "string", "description" : "Additional criteria two separate different organisational units within one Engine's client.length=255
" }, "masterShipmentTransactionId" : { "type" : "string", "description" : "ID uniquely referencing the corresponding master shipment in the client system if the shipment is part of a bulk shipment.
" }, "isDocumentShipment" : { "type" : "boolean", "description" : "Indicates whether the shipment is a document shipment or not.
Note that this flag also defines which services can be used for the shipment.
" }, "templateName" : { "type" : "string", "description" : "Name of the template that is used for initializing data from a shipment template. If a field is filled in the template and in the dto, the value from the dto will be used.length=100
" }, "referenceNumber1" : { "type" : "string", "description" : "First reference number.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Second reference number.length=50
" }, "customsRegistrationNumber" : { "type" : "string", "deprecated" : true, "description" : "Registration number (MRN, etc.) of the customs declaration. The number is assigned by the customs authorities.length=35
" }, "transportRegistrationNumber" : { "type" : "string", "deprecated" : true, "description" : "Transport registration number like EKAER (Hungary) or SENT (Poland). The number is assigned by the local authorities.length=35
" }, "consigneePalletExchangeRegNo" : { "type" : "string", "description" : "The consignee pallet exchange registration number. The number is assigned by the carrier if pallet exchange is supported.length=50
" }, "numberOfExchangePallets" : { "type" : "integer", "format" : "int32", "description" : "The number of exchange pallets. Used for the pallet exchange system if supported by carrier.length=5
" }, "shopId" : { "type" : "string", "deprecated" : true, "description" : "The ID of the shop to which the shipping order is sent.length=35
" }, "shipToServicePointID" : { "type" : "string", "description" : "The ID of the service point at which the consignee can pick up his shipping order.length=35
" }, "shipFromServicePointID" : { "type" : "string", "description" : "The ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up.length=35
" }, "remark" : { "type" : "string", "description" : "Optional textual remark. Used for internal purposes only. The information is not forwarded to any carrier.length=1000
" }, "shippingDate" : { "type" : "string", "description" : "Shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in the time zone of the shipping point.length=10
" }, "contents" : { "type" : "string", "description" : "Additional content discriptionlength=250
" }, "extCarrierShipNum" : { "type" : "string", "description" : "The external carrier tracking number of the shipment.length=50
" }, "extCarrierShipNumBasic" : { "type" : "string", "description" : "The basic external carrier tracking number of the shipment.length=50
" }, "extCarrierShipNumReturn" : { "type" : "string", "description" : "The external carrier return tracking number of the shipment.length=50
" }, "extCarrierShipNumBasicReturn" : { "type" : "string", "description" : "The basic external carrier return tracking number of the shipment.length=50
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Shipping point of the shipment. If no value is supplied, the shipping point is initialized by the user's default setting in the engine." }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "The contact of the shipment's shipping point." }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Customs value of the shipment." }, "consignee" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Consignee of the shipment." }, "consigneeContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "The contact of the shipment's consignee." }, "altInvoiceRecipient" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "If the consignee is not the recipient of the commercial invoice, an alternative invoice recipient can be supplied here." }, "altInvoiceRecipientContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "The contact of the alternative invoice recipient. This field is only relevant, if a value in field 'altInvoiceRecipient' is supplied." }, "carrierIdentCode" : { "type" : "string", "description" : "Carrier of the shipment.length=20
" }, "serviceCode" : { "type" : "string", "description" : "Service to apply on the shipment. Service must be available within the carrier identified bycarrierIdentCode. length=20
" }, "termsOfDeliveryCode" : { "type" : "string", "description" : "IdentCode of the terms of delivery. Valid values are depending on the client's terms of delivery in the master file data.length=20
" }, "incotermDestination" : { "type" : "string", "description" : "The incoterm destination of the shipment. The incoterm is included within the terms of delivery. Depending on the incoterm, it makes sense to specify a incoterm destination.length=50
" }, "portOfLoadingCode" : { "type" : "string", "description" : "The code of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=5
" }, "portOfLoading" : { "type" : "string", "description" : "The name of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=50
" }, "portOfDischargeCode" : { "type" : "string", "description" : "The code of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=5
" }, "portOfDischarge" : { "type" : "string", "description" : "The name of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=50
" }, "securityStatus" : { "type" : "string", "description" : "The security status of air freight for cargo/post or passenger aircraft transport. Valid values are:
length=12
" }, "fixedDate" : { "type" : "string", "description" : "Fixed delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the delivery point.Important: Only the date portion is transmitted to the carrier interfaces. The time portion is ignored, so it does not matter which time is passed.
length=19
" }, "earliestCollectionBookingDate" : { "type" : "string", "description" : "Earliest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the shipping point.length=19
" }, "latestCollectionBookingDate" : { "type" : "string", "description" : "Latest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the shipping point.length=19
" }, "latestRequestedDeliveryDate" : { "type" : "string", "description" : "Latest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the delivery point.length=19
" }, "earliestRequestedDeliveryDate" : { "type" : "string", "description" : "Earliest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the delivery point.length=19
" }, "airline" : { "type" : "string", "description" : "The name of the airline company.length=35
" }, "flightNumber" : { "type" : "string", "description" : "The flight number specifies a specific flight of an airline.length=20
" }, "houseAirwaybillNumber" : { "type" : "string", "description" : "The house airwaybill number identifies a single shipping order within the cargo of an aircraft.length=35
" }, "masterAirwaybillNumber" : { "type" : "string", "description" : "The master airwaybill number identifies the cargo of a complete aircraft.length=35
" }, "pickupAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The pick up address of the shipment. Required in case of return shipments because otherwise it's equal to the shipping point." }, "pickupAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the pick up address of the shipment." }, "altReturnAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The alt. return address of the shipment. Only to be used with a value-added service of type returns (enclosed)." }, "altReturnAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the alt. return address of the shipment. Only to be used with a value-added service of type returns (enclosed)." }, "notifyAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The notify address of the shipment." }, "notifyAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the notify address of the shipment." }, "coverAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The cover address of the shipment." }, "coverAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the cover address of the shipment." }, "customsAgent" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The customs agent of the shipment." }, "customsAgentContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the customs agent of the shipment." }, "alternativeCarrierAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Alternative carrier address to be printed on the label and the paper manifest. The address is only used (and required) if the carrier is configured accordingly. Note that in most configurations however the address stored in the carrier’s account is used." }, "alternativeCarrierAddrContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Alternative contact of the carrier of the shipment. Used together with the alternative carrier address. The contact is optional. The contact is only used if the carrier is configured accordingly. Note that in most configurations however the address stored in the carrier’s account is used." }, "importerAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The importer of the shipment." }, "importerAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the importer of the shipment." }, "exporterAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The exporter of the shipment." }, "exporterAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the exporter of the shipment." }, "payerOfChargRole" : { "type" : "string", "description" : "The payer of charges. Valid values are:
length=10
" }, "payerOfCharg" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The payer of charges address. Only required if payerOfChargRole is \"THIRDPARTY\"." }, "payerOfChargContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the payer of charges." }, "payerOfChargAccountNo" : { "type" : "string", "description" : "The payer of charges account number. Only used, when initPayerOfChargAccNoFromCompanyMasterData = false.length=50
" }, "initPayerOfChargAccNoFromCompanyMasterData" : { "type" : "boolean", "description" : "Flag controlling how the 'payerOfChargAccountNo' field will be filled.The payer of duties and taxes. Valid values are:
length=10
" }, "payerOfDut" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The payer of duties and taxes address. Only required if payerOfDutRole is \"THIRDPARTY\"." }, "payerOfDutContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the payer of duties and taxes." }, "payerOfDutAccountNo" : { "type" : "string", "description" : "The payer of duties and taxes account number. Only used, when initPayerOfDutAccNoFromCompanyMasterData = false.length=50
" }, "initPayerOfDutAccNoFromCompanyMasterData" : { "type" : "boolean", "description" : "Flag controlling how the 'payerOfDutAccountNo' field will be filled.The alternative payer of taxes. Valid values are:
length=10
" }, "altPayerOfTax" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The alternative payer of taxes address." }, "altPayerOfTaxContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the alternative payer of taxes." }, "altPayerOfTaxAccountNo" : { "type" : "string", "description" : "The alternative payer of taxes account number. Only used, when initAltPayerOfTaxAccNoFromCompanyMasterData = false.length=50
" }, "initAltPayerOfTaxAccNoFromCompanyMasterData" : { "type" : "boolean", "description" : "Flag controlling how the 'altPayerOfTaxAccountNo' field will be filled.length=10, scale=3
" }, "palletPlaces" : { "type" : "number", "description" : "The pallet places needed for the shipment. If a value is given, it overwrites the pallet places in 'packageCumulations'.length=10, scale=3
" }, "packages" : { "type" : "array", "description" : "Packages of the shipment.", "items" : { "$ref" : "#/components/schemas/DLPackageRequestDataDTO" } }, "packageCumulations" : { "type" : "array", "description" : "Packages cumulations of the shipment.", "items" : { "$ref" : "#/components/schemas/DLPackageCumulationRequestDataDTO" } }, "items" : { "type" : "array", "description" : "Shipment items.", "items" : { "$ref" : "#/components/schemas/DLShipmentItemRequestDataDTO" } }, "referencesTexts" : { "type" : "array", "description" : "Further references and texts for the shipment. Multiple references or texts with same type are allowed (e.g. to specify all different delivery note numbers contained in the shipment).", "items" : { "$ref" : "#/components/schemas/DLReferenceTextDTO" } }, "transportEquipments" : { "type" : "array", "description" : "The transport equipments used for the shipment.", "items" : { "$ref" : "#/components/schemas/DLTransportEquipmentDTO" } }, "valueAddedServices" : { "type" : "array", "description" : "Value added services for the shipment.", "items" : { "$ref" : "#/components/schemas/DLValueAddedServiceReferenceDTO" } }, "carrierInfoTexts" : { "type" : "array", "description" : "Carrier info texts for the shipment.", "items" : { "$ref" : "#/components/schemas/DLShipmentCarrierInfoTextDTO" } }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "Additional values for the shipment. The definition of the included fields depends on the carrier. Only field names defined in the carrier customizing are allowed here.getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
}
},
"required" : [ "carrierIdentCode", "consignee", "contents", "referenceNumber1", "serviceCode", "shippingDate", "shippingPt", "termsOfDeliveryCode", "transactionId" ]
},
"DLShipmentTotalsRequestDataDTO" : {
"type" : "object",
"description" : "DTO for shipment totals in a request.",
"properties" : {
"numberOfPackagesExpected" : {
"type" : "integer",
"format" : "int32",
"description" : "The expected number of packages. Used to print the total number of packages on the label when documents are printed before all packages are available.length=5
" }, "grossWeightExpected" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The expected shipment gross weight. Used to print the gross weight on the label when documents are printed before all packages with their gross weights are available.length=10, scale=3
" }, "palletPlaces" : { "type" : "number", "description" : "The pallet places needed for the shipment. When left empty, the sum of the values specified in request field 'packageCumulations' will be used whereever the pallet places are needed on shipment level.length=10, scale=3
" } } }, "DLTransportEquipmentDTO" : { "type" : "object", "description" : "DTO representing a specific transport equipment such as a containers or a pallets.", "properties" : { "identification" : { "type" : "string", "description" : "The identification of the transport equipment, e.g. the container number.length=50
" }, "equipmentTransactionId" : { "type" : "string", "description" : "The shipment wide unique id for the transport equipment. Is included in the response.length=50
" }, "equipmentTypeIdentCode" : { "type" : "string", "description" : "IdentCode of the equipment type (Container, pallet etc.). All entries in the client's package type master file data are allowed. So the valid values are depending on the configured entries there.length=20
" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Gross weight" }, "dimensions" : { "$ref" : "#/components/schemas/DLCuboidDimensionsDTO", "description" : "Dimensions" }, "containerData" : { "$ref" : "#/components/schemas/DLContainerDataDTO", "description" : "Container detail data. May only be used for container equipment types." }, "sealNumbers" : { "type" : "array", "description" : "Seal (serial numbers and/or barcodes) of the transport equipment.length = 35
", "items" : { "type" : "string" } } }, "required" : [ "equipmentTransactionId", "equipmentTypeIdentCode" ] }, "DLTransportEquipmentReferenceDTO" : { "type" : "object", "description" : "DTO for uniquely identifying a transport equipment within a shipment.", "properties" : { "identification" : { "type" : "string", "description" : "The identification of the transport equipment.length=50
" }, "equipmentTransactionId" : { "type" : "string", "description" : "The number of the client system uniquely referencing a transport equipment in a shipment.length=50
" } }, "required" : [ "equipmentTransactionId" ] }, "DLValueAddedServiceReferenceDTO" : { "type" : "object", "description" : "DTO to reference a value added service within a carrier.", "properties" : { "identCode" : { "type" : "string", "description" : "Value added service ident code of the carrier.length=20
" } }, "required" : [ "identCode" ] }, "GenericDataFieldDTO" : { "type" : "object", "description" : "A field of a generic data record.", "properties" : { "name" : { "type" : "string", "description" : "Name of this field, i.e. the role the field plays in the enclosing record.
When the same name is repeated in the context of the same parent record, it is assumed that the parent defines this element as a repeatable (array) element.
" }, "value" : { "type" : "string", "description" : "Value of the field.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
Data type of the field.
This is not strictly necessary since the receiving entity should be able to infer the structure with its own meta data; it may be used however for sanity checks.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
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" } } }, "xml" : { "name" : "addShipmentAttachmentsResponseDTO" } }, "ResponseMessageDTO" : { "type" : "object", "description" : "Result messages like errors or warnings.", "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", "format" : "int32", "description" : "The indentation level of the message.
'0' indicates a top level message.
", "example" : 0 } } }, "DLAddShipmentAttachmentsRequestDTO" : { "type" : "object", "description" : "Request DTO for the addShipmentAttachments business facade method", "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" } }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO", "description" : "Reference of the shipment the attachments belong to. Mandatory field.
" }, "mode" : { "type" : "string", "description" : "Manages how the system should react if an attachment already exists. If empty mode 'ADD' will be used. The filter criteria for an existing attachment is the file name and an existing content.Possible values:
lenght = 250
." }, "mimeType" : { "type" : "string", "description" : "The MIME type of the document. Possible values:format\" document is a printable image. format can be \"png\", \"jpeg\", etc. length = 30
" }, "data" : { "type" : "string", "format" : "byte", "description" : "Attachment data/content." }, "contentType" : { "type" : "string", "description" : "Attachment type.Possible values:
length=30
" } } }, "DLCancelShipmentResponseDTO" : { "type" : "object", "description" : "Response DTO for the cancelShipment business facade method", "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" } } }, "xml" : { "name" : "cancelShipmentResponseDTO" } }, "DLCancelShipmentRequestDTO" : { "type" : "object", "description" : "Request DTO for the cancelShipment business facade method", "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" } }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO", "description" : "The shipment to be cancelled.
" }, "processParms" : { "$ref" : "#/components/schemas/DLShipmentCancelParmsDTO", "description" : "The process parameters for the cancel operation.The mode in which the operation is processed. Valid values are:
length=10
" } }, "required" : [ "mode" ] }, "DLShipmentCancelParmsDTO" : { "type" : "object", "description" : "Parameters for the cancle operation for a shipment.", "properties" : { "processMode" : { "$ref" : "#/components/schemas/DLProcessModeDTO", "description" : " Sets the process mode for the cancel operation.
Keep in mind that processMode 'EXTENDED' consumes more system resources and reduces the effect of load balancing. It should only be used in case the client system needs an immediate response (e.g. if the client system makes subsequent business facade calls which have to rely on a successful cancellation)
" } }, "required" : [ "processMode" ] }, "DLCreatePickupResponseDTO" : { "type" : "object", "description" : "Response DTO for the processPickup business facade method", "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" } }, "pickupNumber" : { "type" : "string", "description" : "The pickup number internally generated by the carrier engine.length=20
" }, "documents" : { "type" : "array", "description" : "The documents (manifests) of the pickup. Only filled, when specified indocumentOutputMode of request.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
}
},
"xml" : {
"name" : "createPickupResponseDTO"
}
},
"DLDocumentDTO" : {
"type" : "object",
"description" : "DTO for a document to be printed out by the client system.",
"properties" : {
"documentId" : {
"type" : "string",
"description" : "Unique identification of the document.length = 50
" }, "documentType" : { "type" : "string", "description" : "The ident code of the document type the document belongs to.length = 50
" }, "mimeType" : { "type" : "string", "description" : "The MIME type of the document. Possible values:format\" document is a printable image. format can be \"png\", \"jpeg\", etc. length = 30
" }, "printerModel" : { "type" : "string", "description" : "Only filled for \"printer/raw\" mime type. Specifies the printer model the content is usable for.length = 80
" }, "printerId" : { "type" : "string", "description" : "Only filled for \"printer/raw\" mime type. The ID can be used to identify a special printer by the ERP system.length = 80
" }, "resolution" : { "type" : "integer", "format" : "int32", "description" : "Only filled for \"image\" mime types. Specifies resolution of the image.length = 8
" }, "content" : { "type" : "string", "format" : "byte", "description" : "The document content" } } }, "DLCreatePickupRequestDTO" : { "type" : "object", "description" : "Request DTO for the processPickup business facade method", "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" } }, "creationParms" : { "$ref" : "#/components/schemas/DLPickupCreationParmsDTO", "description" : "Controls how to create the pickup." }, "pickup" : { "$ref" : "#/components/schemas/DLPickupRequestDataDTO", "description" : "The pickup data with the contained shipments." }, "processParms" : { "$ref" : "#/components/schemas/DLPickupProcessParmsDTO", "description" : "Controls how to process the pickup, especially the handling of the manifest documents." } }, "required" : [ "creationParms", "pickup", "processParms" ], "xml" : { "name" : "createPickupRequestDTO" } }, "DLDocumentOutputModeDTO" : { "type" : "object", "description" : "DTO specifying the output mode for documents.", "properties" : { "mode" : { "type" : "string", "description" : "The output mode for the documents. Valid values are:
length=15
" }, "includeDocumentId" : { "type" : "boolean", "description" : "Only relevant for mode RETURN. Controls, if the document ID (field DLDocumentDTO#documentId) should be filled. Defaults to \"false\".
" }, "includeContent" : { "type" : "boolean", "description" : "Only relevant for mode RETURN. Controls, if the document content (field DLDocumentDTO#content) should be filled. Use this setting if you only need reference data of the documents but not the actual content. Defaults to \"true\".
" } }, "required" : [ "mode" ] }, "DLPickupCreationParmsDTO" : { "type" : "object", "description" : "Creation parameters for a shipment. Specifies when and how to create a pickup and the shipment it contains.", "properties" : { "creationMode" : { "type" : "string", "description" : " Controls the creation of the pickup (if a new pickup is to create) and the handling of the shipments that should be assigned to it.
The basic requirement for a pickup to be created is that the header data (like carrier, shipping date etc.) is filled correctly. The creationMode controls how to deal with the pickup's shipments. Valid values are:
processPickup call. Mandatory field.length=30
" } }, "required" : [ "creationMode" ] }, "DLPickupProcessParmsDTO" : { "type" : "object", "description" : "Process parameters for a pickup. Especially controls the handling of the manifest documents.", "properties" : { "doManifest" : { "type" : "boolean", "description" : "'true' or '1' = The shipment pickup is manifested. That means, that EDI data is sent to the carrier and the pickup is sealed, it cannot be changed, no shipments can be added or removed anymore.
'false' or '0' = The shipment pickup is left open, no EDI data is sent to the carrier yet, shipments can be added or removed using the GUI. If the pickup has already been manifested, nothing is done.
" }, "documentOutputMode" : { "$ref" : "#/components/schemas/DLDocumentOutputModeDTO", "description" : "The output mode for the manifest documents." }, "workstationId" : { "type" : "string", "description" : "The workstation where the documents should be printed out in the case of direct printing.length=50
" } }, "required" : [ "doManifest", "documentOutputMode", "workstationId" ] }, "DLPickupRequestDataDTO" : { "type" : "object", "description" : "DTO for pickup data.", "properties" : { "transactionId" : { "type" : "string", "description" : "ID uniquely referencing the corresponding business transaction for the pickup in the client system.
length=250
" }, "transactionLabel" : { "type" : "string", "description" : "Human readable text which identifies the pickup business transaction in the client system (not necessarily unique).
length=250
" }, "referenceNumber1" : { "type" : "string", "description" : "First reference number.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Second reference number.length=50
" }, "licensePlateNumber1" : { "type" : "string", "description" : "First license plate number.length=50
" }, "licensePlateNumber2" : { "type" : "string", "description" : "Second license plate number.length=50
" }, "driverSignature" : { "$ref" : "#/components/schemas/DLSignatureDTO", "description" : "Signature of the driver transporting the shipping orders." }, "carrierIdentCode" : { "type" : "string", "description" : "Carrier of the pickup.length=20
" }, "shippingDate" : { "type" : "string", "description" : "Shipping date in the format 'yyyy-MM-dd'. The shipping date is expected to be in the time zone of the shipping point.length=10
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Shipping point of the pickup.carrierIdentCode) and the pickup's shipping point (specified in field shippingPoint).",
"items" : {
"$ref" : "#/components/schemas/DLShipmentReferenceDTO"
}
}
},
"required" : [ "referenceNumber1", "shipments", "shippingDate", "shippingPt", "transactionId" ]
},
"DLSignatureDTO" : {
"type" : "object",
"description" : "DLSignatureDTO containing driver's signature data",
"properties" : {
"text" : {
"type" : "string",
"description" : "Driver's signature text. length=50
" }, "image" : { "type" : "string", "format" : "byte", "description" : "Driver's signature image." }, "mimetype" : { "type" : "string", "description" : "The mimetype of the drivers signature image e.g. image/jpeg or image/png.length=250
" } } }, "DLCreateShipmentResponseDTO" : { "type" : "object", "description" : "Response DTO for the createShipment business facade method", "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" } }, "shipmentNumber" : { "type" : "string", "description" : "The shipment number internally generated by the carrier engine.length=20
" }, "carrierShipmentNumber" : { "type" : "string", "description" : "The carrier tracking number of the shipment. Only filled in case process mode is 'EXTENDED'.length=50
" }, "carrierShipmentNumberReturn" : { "type" : "string", "description" : "The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data. Only filled in case process mode is 'EXTENDED'.length=50
" }, "carrierTrackingURL" : { "type" : "string", "description" : "The tracking URL of the shipment.length=512
" }, "carrierTrackingURLReturn" : { "type" : "string", "description" : "The additional return tracking URL of the shipment.length=512
" }, "bulkMasterShipmentNumber" : { "type" : "string", "description" : "The internally generated shipment number of the bulk master if applicable. Must be used to access the bulk master shipment e.g. for adding packages, etc.length=20
" }, "collectionBookingNumber" : { "type" : "string", "description" : "The booking number of a requested collection booking assigned from carrier to this shipment.length=20
" }, "packageResults" : { "type" : "array", "description" : "The results on package level. Some fields are only filled in case process mode is 'EXTENDED'.", "items" : { "$ref" : "#/components/schemas/DLPackageProcessingResultDTO" } }, "accountInfo" : { "$ref" : "#/components/schemas/DLShipmentAccountInfoResponseDataDTO", "description" : "Information about the account used for the shipment. Only filled in case process mode is 'EXTENDED'." }, "documents" : { "type" : "array", "description" : "The documents of the shipment. Only filled, when specified indocumentOutputMode of request and shipment documents for printing exist.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
}
},
"xml" : {
"name" : "createShipmentResponseDTO"
}
},
"DLPackageProcessingResultDTO" : {
"type" : "object",
"description" : "DTO holding result information of a package processing.syncShipments call.",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "True, if there are any error messages. If an error has occured the messages contain more details about the errors."
},
"hasWarnings" : {
"type" : "boolean",
"description" : "True, if there are any warning messages."
},
"messages" : {
"type" : "array",
"description" : "Messages for the whole request, e.g. for errors or warnings.The shipment wide unique id for the package (as specified in the request) the result is for.
length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "Another package reference number (as specified in the request) the result is for.length=50
" }, "carrierPackageNumber" : { "type" : "string", "description" : "The package number given by the carrier. Usually the tracking number.length=50
" }, "carrierPackageNumberReturn" : { "type" : "string", "description" : "The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
" }, "carrierTrackingURL" : { "type" : "string", "description" : "The tracking URL of the package.length=512
" }, "carrierTrackingURLReturn" : { "type" : "string", "description" : "The additional return tracking URL of the package.length=512
" }, "carrierPackageIdentBarcode" : { "type" : "string", "description" : "The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.length=50
" }, "documents" : { "type" : "array", "description" : "The documents for the package. Only filled when asked for in request (documentOutputMode).", "items" : { "$ref" : "#/components/schemas/DLDocumentDTO" } } } }, "DLShipmentAccountInfoResponseDataDTO" : { "type" : "object", "description" : "Holds information from the account used for the shipment", "properties" : { "identCode" : { "type" : "string", "description" : "Ident code of the account.length=50
" }, "customerNumberAtCarrier" : { "type" : "string", "description" : "Account number of the shipper assigned from the carrier.length=25
" }, "singlePackageHandlingActivated" : { "type" : "boolean", "description" : "Indicates whether package by package printing is possible for the carrier." } } }, "DLCreateShipmentRequestDTO" : { "type" : "object", "description" : "Request DTO for the createShipment business facade method", "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" } }, "creationParms" : { "$ref" : "#/components/schemas/DLShipmentCreationParmsDTO", "description" : "Controls how to create the shipment." }, "shipment" : { "$ref" : "#/components/schemas/DLShipmentRequestDataDTO", "description" : "The data necessary to create the shipment." }, "processParms" : { "$ref" : "#/components/schemas/DLShipmentProcessParmsDTO", "description" : "Controls how to process the shipment after it has been created." } }, "required" : [ "creationParms", "processParms", "shipment" ], "xml" : { "name" : "createShipmentRequestDTO" } }, "DLDocumentScopeDTO" : { "type" : "object", "description" : "DTO specifying the scope of documents to be processed.", "properties" : { "scope" : { "type" : "string", "description" : "The scope of documents to be processed (prepared or printed). Valid values are:
length=20
" } }, "required" : [ "scope" ] }, "DLShipmentCreationParmsDTO" : { "type" : "object", "description" : "Creation parameters for a shipment. Specifies when and how to create a shipment or it's packages.", "properties" : { "creationMode" : { "type" : "string", "description" : "Controls the creation of the shipment and/or it's packages as a transaction in the carrier engine. This is necessary for further processing like label printing or EDI generation. Valid values are:
cancelShipment call and retransmitted with a createShipment call. The cancel step is necessary because a direct retransmission of existing shipments and packages is not allowed. Mandatory field.length=15
" } }, "required" : [ "creationMode" ] }, "DLShipmentProcessParmsDTO" : { "type" : "object", "description" : "Process parameters for a shipment. Specifies which operations have to be performed after a shipment has been created.", "properties" : { "processMode" : { "$ref" : "#/components/schemas/DLProcessModeDTO", "description" : " Controls the preparation process mode. In case of 'BASIC' preparation, the preparation is processed asynchronously in a job and the response only creates the shipment in the database. In case of 'EXTENDED' preparation, all preparation actions are directly executed synchronously and the response is not returned before the complete label preparation process is finished.
The preparation includes the computing of carrier specific information (e.g. routing codes) and the generation of the documents (labels) in printer language ready to be sent to a printer.
During the preparation process a carrier specific validation is performed on the shipment (e.g. if a routing code can be detected for the shipment). An error will be returned if the validation fails.
Keep in mind that processMode 'EXTENDED' consumes more system resources and reduces the effect of load balancing. It should only be used in case the client system requires an immediate response including the label preparation results of the shipment and the packages.
" }, "documentPrepareScope" : { "$ref" : "#/components/schemas/DLDocumentScopeDTO", "description" : " Controls the preparation of the shipment's package documents (labels).
The preparation includes the computing of carrier specific information (e.g. routing codes) and the generation of the documents (labels) in printer language ready to be sent to a printer.
During the preparation process a carrier specific validation is performed on the shipment (e.g. if a routing code can be detected for the shipment). An error will be returned if the validation fails.
The workstation used to detect the printer for which the documents should be prepared, printed or returned.
An error will be returned when the package documents (labels) are already prepared (invoked by a previous call) and are now be be printed with a different workstationId containing an incompatible printer.
length=50
" }, "documentOutputScope" : { "$ref" : "#/components/schemas/DLDocumentScopeDTO", "description" : "Controls if and which documents (labels) should be printed or returned. Only prepared documents are regarded.
" }, "documentOutputMode" : { "$ref" : "#/components/schemas/DLDocumentOutputModeDTO", "description" : "Controls the output mode for the documents specified indocumentOutputScope. 'true' or '1' = The shipment is set in status \"Complete\". In this status the shipment is sealed, it cannot be changed, no packages can be added anymore. The shipment is automatically assigned to a pickup or can be manually assigned, depending on the customizing.
It is required, that the documents for each package are prepared. When they are not prepared yet, the field documentPrepareScope must be set accordingly, otherwise an error is returned.
Not printed documents (labels) can be printed after completion with the processShipment call.
'false' or '0' = The shipment is left open, further packages can be added with the processShipment call. If the shipment has already been completed, nothing is done.
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" } } }, "xml" : { "name" : "deleteItemResponseDTO" } }, "DLDeleteItemRequestDTO" : { "type" : "object", "description" : "Request DTO for the deleteItem business facade method", "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" } }, "shipmentItemReference" : { "$ref" : "#/components/schemas/DLShipmentItemReferenceDTO", "description" : "The shipment item to be deleted.
" } }, "required" : [ "shipmentItemReference" ], "xml" : { "name" : "deleteItemRequestDTO" } }, "DLDeletePackageResponseDTO" : { "type" : "object", "description" : "Response DTO for the deletePackage business facade method", "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" } } }, "xml" : { "name" : "deletePackageResponseDTO" } }, "DLDeletePackageRequestDTO" : { "type" : "object", "description" : "Request DTO for the deletePackage business facade method", "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" } }, "packageReference" : { "$ref" : "#/components/schemas/DLPackageReferenceDTO", "description" : "The package to be deleted.
" } }, "required" : [ "packageReference" ], "xml" : { "name" : "deletePackageRequestDTO" } }, "DLPackageReferenceDTO" : { "type" : "object", "description" : "DTO for uniquely identifying a package. The context settingsclientIdentCode and clientSystemId are also applied when filled.",
"properties" : {
"shipmentReference" : {
"$ref" : "#/components/schemas/DLShipmentReferenceDTO",
"description" : "The shipment containing the package."
},
"packageTransactionId" : {
"type" : "string",
"description" : "The number of the client system uniquely referencing a package in a shipment. length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "Another package reference number. May be used, when a package was not created by the client system and therefore has nopackageTransactionId. If both fields are filled, they both must match the package. length=50
" } }, "required" : [ "packageTransactionId", "shipmentReference" ] }, "DLDeletePickupResponseDTO" : { "type" : "object", "description" : "Response DTO for the cancelPickup business facade method", "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" } } }, "xml" : { "name" : "deletePickupResponseDTO" } }, "DLDeletePickupRequestDTO" : { "type" : "object", "description" : "Request DTO for the cancelShipment business facade method", "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" } }, "pickupReference" : { "$ref" : "#/components/schemas/DLPickupReferenceDTO", "description" : "The pickup to be cancelled.
" } }, "required" : [ "pickupReference" ], "xml" : { "name" : "deletePickupRequestDTO" } }, "DLPickupReferenceDTO" : { "type" : "object", "description" : "DTO for uniquely identifying a shipment pickup within a client.", "properties" : { "transactionId" : { "type" : "string", "description" : "The transaction id of the pickup given by the client system.length=250
" }, "referenceNumber1" : { "type" : "string", "description" : "Another client system system reference number for the pickup.length=50
" }, "pickupNumber" : { "type" : "string", "description" : "The number of the pickup given by the carrier engine.length=20
" } } }, "DLCarrierListItemDTO" : { "type" : "object", "description" : "Minimum carrier info to use in lists.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierType" : { "type" : "string", "description" : "The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=20
" }, "imprint" : { "type" : "string", "description" : "The official company name (corporate name) of the carrier according to homepage." }, "name" : { "type" : "string", "description" : "Name of carrier." } } }, "DLGetAllCarriersResponseDTO" : { "type" : "object", "description" : "Response DTO containing a list of available carrier for a client.", "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" : "The list of available carriers.", "items" : { "$ref" : "#/components/schemas/DLCarrierListItemDTO" } } }, "xml" : { "name" : "getAllCarriersResponseDTO" } }, "DLGetAllCarriersRequestDTO" : { "type" : "object", "description" : "Request DTO to retrieve the codes and names of all available carriers for a client.", "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" } } }, "xml" : { "name" : "getAllCarriersRequestDTO" } }, "DLAdditionalValueDTO" : { "type" : "object", "description" : "Information about an additional value defined for a carrier.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "businessObjectClass" : { "type" : "string", "description" : "The business object class the additional value belongs to. Possible values are:
length=10
" }, "dataType" : { "type" : "string", "description" : "The data type of the field. Possible values are:
length=10
" } } }, "DLCarrierBusinessDivisionDTO" : { "type" : "object", "description" : "Response information about the supported business Divisions from a carrier", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } } } }, "DLCarrierDespatchCountryDTO" : { "type" : "object", "description" : "Response information about the supported countries from a carrier", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "isoCode" : { "type" : "string", "description" : "The isoCode of the Country.length=2
" }, "name" : { "type" : "string", "description" : "The name of the Country.length=50
" } } }, "DLCarrierExtendedInfosDTO" : { "type" : "object", "description" : "Response information for the extended Infos URL and WebLogo for the Carrier.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierUrl" : { "type" : "string", "description" : "The Url of the Carrier from the Carrier-website. Possible values are:
length=150
" }, "webLogo" : { "type" : "string", "format" : "byte", "description" : "The WebLogo of the carrier from the Carrier-website. Possible values are:
length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } } } }, "DLCarrierNetworkDTO" : { "type" : "object", "description" : "Response information about the networks in which the carrier is involved.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } } } }, "DLGetCarrierPortfolioDetailsResponseDTO" : { "type" : "object", "description" : "Response DTO for all available carriers with their detail information.", "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" : "The list of all requested carriers with their detail information.", "items" : { "$ref" : "#/components/schemas/DLGetCarrierPropertiesResponseDTO" } } }, "xml" : { "name" : "getCarrierPortfolioDetailsResponseDTO" } }, "DLGetCarrierPropertiesResponseDTO" : { "type" : "object", "description" : "Response DTO containing the properties of a specific carrier.", "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" } }, "carrierIdentCode" : { "type" : "string", "description" : "The carrier as specified in the request.length=20
" }, "carrierType" : { "type" : "string", "description" : "The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=20
" }, "descriptions" : { "type" : "array", "description" : "The description of the carrier in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "services" : { "type" : "array", "description" : "The services the carrier offers.", "items" : { "$ref" : "#/components/schemas/DLServiceDTO" } }, "valueAddedServices" : { "type" : "array", "description" : "The value added services the carrier offers.", "items" : { "$ref" : "#/components/schemas/DLValueAddedServiceDTO" } }, "additionalValues" : { "type" : "array", "description" : "The possible additional values defined for the carrier. An additional value represents a field only used by that carrier, often in combination with the use of special services or value added services.DLShipmentRequestDataDTO.additionalValues as part of the createShipment call.",
"items" : {
"$ref" : "#/components/schemas/DLAdditionalValueDTO"
}
},
"infoTexts" : {
"type" : "array",
"description" : "The informational texts the carrier offers. These texts are used to submit additional information to the carrier how to handle the goods. Often they are used instead of services.",
"items" : {
"$ref" : "#/components/schemas/DLCarrierInfoTextDTO"
}
},
"isUsingAltCarrierAddress" : {
"type" : "boolean",
"description" : "Indicates if the carrier requires the specification of an alternative carrier address."
},
"despatchCountries" : {
"type" : "array",
"description" : "The despatch countries the carrier is supporting. Check first 'isDespatchCountriesGlobal'. If the carrier operates globally, this list contains all countries.",
"items" : {
"$ref" : "#/components/schemas/DLCarrierDespatchCountryDTO"
}
},
"businessDivisions" : {
"type" : "array",
"description" : "The business divisions in which the carrier is working.",
"items" : {
"$ref" : "#/components/schemas/DLCarrierBusinessDivisionDTO"
}
},
"networks" : {
"type" : "array",
"description" : "The networks the carrier is member of.",
"items" : {
"$ref" : "#/components/schemas/DLCarrierNetworkDTO"
}
},
"extendedInfos" : {
"$ref" : "#/components/schemas/DLCarrierExtendedInfosDTO",
"description" : "Extended information for the carrier."
},
"isDespatchCountriesGlobal" : {
"type" : "boolean",
"description" : "Indicates if the carrier operates globally. Therefore the list of despatchCountries contains all countries."
},
"imprint" : {
"type" : "string",
"description" : "The official company name (corporate name) of the carrier according to homepage."
},
"name" : {
"type" : "string",
"description" : "Name of carrier."
}
},
"xml" : {
"name" : "getCarrierPropertiesResponseDTO"
}
},
"DLServiceDTO" : {
"type" : "object",
"description" : "Information about a service a carrier offers.",
"properties" : {
"identCode" : {
"type" : "string",
"description" : "The identCode of the entry. length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "isInternationalAllowed" : { "type" : "boolean", "description" : "Returns true when service is available for international transports." }, "isDomesticAllowed" : { "type" : "boolean", "description" : "Returns true when service is available for domestic transports." }, "isPackageOriented" : { "type" : "boolean", "description" : "Returns true when service is package oriented." }, "isDocumentService" : { "type" : "boolean", "description" : "Returns true when service is used for the transport of documents." }, "isGoodsService" : { "type" : "boolean", "description" : "Returns true when service is used for the transport of goods." }, "isFixedDateService" : { "type" : "boolean", "description" : "Returns true when service allows a fixed date delivery." } } }, "DLValueAddedServiceDTO" : { "type" : "object", "description" : "Response information about a value added service.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "valueAddedServiceType" : { "type" : "string", "description" : "The type of the value added service. Possible values:
length=20
" } } }, "DLGetCarrierPortfolioDetailsRequestDTO" : { "type" : "object", "description" : "Response DTO for carrier properties for all carriers", "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" } }, "carrierIdentCodes" : { "type" : "array", "description" : "List of carriers for which the detailed information is requested. The valid codes can be retrieved with function 'getCarrierPortfolioNames'. If no list is supplied, all existing carriers will be returned.", "items" : { "type" : "string" } } }, "xml" : { "name" : "getCarrierPortfolioDetailsRequestDTO" } }, "DLCarrierPortfolioNameDTO" : { "type" : "object", "description" : "DTO for the code and name of a carrier.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the entry.length=50
" }, "descriptions" : { "type" : "array", "description" : "The description of the entry in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierType" : { "type" : "string", "description" : "The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=20
" }, "despatchCountries" : { "type" : "array", "description" : "The despatch countries the carrier is supporting. Check first 'isDespatchCountriesGlobal'. If the carrier operates globally, this list contains all countries.", "items" : { "$ref" : "#/components/schemas/DLCarrierDespatchCountryDTO" } }, "businessDivisions" : { "type" : "array", "description" : "The business divisions in which the carrier is working.", "items" : { "$ref" : "#/components/schemas/DLCarrierBusinessDivisionDTO" } }, "isDespatchCountriesGlobal" : { "type" : "boolean", "description" : "Indicates if the carrier operates globally. Therefore the list of despatchCountries contains all countries." }, "imprint" : { "type" : "string", "description" : "The official company name (corporate name) of the carrier according to homepage." }, "name" : { "type" : "string", "description" : "Name of carrier." } } }, "DLGetCarrierPortfolioNamesResponseDTO" : { "type" : "object", "description" : "Response DTO containing the codes and names of all available carriers.", "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" } }, "carrierNames" : { "type" : "array", "description" : "Codes and names of all available carriers.", "items" : { "$ref" : "#/components/schemas/DLCarrierPortfolioNameDTO" } } }, "xml" : { "name" : "getCarrierPortfolioNamesResponseDTO" } }, "DLGetCarrierPortfolioNamesRequestDTO" : { "type" : "object", "description" : "Request DTO to retrieve the codes and names of all available carriers.", "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" } }, "additionalInfos" : { "type" : "array", "description" : "List of additional infos which are requested for all carriers. If no list is supplied, no additional infos will be returned.", "items" : { "type" : "string" } } }, "xml" : { "name" : "getCarrierPortfolioNamesRequestDTO" } }, "DLGetCarrierPropertiesRequestDTO" : { "type" : "object", "description" : "Request DTO to retrieve various properties for a specific carrier.", "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" } }, "carrierIdentCode" : { "type" : "string", "description" : "Code uniquely referencing the requested carrier.length=20
" } }, "required" : [ "carrierIdentCode" ], "xml" : { "name" : "getCarrierPropertiesRequestDTO" } }, "DLGetPickupsResponseDTO" : { "type" : "object", "description" : "Data Transfer Object for pickup search result.", "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" } }, "pickups" : { "type" : "array", "description" : "The resulting pickups.", "items" : { "$ref" : "#/components/schemas/DLPickupResponseDataDTO" } } }, "xml" : { "name" : "getPickupsResponseDTO" } }, "DLPickupResponseDataDTO" : { "type" : "object", "description" : "DTO for response information of a DLShipmentPickup.", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages. If an error has occured the messages contain more details about the errors." }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any warning messages." }, "messages" : { "type" : "array", "description" : "Messages for the whole request, e.g. for errors or warnings.length=20
" }, "transactionId" : { "type" : "string", "description" : "ID uniquely referencing the corresponding pickup in the client system.
length=250
" }, "transactionLabel" : { "type" : "string", "description" : "Human readable text which identifies the pickup business transaction in the client system (not necessarily unique).
length=250
" }, "pickupNumber" : { "type" : "string", "description" : "Pickup number.
length=20
" }, "referenceNumber1" : { "type" : "string", "description" : "Reference number 1.
length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Reference number 2.
length=50
" }, "licensePlateNumber1" : { "type" : "string", "description" : "First license plate number.
length=50
" }, "licensePlateNumber2" : { "type" : "string", "description" : "Second license plate number.
length=50
" }, "driverSignature" : { "$ref" : "#/components/schemas/DLSignatureDTO", "description" : "Signature of the driver transporting the shipping orders. Only filled when asked for in request.
" }, "carrierIdentCode" : { "type" : "string", "description" : "The unique code of the pickup's carrier.
length=20
" }, "carrierNames" : { "type" : "array", "description" : "The name of the carrier in the requested languages.
length (of the texts in TextInLanguageDTO) = 50
", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierServiceNames" : { "type" : "array", "description" : "The name of the carrier service, for example 'DHL Express National 08:00' in the requested languages.length (of the texts in TextInLanguageDTO) = 50
", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierServiceCode" : { "type" : "string", "description" : "The unique code of the carrier service.length=50
" }, "accountInfo" : { "$ref" : "#/components/schemas/DLShipmentAccountInfoResponseDataDTO", "description" : "Information about the account used for the pickup." }, "shippingDate" : { "type" : "string", "description" : "Shipping date in the format 'yyyy-MM-dd'.length=10
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Shipping point of the pickup." }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact person on shipping point's side." }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO", "description" : "The pickup's current status. Possible values are:
length=5
" }, "numberOfShipments" : { "type" : "integer", "format" : "int32", "description" : "The number of shipments actually included in the pickup.length=5
" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "The additional values for the pickup. For the semantics of the returned field names lookup customizing in GUI or use thegetCarrierProperties business facade call."
},
"shipmentReferences" : {
"type" : "array",
"description" : "The shipments included in the pickup.",
"items" : {
"$ref" : "#/components/schemas/DLShipmentReferenceDTO"
}
},
"documents" : {
"type" : "array",
"description" : "The (manifest) documents for the pickup. Only filled when asked for in request.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
},
"edis" : {
"type" : "array",
"description" : "The EDI messages of the pickup.",
"items" : {
"$ref" : "#/components/schemas/DLShipmentPickupEDIDTO"
}
}
}
},
"DLShipmentPickupEDIDTO" : {
"type" : "object",
"description" : "Response-DTO for an EDI message for a pickup.",
"properties" : {
"ediNumber" : {
"type" : "string",
"description" : "Unique number of EDI message.
length = 25
" }, "ediDescription" : { "type" : "string", "description" : "Description of the EDI message (and of the EDI setup).
length = 500
" }, "carrierEDINumber" : { "type" : "string", "description" : "Number uniquely identifying the EDI message for carrier.
length = 50
" }, "isManifested" : { "type" : "boolean", "description" : "Indicates that the EDI message has been transmitted to the carrier.
" }, "isManifestedWithErrors" : { "type" : "boolean", "description" : "Indicates that an error occurred while transmitting the EDI message.
" }, "isManifestedWithWarnings" : { "type" : "boolean", "description" : "Indicates that warnings occurred while transmitting the EDI message. However, the EDI message has been accepted by the carrier. The reasons for the warnings should be corrected during the next transmissions.
" }, "unconfirmedErrorCode" : { "type" : "string", "description" : "If an error occurred while transmitting the EDI message and an error code was available, it is return in this field.
length = 10
" }, "unconfirmedMessage" : { "type" : "string", "description" : "If an error occurred while transmitting the EDI message, its message is returned in this field.
length = 999
" }, "ediSetupIdentCode" : { "type" : "string", "description" : "Unique identifier of the EDI definition.
length = 20
" }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO", "description" : "The EDI message's current status. Possible values are:
The number of shipping orders contained in the EDI message.
" }, "shipmentReferences" : { "type" : "array", "description" : "The shipments included in the EDI message.
", "items" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" } } } }, "DLGetPickupsRequestDTO" : { "type" : "object", "description" : "DTO to search for pickups and request detail information about them.", "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" } }, "pickupReferences" : { "type" : "array", "description" : "The list of pickups references for which detail information is requested. Cannot be used with the filter at the same time.
", "items" : { "$ref" : "#/components/schemas/DLPickupReferenceDTO" } }, "includeDocuments" : { "type" : "boolean", "description" : "Controls, if the documents should be included in the response of each pickup. Default is 'false'." }, "includeDriverSignature" : { "type" : "boolean", "description" : "Controls, if the signature of the driver should be included in the response of each pickup. Default is 'false'." }, "filter" : { "$ref" : "#/components/schemas/DLPickupFilterDTO", "description" : "Controls, which pickups should be returned. Cannot be used with pickup references at the same time.
" } }, "xml" : { "name" : "getPickupsRequestDTO" } }, "DLPickupFilterDTO" : { "type" : "object", "description" : "DTO to set a filter for a pickup query.", "properties" : { "carrierIdentCode" : { "type" : "string", "description" : "The unique code of the carrier.length=50
" }, "shippingPtNameOrNumber" : { "type" : "string", "description" : "Considers the company number and the name of the shipping point address.length=50
" }, "shippingDateFrom" : { "type" : "string", "format" : "date-time", "description" : "Shipping date of the pickup in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in timezone 'UTC'.length=10
" }, "shippingDateTo" : { "type" : "string", "format" : "date-time", "description" : "Shipping date of the pickup in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in timezone 'UTC'.length=10
" }, "isClosed" : { "type" : "boolean", "description" : "Controls, if only closed respectively not closed pickups should be considered." }, "isManifested" : { "type" : "boolean", "description" : "Controls, if only manifested respectively not manifested pickups should be considered." }, "isWithError" : { "type" : "boolean", "description" : "Controls, if only pickups with errors or without errors should be considered." }, "isNotCompletedPattern" : { "type" : "boolean", "description" : "Controls, if only completed respectively not completed pickups should be considered." }, "boStatusIdentCode" : { "type" : "string", "description" : "The pickup's current status. Possible values are:
length=20
" }, "referenceNumber" : { "type" : "string", "description" : "Considers pickup reference number 1 and reference number 2.length=50
" }, "transactionId" : { "type" : "string", "description" : "Considers the ID uniquely referencing the corresponding pickup in the client system.length=250
" }, "transactionLabel" : { "type" : "string", "description" : "Considers the human readable text which identifies the pickup business transaction in the client system (not necessarily unique).
length=250
" }, "maxPickups" : { "type" : "integer", "format" : "int32", "description" : "The maximum number of pickups to be returned. If no value is specified, a default of 100 is assumed.length=4
" } } }, "DLGetShipmentsResponseDTO" : { "type" : "object", "description" : "Data Transfer Object for shipment search result.", "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" } }, "shipments" : { "type" : "array", "description" : "The resulting shipments.", "items" : { "$ref" : "#/components/schemas/DLShipmentResponseDataDTO" } } }, "xml" : { "name" : "getShipmentsResponseDTO" } }, "DLHazardousGoodsItemResponseDataDTO" : { "type" : "object", "description" : "DTO for response information of a DLHazardousGoodsItem.", "properties" : { "unNumber" : { "type" : "string", "description" : "UN numberlength=8
" }, "hazardRegulation" : { "type" : "string", "description" : "Hazardous regulation to be applied. Valid values are:length=10
" }, "technicalName" : { "type" : "string", "description" : "Technical name
length=250
" }, "hazardAdditionalDescription" : { "type" : "string", "description" : "Additional descriptionlength=250
" }, "hazardousGoodsType" : { "type" : "string", "description" : "The type of hazardous goods. Possible values are:
length=10
" }, "subriskClass1" : { "type" : "string", "description" : "Sub risk 1 hazardous class. Valid values are:
length=10
" }, "subriskClass2" : { "type" : "string", "description" : "Sub risk 2 hazardous class.Valid values are:
length=10
" }, "classificationCode" : { "type" : "string", "description" : "Classification code
length=4
" }, "tunnelCode" : { "type" : "string", "description" : "Tunnel code
length=10
" }, "packagingGroup" : { "type" : "string", "description" : "Hazardous packaging group. Valid values are:
length=10
" }, "packingInstruction" : { "type" : "string", "description" : "IATA packing instruction. Consists of the instruction code (up to three digits with optional prefix Y) optionally followed by a section identification (up to two upper case characters).
length=10
" }, "specialProvision" : { "type" : "string", "description" : "Special provisions for the carriage of hazardous goods. Consists of the provision code (up to three digits) or the chapter specification (up to three digits), optionally followed by sub-chapters (up to two digits or one digit and an upper case character). Chapter and subchapters must be separated by a dot. Also possible are 3 capital letters + hyphen, followed by further numbers or letters or 1 capital letter followed by numbers. Example Values are:length=20
" }, "multiplicator" : { "type" : "string", "description" : "Hazardous multiplicatorlength=10
" }, "packageTypeIdentCode" : { "type" : "string", "description" : "IdentCode of the package type. Valid values are depending on the client's package types in the master file data.
length=20
" }, "hazardWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The specific weight of the hazardous material." }, "hazardNetQuantity" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The net quantity of the hazardous material. Can be net weight or volume like liter." }, "netExplosiveWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The net explosive weight value of the hazardous material." }, "numberOfPackages" : { "type" : "integer", "format" : "int32", "description" : "Number of packages
length=10
" }, "hazardLabel" : { "type" : "string", "description" : "Hazardous labellength=10
" }, "transportCategory" : { "type" : "string", "description" : "Transport categorylength=4
" }, "specialSubstanceType" : { "type" : "string", "description" : "Special Substance type. Valid Values are:
length=30
" }, "hazardPoints" : { "type" : "integer", "format" : "int32", "description" : "Hazardous points
length=5
" }, "flashPoint" : { "type" : "string", "description" : "Flash pointlength=20
" }, "emergencyContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Emergency contact person." }, "transportAuthorization" : { "type" : "string", "description" : "Transport authorization. Additional information that may be required by regulation about a hazardous material such as DOT-SP number (Special Permit), LAA number...length=250
" }, "marinePollutant" : { "type" : "string", "description" : "Indicates if the substance is a marine pollutant according to IMDG or CFR. Valid Values are:length=20
" }, "controlTemperature" : { "type" : "string", "description" : "The control temperature according to IMDG or CFR.
length=4
" }, "emergencyTemperature" : { "type" : "string", "description" : "The emergency temperature according to IMDG or CFR.
length=4
"
},
"isEnvironmentallyHazardous" : {
"type" : "boolean",
"description" : "Indicates if the substance is environmentally hazardous according to ADR or IATA."
},
"isReportableQuantity" : {
"type" : "boolean",
"description" : "Indicates if package contains hazardous materials in an amount that needs to be reported."
},
"isTransportByCargoAircraftOnly" : {
"type" : "boolean",
"description" : "Indicates if the transportation is only allowed in the cargo aircraft."
},
"additionalValues" : {
"$ref" : "#/components/schemas/GenericDataRecordDTO",
"description" : "The additional values for the hazardous goods item. For the semantics of the returned field names lookup customizing in GUI or use the getCarrierProperties business facade call."
}
}
},
"DLPackageHazardousGoodsDataResponseDTO" : {
"type" : "object",
"description" : "Holds hazardous goods data concerning the package.",
"properties" : {
"hazardousGoodsType" : {
"type" : "string",
"description" : "Indicates the type of hazardous goods packaged in the package. Possible values are:
length=2, scale=1
" } } }, "DLPackageResponseDataDTO" : { "type" : "object", "description" : "DTO for response information of a DLPackage.length=4
" }, "packageTransactionId" : { "type" : "string", "description" : "The unique transaction id of the package maintained by the client system.length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "The first reference number of the package.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "The second reference number of the package.length=50
" }, "carrierPackageNumber" : { "type" : "string", "description" : "The package number given by the carrier. Usually the tracking number.length=50
" }, "carrierPackageIdentBarcode" : { "type" : "string", "description" : "The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.length=50
" }, "carrierPackageNumberReturn" : { "type" : "string", "description" : "The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
" }, "carrierTrackingURL" : { "type" : "string", "description" : "The tracking URL of the package.length=512
" }, "carrierTrackingURLReturn" : { "type" : "string", "description" : "The additional return tracking URL of the package.length=512
" }, "packageTypeIdentCode" : { "type" : "string", "description" : "IdentCode of the package type. Valid values are depending on the client's package types in the master file data.length=20
" }, "contents" : { "type" : "string", "description" : "The description of the contents (goods) the package contains.length=250
" }, "dimensions" : { "$ref" : "#/components/schemas/DLCuboidDimensionsDTO", "description" : "Dimensions" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Gross weight" }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "The cash on delivery value. Only filled when carrier needs them on package level." }, "insuranceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Insurance value of the package" }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO", "description" : "The package's current status. Possible values are:
getCarrierProperties business facade call."
},
"documents" : {
"type" : "array",
"description" : "The documents for the package. Only filled when asked for in request.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
},
"hazardousGoodsData" : {
"$ref" : "#/components/schemas/DLPackageHazardousGoodsDataResponseDTO",
"description" : "Hazardous goods data concerning the package. Only relevant when shipping hazardous goods."
},
"marks" : {
"type" : "string",
"description" : "Marks and numbers for identification of a package. length=50" }, "stackability" : { "type" : "string", "description" : "The possibility to stack this package. If there is no such information, the value will be empty. Otherwise the possible values are:
length=10
" }, "nmfcSubCode" : { "type" : "string", "description" : "The NMFC subcode of the package. Relevant for US carriers.length=2
" } } }, "DLShipmentItemResponseDataDTO" : { "type" : "object", "description" : "DTO for shipment item data in a response.", "properties" : { "itemNumber" : { "type" : "integer", "format" : "int32", "description" : "The shipment item number internally generated by the carrier engine.length=4
" }, "itemTransactionId" : { "type" : "string", "description" : "The unique transaction id of the item maintained by the client system.length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "The first reference number of the item.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "The second reference number of the item.length=50
" }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO", "description" : "The shipment item's current status. Possible values are:
length=11
" }, "description" : { "type" : "string", "description" : "The shipping item's description.length=250
" }, "exportLicense" : { "type" : "string", "description" : "Export license.length=50
" }, "countryOfOriginsISOCode" : { "type" : "string", "description" : "Country of origins.length=2
" }, "certificateOfOrigins" : { "type" : "string", "description" : "Certificate of origins.length=50
" }, "quantity" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Quantity." }, "netWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Net weight" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Gross weight" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Total customs value of all item articles." }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Total goods value of all item articles." }, "despatchProcedureIdentCode" : { "type" : "string", "description" : "The despatch procedure. When filled, possible values are:
length=10
" }, "despatchProcedureNames" : { "type" : "array", "description" : "The names of the despatch procedure in the requested result languages.", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "referencesTexts" : { "type" : "array", "description" : "Further references texts of the item.", "items" : { "$ref" : "#/components/schemas/DLShipmentItemReferenceTextDTO" } }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "The additional values for the shipping item. For the semantics of the returned field names lookup customizing in GUI or use thegetCarrierProperties business facade call."
},
"hazardousGoodsItems" : {
"type" : "array",
"description" : "Hazardous goods items.",
"items" : {
"$ref" : "#/components/schemas/DLHazardousGoodsItemResponseDataDTO"
}
}
}
},
"DLShipmentResponseDataDTO" : {
"type" : "object",
"description" : "DTO for response information of a DLShipment.length=20
" }, "transactionId" : { "type" : "string", "description" : "ID uniquely referencing the corresponding business transaction in the client system.
length=250
" }, "organizationUnitClientSystem" : { "type" : "string", "description" : "Additional criteria two separate different organisational units within one Engine's client.length=255
" }, "shipmentNumber" : { "type" : "string", "description" : "The shipment number internally generated by the carrier engine.length=20
" }, "carrierShipmentNumber" : { "type" : "string", "description" : "The carrier tracking number of the shipment.length=50
" }, "carrierShipmentNumberReturn" : { "type" : "string", "description" : "The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
" }, "carrierTrackingURL" : { "type" : "string", "description" : "The tracking URL of the shipment.length=512
" }, "carrierTrackingURLReturn" : { "type" : "string", "description" : "The additional return tracking URL of the shipment.length=512
" }, "bulkMasterShipmentNumber" : { "type" : "string", "description" : "The internally generated shipment number of the bulk master if applicable. Must be used to access the bulk master shipment e.g. for adding packages, etc.length=20
" }, "revisionNumber" : { "type" : "integer", "format" : "int32", "description" : "Revision number.length=3
" }, "referenceNumber1" : { "type" : "string", "description" : "Reference number 1.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Reference number 2.length=50
" }, "customsRegistrationNumber" : { "type" : "string", "deprecated" : true, "description" : "Registration number (MRN, etc.) of the customs declaration. The number is assigned by the customs authorities.length=35
" }, "transportRegistrationNumber" : { "type" : "string", "deprecated" : true, "description" : "Transport registration number like EKAER (Hungary) or SENT (Poland). The number is assigned by the local authorities.length=35
" }, "shopId" : { "type" : "string", "deprecated" : true, "description" : "The ID of the shop to which the shipping order is sent.length=35
" }, "shipToServicePointID" : { "type" : "string", "description" : "The ID of the service point at which the consignee can pick up his shipping order.length=35
" }, "shipFromServicePointID" : { "type" : "string", "description" : "The ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up.length=35
" }, "remark" : { "type" : "string", "description" : "Optional textual remark. Used for internal purposes only. The information is not forwarded to any carrier.length=1000
" }, "pickupNumber" : { "type" : "string", "description" : "Pickup number. Is empty, when the shipment is not yet assigned to a pickup.length=20
" }, "pickupTransactionId" : { "type" : "string", "description" : "ID uniquely referencing the corresponding pickup in the client system. Is empty, when the shipment is not yet assigned to a pickup.
length=250
" }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO", "description" : "The shipment's current status. Possible values are:
Indicates that the shipment is complete.
" }, "carrierNames" : { "type" : "array", "description" : "The name of the carrier in the requested languages.
length (of the texts in TextInLanguageDTO) = 50
", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierIdentCode" : { "type" : "string", "description" : "The unique code of the carrier.length=50
" }, "carrierServiceNames" : { "type" : "array", "description" : "The name of the carrier service, for example 'DHL Express National 08:00' in the requested languages.length (of the texts in TextInLanguageDTO) = 50
", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "carrierServiceCode" : { "type" : "string", "description" : "The unique code of the carrier service.length=50
" }, "freightCosts" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "The freight costs that where calculated for this shipment." }, "shippingDate" : { "type" : "string", "description" : "Shipping date in the format 'yyyy-MM-dd'.length=10
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Shipping point of the shipment." }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact person on shipping point's side." }, "consignee" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Consignee of the shipment." }, "consigneeContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact person on consignee's side." }, "altInvoiceRecipient" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The alternative recipient of the commercial invoice if different from consignee." }, "altInvoiceRecipientContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "The contact of the alternative invoice recipient." }, "termsOfDeliveryCode" : { "type" : "string", "description" : "IdentCode of the terms of delivery. Valid values are depending on the client's terms of delivery in the master file data.length=20
" }, "incotermDestination" : { "type" : "string", "description" : "The incoterm destination of the shipment. The incoterm is included within the terms of delivery. Depending on the incoterm, it makes sense to specify a incoterm destination.length=50
" }, "portOfLoadingCode" : { "type" : "string", "description" : "The code of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=5
" }, "portOfLoading" : { "type" : "string", "description" : "The name of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=50
" }, "portOfDischargeCode" : { "type" : "string", "description" : "The code of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=5
" }, "portOfDischarge" : { "type" : "string", "description" : "The name of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=50
" }, "securityStatus" : { "type" : "string", "description" : "The security status of air freight for cargo/post or passenger aircraft transport. Valid values are:
length=12
" }, "fixedDate" : { "type" : "string", "description" : "Fixed delivery date of the shipment in the format 'yyyy-MM-dd'.Important: Only the date portion is transmitted to the carrier interfaces. The time portion is ignored, so it does not matter which time is passed.
length=10
" }, "latestRequestedDeliveryDate" : { "type" : "string", "description" : "Latest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
" }, "earliestRequestedDeliveryDate" : { "type" : "string", "description" : "Earliest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
" }, "latestCollectionBookingDate" : { "type" : "string", "description" : "Latest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
" }, "earliestCollectionBookingDate" : { "type" : "string", "description" : "Earliest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
" }, "collectionBookingNumber" : { "type" : "string", "description" : "The booking number of a requested collection booking assigned from carrier to this shipment.length=20
" }, "pickupAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The pick up address of the shipment. Only used in case of return shipments because otherwise it's equal to the shipping point." }, "pickupAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the pick up address of the shipment." }, "altReturnAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The alt. return address of the shipment. Only used in case of return shipments because otherwise it's equal to the shipping point." }, "altReturnAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the alt. return address of the shipment." }, "notifyAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The notify address of the shipment." }, "notifyAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the notify address of the shipment." }, "coverAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The cover address of the shipment." }, "coverAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the cover address of the shipment." }, "customsAgent" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The customs agent of the shipment." }, "customsAgentContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the customs agent of the shipment." }, "alternativeCarrierAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "Alternative carrier address to be printed on the label and the paper manifest. The address is only used (and required) if the carrier is configured accordingly. Note that in most configurations however the address stored in the carrier’s account is used." }, "alternativeCarrierAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Alternative contact of the carrier of the shipment. Used together with the alternative carrier address. The contact is optional. The contact is only used if the carrier is configured accordingly. Note that in most configurations however the address stored in the carrier’s account is used." }, "importerAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The importer of the shipment." }, "importerAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the importer of the shipment." }, "exporterAddress" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The exporter of the shipment." }, "exporterAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the exporter of the shipment." }, "valueAddedServices" : { "type" : "array", "description" : "Value added services of the shipment.", "items" : { "$ref" : "#/components/schemas/DLValueAddedServiceDTO" } }, "carrierInfoTexts" : { "type" : "array", "description" : "Carrier info texts for the shipment.", "items" : { "$ref" : "#/components/schemas/DLShipmentCarrierInfoTextDTO" } }, "payerOfChargRole" : { "type" : "string", "description" : "The payer of charges. Possible values are:
length=10
" }, "payerOfCharg" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The payer of charges address. Only required if payerOfChargRole is \"THIRDPARTY\"." }, "payerOfChargContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the payer of charges." }, "payerOfChargAccountNo" : { "type" : "string", "description" : "The payer of charges account number.length=50
" }, "payerOfDutRole" : { "type" : "string", "description" : "The payer of duties and taxes. Possible values are:
length=10
" }, "payerOfDut" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The payer of duties and taxes address. Only required if payerOfDutRole is \"THIRDPARTY\"." }, "payerOfDutContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the payer of duties and taxes." }, "payerOfDutAccountNo" : { "type" : "string", "description" : "The payer of duties and taxes account number.length=50
" }, "altPayerOfTaxRole" : { "type" : "string", "description" : "The alternative payer of taxes. Possible values are:
length=10
" }, "altPayerOfTax" : { "$ref" : "#/components/schemas/DLPartyDTO", "description" : "The alternative payer of taxes address." }, "altPayerOfTaxContact" : { "$ref" : "#/components/schemas/DLPersonDTO", "description" : "Contact of the alternative payer of taxes." }, "altPayerOfTaxAccountNo" : { "type" : "string", "description" : "The alternative payer of taxes account number.length=50
" }, "contents" : { "type" : "string", "description" : "Additional content discriptionlength=250
" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Goods value of the shipment" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Customs value of the shipment" }, "insuranceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Insurance value of the shipment" }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "The cash on delivery value." }, "isDocumentShipment" : { "type" : "boolean", "description" : "Indicates whether the shipment is a document shipment or not.
Note that this flag also defines which services can be used for the shipment.
" }, "numberOfPackages" : { "type" : "integer", "format" : "int32", "description" : "The number of packageslength=5
" }, "shipmentTotals" : { "$ref" : "#/components/schemas/DLShipmentTotalsResponseDataDTO", "description" : "Information about the shipment totals." }, "accountInfo" : { "$ref" : "#/components/schemas/DLShipmentAccountInfoResponseDataDTO", "description" : "Information about the account used for the shipment. Note that the account information is only available when the shipment is prepared for document processing." }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "The additional values for the shipment. For the semantics of the returned field names lookup customizing in GUI or use thegetCarrierProperties business facade call."
},
"packages" : {
"type" : "array",
"description" : "Information about the packages of the shipment.",
"items" : {
"$ref" : "#/components/schemas/DLPackageResponseDataDTO"
}
},
"items" : {
"type" : "array",
"description" : "Information about the items of the shipment.",
"items" : {
"$ref" : "#/components/schemas/DLShipmentItemResponseDataDTO"
}
},
"referencesTexts" : {
"type" : "array",
"description" : "Further references and texts for the shipment. Multiple references or texts with same type are allowed (e.g. to specify all different delivery note numbers contained in the shipment).",
"items" : {
"$ref" : "#/components/schemas/DLReferenceTextDTO"
}
},
"transportEquipments" : {
"type" : "array",
"description" : "The transport equipment of the shipment.",
"items" : {
"$ref" : "#/components/schemas/DLTransportEquipmentDTO"
}
},
"templateName" : {
"type" : "string",
"description" : "Information about the template initially used when creating the shipment. Empty if no template was used."
},
"isHazardousGoodsShipment" : {
"type" : "boolean",
"description" : "Indicates whether the shipment is a hazardous goods shipment or not."
},
"isContainingSpecialSubstances" : {
"type" : "boolean",
"description" : "Indicates whether the shipment is containing special substances or not."
},
"documents" : {
"type" : "array",
"description" : "Documents for the shipment",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
},
"houseAirwaybillNumber" : {
"type" : "string",
"description" : "The house airwaybill number identifies a single shipping order within the cargo of an aircraft. length=35
" }, "masterAirwaybillNumber" : { "type" : "string", "description" : "The master airwaybill number identifies the cargo of a complete aircraft.length=35
" }, "airline" : { "type" : "string", "description" : "The name of the airline company.length=35
" }, "flightNumber" : { "type" : "string", "description" : "The flight number specifies a specific flight of an airline.length=20
" } } }, "DLShipmentTotalsResponseDataDTO" : { "type" : "object", "description" : "DTO for shipment totals in a request.", "properties" : { "numberOfPackages" : { "type" : "integer", "format" : "int32", "description" : "The exact number of packages of the shipment. This value only is available when the shipment has been completed, so that the number of packages is known for sure.length=5
" }, "numberOfPackagesExpected" : { "type" : "integer", "format" : "int32", "description" : "The expected number of packages entered by user or ERP system Used to print the total number of packages on the label when documents are printed before all packages are available. Note: Should not be changed after the first label is printed. Otherwise the data on the label will be inconsistent.length=5
" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The exact gross weight of the shipment calculated from the gross weights of the individual packages. This value only is available when the shipment has been completed, so that all packages are known for sure." }, "grossWeightExpected" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "The expected shipment gross weight entered by user or ERP system. Used to print the gross weight on the label when documents are printed before all packages with their gross weights are available.length=10, scale=3
" }, "palletPlaces" : { "type" : "number", "description" : "The pallet places meters needed for the shipment. This value is only reliable when the shipment has been completed, so that all packages are known for sure.length=10, scale=3
" } } }, "DLGetShipmentsRequestDTO" : { "type" : "object", "description" : "DTO to search for shipments and request detail information about them.", "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" } }, "shipmentReferences" : { "type" : "array", "description" : "The list of shipment references for which detail information is requested. Cannot be used with the filter at the same time.
", "items" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" } }, "includeDocuments" : { "type" : "boolean", "description" : "Controls, if the (label) documents should be included in the response of each shipment. Default is 'false'." }, "withCanceledShipments" : { "type" : "boolean", "description" : "Controls, if canceled shipments should also be returned. Default is 'true'." }, "filter" : { "$ref" : "#/components/schemas/DLShipmentFilterDTO", "description" : "Controls, which shipments should be returned. Cannot be used with shipment references at the same time." } }, "xml" : { "name" : "getShipmentsRequestDTO" } }, "DLShipmentFilterDTO" : { "type" : "object", "description" : "DTO to set a filter for a shipment query.", "properties" : { "carrierIdentCode" : { "type" : "string", "description" : "The unique code of the carrier.length=50
" }, "shippingPtNameOrNumber" : { "type" : "string", "description" : "Considers the company number and the name of the shipping point address.length=50
" }, "consigneeName" : { "type" : "string", "description" : "Considers the company number and the name of the consignee's address..length=50
" }, "shippingDateFrom" : { "type" : "string", "format" : "date-time", "description" : "Shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in time zone 'UTC'.length=10
" }, "shippingDateTo" : { "type" : "string", "format" : "date-time", "description" : "Shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in time zone 'UTC'.length=10
" }, "isNotCompleted" : { "type" : "boolean", "description" : "Controls, if only completed respectively not completed shipments should be considered." }, "boStatusIdentCode" : { "type" : "string", "description" : "The shipment's current status. Possible values are:
length=7
" }, "referenceNumber" : { "type" : "string", "description" : "Considers shipment reference number 1 and reference number 2.length=50
" }, "carrierNumber" : { "type" : "string", "description" : "Considers the carrier tracking number of the shipment or the package.length=50
" }, "maxShipments" : { "type" : "integer", "format" : "int32", "description" : "The maximum number of shipments to be returned. If no value is specified, a default of 100 is assumed.length=4
" } } }, "DLProcessPackageResponseDTO" : { "type" : "object", "description" : "Response DTO for the getPackageDocuments business facade method", "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" } }, "carrierPackageNumber" : { "type" : "string", "description" : "The carrier tracking number of the package.length=50
" }, "carrierPackageIdentBarcode" : { "type" : "string", "description" : "The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.length=50
" }, "carrierPackageNumberReturn" : { "type" : "string", "description" : "The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
" }, "documents" : { "type" : "array", "description" : "The documents for the package. Only filled when asked for in request (documentOutputMode).", "items" : { "$ref" : "#/components/schemas/DLDocumentDTO" } } }, "xml" : { "name" : "processPackageResponseDTO" } }, "DLMasterPackageReferenceDTO" : { "type" : "object", "description" : "DTO for uniquely identifying a master package.", "properties" : { "packageTransactionId" : { "type" : "string", "description" : "The number of the client system uniquely referencing a master shipment package.length=50
" } }, "required" : [ "packageTransactionId" ] }, "DLPackageDocumentPrepareModeDTO" : { "type" : "object", "description" : "DTO specifying the prepare mode for documents on package level.", "properties" : { "mode" : { "type" : "string", "description" : "The prepare mode for the package documents. Valid values are:
length=20
" } }, "required" : [ "mode" ] }, "DLPackageOperationModeDTO" : { "type" : "object", "description" : "Holds a special operation ID to be performed on the package. NOTE: this function has BETA status.", "properties" : { "mode" : { "type" : "string", "description" : "The operation mode for the operation to be performed on the package. Valid values are:
length=15
" } }, "required" : [ "mode" ] }, "DLPackageProcessParmsDTO" : { "type" : "object", "description" : "Process parameters for a package. Specifies which operations have to be performed on a package.", "properties" : { "processMode" : { "$ref" : "#/components/schemas/DLProcessModeDTO", "description" : " Controls the preparation process. In case of 'BASIC' preparation, the preparation is processed asynchronously in a job. In case of 'EXTENDED' preparation, all preparation actions are directly executed synchronously and the response is not returned before the complete label preparation process is finished. It may then include extended carrier validation results. An error will be returned if the validation fails.
Keep in mind that processMode 'EXTENDED' consumes more system resources and reduces the effect of load balancing. It should only be used in case the client system requires an immediate response including the label preparation results of the package.
" }, "documentPrepareMode" : { "$ref" : "#/components/schemas/DLPackageDocumentPrepareModeDTO", "description" : "Controls the extent of preparation for the referenced package." }, "workstationId" : { "type" : "string", "description" : " The workstation used to detect the printer for which the documents should be prepared, printed or returned.
An error will be returned when the package documents (labels) are already prepared (invoked by a previous call) and are now be be printed with a different workstationId containing an incompatible printer.
length=50
" }, "documentOutputMode" : { "$ref" : "#/components/schemas/DLDocumentOutputModeDTO", "description" : "Controls the output mode for the package's documents." }, "operationMode" : { "$ref" : "#/components/schemas/DLPackageOperationModeDTO", "description" : "Controls the operation mode performed on the package." } }, "required" : [ "documentOutputMode", "documentPrepareMode", "processMode", "workstationId" ] }, "DLProcessPackageRequestDTO" : { "type" : "object", "description" : "Request DTO for the getPackageDocuments business facade method.", "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" } }, "packageReference" : { "$ref" : "#/components/schemas/DLPackageReferenceDTO", "description" : "The package to be processed.
" }, "processParms" : { "$ref" : "#/components/schemas/DLPackageProcessParmsDTO", "description" : "The operations to be performed on the referenced package." }, "targetShipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO", "description" : "A package can be moved to a different shipment. The operationMode \"MOVE_PACKAGE\" must be used." }, "masterPackageReference" : { "$ref" : "#/components/schemas/DLMasterPackageReferenceDTO", "description" : "Referencing the corresponding master package in the client system.
" }, "items" : { "type" : "array", "description" : "The items to be added to the package or to be modified. The field may be empty when only processing is required.", "items" : { "$ref" : "#/components/schemas/DLShipmentItemReferenceDTO" } }, "updateData" : { "$ref" : "#/components/schemas/DLProcessPackageUpdateRequestDataDTO", "description" : "Package update data. The field may be empty when the package should not be updated." } }, "required" : [ "packageReference", "processParms" ], "xml" : { "name" : "processPackageRequestDTO" } }, "DLProcessPackageUpdateRequestDataDTO" : { "type" : "object", "description" : "DTO for package fields which can be updated after the initial creation of the package", "properties" : { "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO", "description" : "Gross weight" }, "dimensions" : { "$ref" : "#/components/schemas/DLCuboidDimensionsDTO", "description" : "Dimensions" } }, "required" : [ "grossWeight" ] }, "DLProcessPackageReturnEnclosedLabelResponseDTO" : { "type" : "object", "description" : "Response DTO for the processPackageReturnEnclosedLabel business facade method", "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" } }, "documents" : { "type" : "array", "description" : "The return labels for the package. Only filled when asked for in request (documentOutputMode).", "items" : { "$ref" : "#/components/schemas/DLDocumentDTO" } } }, "xml" : { "name" : "processPackageReturnEnclosedLabelDTO" } }, "DLPackageReturnEnclosedLabelProcessParmsDTO" : { "type" : "object", "description" : "Process parameters for a package enclosed return label. Specifies which operations have to be performed on a package return enclosed label.", "properties" : { "workstationId" : { "type" : "string", "description" : " The workstation used to detect the printer for which the labels should be prepared, printed or returned.
An error will be returned when the package documents (labels) are already prepared (invoked by a previous call) and are now be be printed with a different workstationId containing an incompatible printer.
length=50
" }, "returnEnclosedLabelOutputMode" : { "$ref" : "#/components/schemas/DLReturnEnclosedLabelOutputModeDTO", "description" : "Controls the output mode for the package's return enclosed labels." } }, "required" : [ "returnEnclosedLabelOutputMode", "workstationId" ] }, "DLProcessPackageReturnEnclosedLabelRequestDTO" : { "type" : "object", "description" : "Request DTO for the processPackageReturnEnclosedLabel business facade method.", "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" } }, "packageReference" : { "$ref" : "#/components/schemas/DLPackageReferenceDTO", "description" : "The package to be processed.
" }, "processParms" : { "$ref" : "#/components/schemas/DLPackageReturnEnclosedLabelProcessParmsDTO", "description" : "The operations to be performed on the referenced package." } }, "required" : [ "packageReference", "processParms" ], "xml" : { "name" : "processPackageReturnEnclosedLabelDTO" } }, "DLReturnEnclosedLabelOutputModeDTO" : { "type" : "object", "description" : "DTO specifying the output mode for return enclosed labels.", "properties" : { "mode" : { "type" : "string", "description" : "The output mode for the return enclosed label. Valid values are:
length=15
" } }, "required" : [ "mode" ] }, "DLProcessPickupResponseDTO" : { "type" : "object", "description" : "Response DTO for the printDocumentsForPickup business facade method", "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" } }, "documents" : { "type" : "array", "description" : "The documents (manifests) of the pickup. Only filled, when specified indocumentOutputMode of request.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
}
},
"xml" : {
"name" : "processPickupResponseDTO"
}
},
"DLPickupUpdateRequestDataDTO" : {
"type" : "object",
"description" : "DTO for pickup fields which can be updated after the initial creation of the pickup",
"properties" : {
"driverSignature" : {
"$ref" : "#/components/schemas/DLSignatureDTO",
"description" : "Signature of the driver transporting the shipping orders."
}
}
},
"DLProcessPickupRequestDTO" : {
"type" : "object",
"description" : "Request DTO for the printDocumentsForPickup business facade method",
"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" } }, "pickupReference" : { "$ref" : "#/components/schemas/DLPickupReferenceDTO", "description" : "The pickup containing the manifest documents to print or return in response.
" }, "creationParms" : { "$ref" : "#/components/schemas/DLPickupCreationParmsDTO", "description" : "Only relevant if the field 'shipments' is filled. Controls how the shipments are handled that should be added to the pickup." }, "pickupUpdateData" : { "$ref" : "#/components/schemas/DLPickupUpdateRequestDataDTO", "description" : "Pickup update data. The field may be empty when the pickup should not be updated." }, "shipments" : { "type" : "array", "description" : "Shipments to be added to the pickup.", "items" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" } }, "processParms" : { "$ref" : "#/components/schemas/DLPickupProcessParmsDTO", "description" : "Controls how to process the pickup, especially the handling of the manifest documents." } }, "required" : [ "pickupReference", "processParms" ], "xml" : { "name" : "processPickupRequestDTO" } }, "DLProcessShipmentResponseDTO" : { "type" : "object", "description" : "Response DTO for the processShipment business facade method.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" } }, "carrierShipmentNumber" : { "type" : "string", "description" : "The carrier tracking number of the shipment.length=50
" }, "carrierShipmentNumberReturn" : { "type" : "string", "description" : "The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
" }, "carrierTrackingURL" : { "type" : "string", "description" : "The tracking URL of the shipment.length=512
" }, "carrierTrackingURLReturn" : { "type" : "string", "description" : "The additional return tracking URL of the shipment.length=512
" }, "packageResults" : { "type" : "array", "description" : "The results on package level.", "items" : { "$ref" : "#/components/schemas/DLPackageProcessingResultDTO" } }, "documents" : { "type" : "array", "description" : "The documents of the shipment. Only filled, when specified indocumentOutputMode of request and shipment documents for printing exist. This also works for reprint.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
}
},
"xml" : {
"name" : "processShipmentResponseDTO"
}
},
"DLProcessShipmentRequestDTO" : {
"type" : "object",
"description" : "Request DTO for the processShipment business facade method",
"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" } }, "creationParms" : { "$ref" : "#/components/schemas/DLShipmentCreationParmsDTO", "description" : "Controls how to create the new packages of the shipment. The field may be empty when no packages are specified in field 'packages'." }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO", "description" : "Reference of the shipment to be processed. Mandatory field.
" }, "shipmentTotals" : { "$ref" : "#/components/schemas/DLShipmentTotalsRequestDataDTO", "description" : "Shipment totals. The field may be empty." }, "shipmentUpdateData" : { "$ref" : "#/components/schemas/DLShipmentUpdateRequestDataDTO", "description" : "Shipment update data. The field may be empty when the shipment should not be updated.length=10
" }, "fixedDate" : { "type" : "string", "description" : "The new fixed date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The fixed date is expected to be in timezone 'UTC'.length=10
" }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Update the cash on delivery value." }, "insuranceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Update the insurance value of the shipment" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Update goods value of the shipment" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Update customs value of the shipment" }, "invoiceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Update invoice value of the shipment" }, "customsRegistrationNumber" : { "type" : "string", "deprecated" : true, "description" : "Update registration number (MRN, etc.) of the customs declaration." }, "transportRegistrationNumber" : { "type" : "string", "deprecated" : true, "description" : "Update transport registration number like EKAER (Hungary) or SENT (Poland)." }, "shopId" : { "type" : "string", "deprecated" : true, "description" : "Update the ID of the shop to which the shipping order is sent." }, "shipToServicePointID" : { "type" : "string", "description" : "Update the ID of the service point at which the consignee can pick up his shipping order." }, "shipFromServicePointID" : { "type" : "string", "description" : "Update the ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up." }, "remark" : { "type" : "string", "description" : "Update internal remark of the shipment." }, "airline" : { "type" : "string", "description" : "Update the airline company of the shipment." }, "flightNumber" : { "type" : "string", "description" : "Update the airline flight number of the shipment." }, "masterAirwaybillNumber" : { "type" : "string", "description" : "Update the master airwaybill number of the shipment." }, "houseAirwaybillNumber" : { "type" : "string", "description" : "Update the house airwaybill number of the shipment." }, "portOfLoadingCode" : { "type" : "string", "description" : "The code of the port or airport where the goods are loaded." }, "portOfLoading" : { "type" : "string", "description" : "The name of the port or airport where the goods are loaded." }, "portOfDischargeCode" : { "type" : "string", "description" : "The code of the port or airport where the goods are unloaded." }, "portOfDischarge" : { "type" : "string", "description" : "Update the name of the port or airport where the goods are unloaded." }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "Update of additional values for the shipment. The definition of the included fields depends on the carrier. Only field names defined in the carrier customizing are allowed here.getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
},
"extCarrierShipNum" : {
"type" : "string",
"description" : "Update the external carrier tracking number of the shipment."
},
"bulkMasterReferenceNumber1" : {
"type" : "string",
"description" : "Update the referenceNumber1 if the shipment is a bulk master."
}
}
},
"DLSyncPickupsResponseDTO" : {
"type" : "object",
"description" : "Data Transfer Object for a pickup synchronize result.",
"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" } }, "syncId" : { "type" : "string", "description" : "Sync id for delta transmission of pickups. Use this syncId in subsequent calls tosyncPickups. length=20
" }, "isComplete" : { "type" : "boolean", "description" : "True, if the synchronization is complete. False if not. Because a maximum of 100 pickups is returned with one call of syncPickups, the result may be incomplete.
To get ALL pickups make repeated calls of syncPickups, always passing the last returned DLSyncShipmentPickupsResponseDTO.syncId.
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" } }, "ageInDays" : { "type" : "integer", "format" : "int32", "description" : "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" : { "type" : "string", "description" : "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" : { "type" : "boolean", "description" : "Controls, if the documents should be included in the response. Default is 'false'." }, "includeDriverSignature" : { "type" : "boolean", "description" : "Controls, if the signature of the driver should be included in the response. Default is 'false'." } }, "xml" : { "name" : "syncPickupsRequestDTO" } }, "DLSyncShipmentsResponseDTO" : { "type" : "object", "description" : "Data Transfer Object for a shipment synchronize result.", "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" } }, "syncId" : { "type" : "string", "description" : "Sync id for delta transmission of shipments. Use this syncId in subsequent calls tosyncShipments. length=20
" }, "isComplete" : { "type" : "boolean", "description" : "True, if the synchronization is complete. False if not. Because a maximum of 100 shipments is returned with one call of syncShipments, the result may be incomplete.
To get ALL shipments make repeated calls of syncShipments, always passing the last returned DLSyncShipmentsResponseDTO.syncId.
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" } }, "ageInDays" : { "type" : "integer", "format" : "int32", "description" : "Initializes the delta transmission of shipments (syncId must be null). Only shipments with this age or younger will be synchronized. Relevant date is the shipping date.
If this field is 0, synchronization starts with all shipments.
length=10
" }, "syncId" : { "type" : "string", "description" : "For delta-transmissions after initialization (ageInDays must be null).
Fill this field with the DLSyncShipmentsResponseDTO.syncId returned in the last call of syncShipments. As initial value use 0 or 1.
length=20
" }, "includeDocuments" : { "type" : "boolean", "description" : "Controls, if the (label) documents should be included in the response. Default is 'false'." } }, "xml" : { "name" : "syncShipmentsRequestDTO" } }, "DLUpdateCustomsDataResponseDTO" : { "type" : "object", "description" : "Response DTO for the updateCustomsData business facade method", "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" } } }, "xml" : { "name" : "updateCustomsDataResponseDTO" } }, "DLReferenceTextUCDDTO" : { "type" : "object", "description" : "DTO for reference numbers and texts of a certain (predefined) type.", "properties" : { "type" : { "type" : "string", "description" : "The type of the reference number or text. Valid values are:
length=15
" }, "value" : { "type" : "string", "description" : "The value of the reference number or text.length=500
" } } }, "DLShipmentItemReferenceTextUCDDTO" : { "type" : "object", "description" : "DTO for reference numbers and texts of a certain (predefined) type. This is the same DTO like DLShipmentItemReferenceTextDTO, but supports fewer types.", "properties" : { "type" : { "type" : "string", "description" : "\nThe type of the reference number or text. Valid values are:\n
length=30
\n" }, "value" : { "type" : "string", "description" : "The value of the reference number or text.length=500
" } } }, "DLShipmentItemReferenceUCDDTO" : { "type" : "object", "description" : "DTO for uniquely identifying an item within a shipment.", "properties" : { "itemTransactionId" : { "type" : "string", "description" : "The number of the client system uniquely referencing an item in a shipment.length=50
" }, "referenceNumber1" : { "type" : "string", "description" : "Another item reference number. May be used, when an item was not created by the client system and therefore has noitemTransactionId. If both fields are filled, they both must match the item. length=50
" } } }, "DLUpdateCustomsDataRequestDTO" : { "type" : "object", "description" : "Request DTO for the updateCustomsData business facade method", "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" } }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO", "description" : "Reference of the shipment to be updated. Mandatory field.
" }, "customsShipmentData" : { "$ref" : "#/components/schemas/DLUpdateCustomsShipmentRequestDataDTO", "description" : "Shipment data. The field may be empty when there's no need to update shipment data. Only a few customs fields in shipment are supported." }, "customsItemData" : { "type" : "array", "description" : "Item data. The field may be empty when there's no need to update any existing item. Only customs fields for items are supported.", "items" : { "$ref" : "#/components/schemas/DLUpdateCustomsItemRequestDataDTO" } }, "customsReferencesTexts" : { "type" : "array", "description" : "Updates references and texts data. The field may be empty when there's no need to update any references and texts. This update deletes all existing references with the types included in this request from the shipment and adds the references and texts from the request to the shipment. Remember: All references of every reference type included in this request will be deleted! Only customs relevant references and texts are accepted. Therefore the following reference types are allowed only:getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
}
},
"required" : [ "shipmentReference" ],
"xml" : {
"name" : "updateCustomsDataRequestDTO"
}
},
"DLUpdateCustomsItemRequestDataDTO" : {
"type" : "object",
"description" : "DTO for a few shipment item fields which can be updated after the initial creation of the shipment. This DTO includes customs data ONLY. No item net / gross weight or quantity is included, because this causes problems with packed items and is in most cases incompatible with the default shipping process. E.g. gross weight is often printed onto the label, updating weight after label printing is too late.",
"properties" : {
"shipmentItemReference" : {
"$ref" : "#/components/schemas/DLShipmentItemReferenceUCDDTO",
"description" : "Reference of the shipment item to be updated. Mandatory field."
},
"customsTariffNumber" : {
"type" : "string",
"description" : "The customs tariff number of the shipping item's contents. length=11
" }, "description" : { "type" : "string", "description" : "The shipping item's description.length=250
" }, "countryOfOriginsISOCode" : { "type" : "string", "description" : "Country of origins.length=2
" }, "certificateOfOrigins" : { "type" : "string", "description" : "Certificate of origins.length=50
" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Total customs value of all item articles." }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO", "description" : "Total goods value of all item articles." }, "customsReferencesTexts" : { "type" : "array", "description" : "Updates reference texts data.\nThe field may be empty when there's no need to update any references and texts.getCarrierProperties business facade call to retrieve all valid field names for a specific carrier."
}
},
"required" : [ "shipmentItemReference" ]
},
"DLUpdateCustomsShipmentRequestDataDTO" : {
"type" : "object",
"description" : "Request DTO for a few shipment fields which can be updated after the initial creation of the shipment.",
"properties" : {
"customsValue" : {
"$ref" : "#/components/schemas/AmountOfMoneyDTO",
"description" : "Customs value of the shipment. Updates customs value if both fields value & currency are filled. You cannot reset or delete an existing customs value."
},
"goodsValue" : {
"$ref" : "#/components/schemas/AmountOfMoneyDTO",
"description" : "Goods value of the shipment. Update goods value if both fields value & currency are filled. You cannot reset or delete an existing goods value."
},
"invoiceValue" : {
"$ref" : "#/components/schemas/AmountOfMoneyDTO",
"description" : "Invoice value of the shipment. Update invoice value if both fields value & currency are filled. You cannot reset or delete an existing invoice value."
}
}
},
"DLValidateShipmentResponseDTO" : {
"type" : "object",
"description" : "Possible Result Values: VALIDATION_FAILED VALIDATION_OK VALIDATION_REQUEST_NOT_SUPPORTED VALIDATION_MISSING_DATA VALIDATION_NO_CHECK_SELECTED VALIDATION_EXECUTION_ERROR",
"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" } }, "validationResult" : { "type" : "string", "description" : "\"VALIDATION_OK\" or any of the other constants to indicate the result of the validation." } }, "xml" : { "name" : "validateShipmentReponseDTO" } }, "DLShipmentValidationParmsDTO" : { "type" : "object", "description" : "DTO class for shipment validation parameter request data. Possible validation modes: ROUTE_SERVED and SERVICE_COMPLIANT", "properties" : { "validationMode" : { "type" : "string", "description" : "The validation mode of the shipment. The different modes must be separated by '|' if more than one mode wants to be used, at the same time. Valid values are:
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" } }, "shipment" : { "$ref" : "#/components/schemas/DLShipmentRequestDataDTO", "description" : "The data necessary to create the shipment." }, "validationParms" : { "$ref" : "#/components/schemas/DLShipmentValidationParmsDTO", "description" : "Options used for the validation of the shipment data." } }, "required" : [ "shipment", "validationParms" ], "xml" : { "name" : "validateShipmentRequestDTO" } }, "AFExecuteProcessParmsDTO" : { "type" : "object", "description" : "Parameters of UI API invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.", "properties" : { "executableFile" : { "type" : "string", "description" : "The name of the executable (including path name, or expected to be found within search path) This must not contain any parameters, and it must not be enclosed with quotes even if the string contains spaces." }, "parameters" : { "type" : "string", "description" : "Parameters to the executable. may be null. most processes expect parameters separated by spaces, and honor enclosing quotes for a parameter if it contains spaces." }, "workDir" : { "type" : "string", "description" : "The current directory to be set for the process created as given in executable may be null" } } }, "AFShellExecuteParmsDTO" : { "type" : "object", "description" : "Parameters of application UI API when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the contents of the file is given in the variable 'contents'. Then \"shellExecute\" has to be invoked which assumes that the file type as given by filename is registered on client's machine", "properties" : { "fileName" : { "type" : "string", "description" : "This is the name of the file that has to be created in some temporary directory and filled with what contents contains" }, "contents" : { "type" : "string", "format" : "byte", "description" : "This is the contents that has to be written to the file" } } }, "ApplicationFacadeDTO" : { "type" : "object", "description" : "A data transfer object which describes an UI API. There are various techniques possible how to \"open\" the \"application\" on the client; typically only one of the fields is filled, but when more than one possibility is not null the client may choose the type most suitable. Supported types includeThe caller must ensure that the corresponding session has been established
" }, "language" : { "type" : "string", "description" : "The two letter ISO code of the language of the new session.", "example" : "en" }, "displayFullWorkplace" : { "type" : "boolean", "description" : "true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.",
"example" : true
},
"isACEmbedded" : {
"type" : "boolean",
"description" : "true to display header and statusbar, false if ac should be embedded in another",
"example" : true
},
"displayStatusbar" : {
"type" : "boolean",
"description" : "true to display statusbar, false",
"example" : true
},
"displayTitlebar" : {
"type" : "boolean",
"description" : "true to display header, false if ac should not show header",
"example" : true
},
"stylevariant" : {
"type" : "string",
"description" : "Deprecated.",
"example" : "NEUTRAL"
},
"acceptTechnology" : {
"type" : "string",
"description" : "Specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: VAADIN) if null a default technology is chosen.",
"example" : "VAADIN"
},
"productname" : {
"type" : "string",
"description" : "Optional field, which may be set if productname differs from standard product name"
},
"productShortName" : {
"type" : "string",
"description" : "Optional field, which may be set if productShortName differs from standard product name"
},
"preferredWidth" : {
"type" : "integer",
"format" : "int32",
"description" : "Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way"
},
"preferredHeight" : {
"type" : "integer",
"format" : "int32",
"description" : "Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way"
},
"openToTray" : {
"type" : "boolean",
"description" : "Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored"
}
}
},
"LogonResponse" : {
"type" : "object",
"properties" : {
"token" : {
"type" : "string"
},
"userName" : {
"type" : "string"
},
"client" : {
"type" : "string"
},
"roles" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"error" : {
"type" : "string"
}
}
},
"LogonArgument" : {
"type" : "object",
"properties" : {
"userName" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"clientName" : {
"type" : "string"
},
"localeName" : {
"type" : "string"
}
}
},
"AcknowledgePublishedDataFeedPartsResponseDTO" : {
"type" : "object",
"description" : "Response (result) for IDataFeedBF#acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.",
"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" } } } }, "AcknowledgePublishedDataFeedPartsRequestDTO" : { "type" : "object", "description" : "Request parameter for Response (result) for IDataFeedBF#acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.", "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" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for acknowledging.Use the value received with GetPublishedDataFeedPartsResponseDTO#syncId with the last call to IDataFeedBF#getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO) to acknowledge the processed published data feed parts.
length=20
" } } }, "GetPublishedDataFeedPartsResponseDTO" : { "type" : "object", "description" : "Response (result) for IDataFeedBF#getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).", "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" } }, "publishedFeedParts" : { "type" : "array", "description" : "Zero or one PublishedDataFeedPartDTO.Use this syncId in subsequent calls to IDataFeedBF#acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO) to acknowledge the processing of the published data feed parts.
This syncId may be null if no published data feed parts were found to synchronize. In this case no call to IDataFeedBF#acknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO) is necessary.
length=20
" }, "isComplete" : { "type" : "boolean", "description" : "true if the synchronization is complete and currently no further published data feed parts are available."
}
}
},
"PublishedDataFeedPartDTO" : {
"type" : "object",
"description" : "DTO to hold the data of a published data feed part.",
"properties" : {
"dataFeedDefinitionIdentCode" : {
"type" : "string",
"description" : "Ident code of the corresponding data feed definition"
},
"sequenceNumber" : {
"type" : "integer",
"format" : "int32",
"description" : "Consecutive number of the data feed part"
},
"partNumberInPeriod" : {
"type" : "integer",
"format" : "int32",
"description" : "Part number of the data feed part for the period"
},
"numberOfPartsOfPeriod" : {
"type" : "integer",
"format" : "int32",
"description" : "Number of parts in the period"
},
"periodStartDate" : {
"type" : "string",
"description" : "Date/time stamp in the format yyyy-MM-dd for the start date of the period this data feed part contains data for
Length: 19
" }, "periodEndDate" : { "type" : "string", "description" : "Date/time stamp in the format yyyy-MM-dd for the end date of the period this data feed part contains data for
Length: 19
" }, "numberOfRecords" : { "type" : "integer", "format" : "int32", "description" : "Number of data records contained in the data feed part" }, "dataFeedPartId" : { "type" : "string", "description" : "The id of the published data feed part. To be used to retrieve the content via endpoint /DataFeedBFBean/dataFeedParts/{client}/{id}" }, "fileExtension" : { "type" : "string", "description" : "Extension of the data feed part as a file, e.g. CSV, JSON" } } }, "GetPublishedDataFeedPartsRequestDTO" : { "type" : "object", "description" : "Request parameter for IDataFeedBF#getPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).", "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" } } } }, "ExternalTMStatusResponseDTO" : { "type" : "object", "description" : "Response DTO for ExternalTelemetryBFBean/getStatus & ExternalTelemetryBFBean/status.", "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" } }, "externalSystemId" : { "type" : "string", "description" : "the id for the external system" }, "reportClientIdentCode" : { "type" : "string", "description" : "ident code for an XNSG client to file external telemetry reports for.Maximum length: 10
" }, "isTelemetryEnabled" : { "type" : "boolean", "description" : "true if telemetry of the engine is enabled" }, "isTelemetryEnabledForClient" : { "type" : "boolean", "description" : "true if telemetry is enabled" } } }, "ExternalTMIdentificationRequestDTO" : { "type" : "object", "description" : "Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.", "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" } }, "reportClientIdentCode" : { "type" : "string", "description" : "ident code for an XNSG client to file external telemetry reports for.Maximum length: 10
" }, "externalSystemId" : { "type" : "string", "description" : "unique id of the external system" } } }, "DateAndZoneDTO" : { "type" : "object", "description" : "Date and timezone.", "properties" : { "dateInTimezone" : { "type" : "string", "description" : "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
" } } }, "ExternalTMResponseDTO" : { "type" : "object", "description" : "Response DTO for all calls to ExternalTelemetryBFBean.", "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" } }, "externalSystemId" : { "type" : "string", "description" : "the id for the external system" }, "reportClientIdentCode" : { "type" : "string", "description" : "ident code for an XNSG client to file external telemetry reports for.Maximum length: 10
" }, "lastUpdate" : { "$ref" : "#/components/schemas/DateAndZoneDTO", "description" : "last date an external report has been filed" }, "lastUpdateComment" : { "type" : "string", "description" : "comment for the last filed report" }, "lastUpdateReported" : { "type" : "boolean", "description" : "true if last filed report has been sent to the telemetry server" }, "lastReportId" : { "type" : "string", "description" : "id of the last report (as stored in the engine)" } } }, "ExternalTMRDateEntryDTO" : { "type" : "object", "description" : "telemetry report entry for date values", "properties" : { "key" : { "type" : "string", "description" : "key for the value (must be unique within the report)" }, "category" : { "type" : "string", "description" : "category for the value (see TMDataCategory enum for valid values)" }, "value" : { "$ref" : "#/components/schemas/DateAndZoneDTO", "description" : "data for the entry to report" } } }, "ExternalTMRDoubleEntryDTO" : { "type" : "object", "description" : "telemetry report entry for string double", "properties" : { "key" : { "type" : "string", "description" : "key for the value (must be unique within the report)" }, "category" : { "type" : "string", "description" : "category for the value (see TMDataCategory enum for valid values)" }, "value" : { "type" : "number", "format" : "double", "description" : "data for the entry to report" } } }, "ExternalTMRIntegerEntryDTO" : { "type" : "object", "description" : "telemetry report entry for integer values", "properties" : { "key" : { "type" : "string", "description" : "key for the value (must be unique within the report)" }, "category" : { "type" : "string", "description" : "category for the value (see TMDataCategory enum for valid values)" }, "value" : { "type" : "integer", "format" : "int32", "description" : "data for the entry to report" } } }, "ExternalTMRLongEntryDTO" : { "type" : "object", "description" : "telemetry report entry for long values", "properties" : { "key" : { "type" : "string", "description" : "key for the value (must be unique within the report)" }, "category" : { "type" : "string", "description" : "category for the value (see TMDataCategory enum for valid values)" }, "value" : { "type" : "integer", "format" : "int64", "description" : "data for the entry to report" } } }, "ExternalTMRStringArrayEntryDTO" : { "type" : "object", "description" : "telemetry report entry for string array values", "properties" : { "key" : { "type" : "string", "description" : "key for the value (must be unique within the report)" }, "category" : { "type" : "string", "description" : "category for the value (see TMDataCategory enum for valid values)" }, "value" : { "type" : "array", "description" : "data for the entry to report", "items" : { "type" : "string" } } } }, "ExternalTMRStringEntryDTO" : { "type" : "object", "description" : "telemetry report entry for string values", "properties" : { "key" : { "type" : "string", "description" : "key for the value (must be unique within the report)" }, "category" : { "type" : "string", "description" : "category for the value (see TMDataCategory enum for valid values)" }, "value" : { "type" : "string", "description" : "data for the entry to report" } } }, "ExternalTMReportRequestDTO" : { "type" : "object", "description" : "Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.", "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" } }, "reportClientIdentCode" : { "type" : "string", "description" : "ident code for an XNSG client to file external telemetry reports for.Maximum length: 10
" }, "externalSystemId" : { "type" : "string", "description" : "unique id of the external system" }, "reportData" : { "$ref" : "#/components/schemas/ExternalTelemetryReportDTO", "description" : "the telemetry data to file" }, "updateComment" : { "type" : "string", "description" : "comment for the current filing" } } }, "ExternalTelemetryReportDTO" : { "type" : "object", "description" : "report dto to ship the telemetry data to an XNSG engine", "properties" : { "dateEntries" : { "type" : "array", "description" : "all dates that should be reported", "items" : { "$ref" : "#/components/schemas/ExternalTMRDateEntryDTO" } }, "doubleEntries" : { "type" : "array", "description" : "all double values that should be reported", "items" : { "$ref" : "#/components/schemas/ExternalTMRDoubleEntryDTO" } }, "integerEntries" : { "type" : "array", "description" : "all integer values that should be reported", "items" : { "$ref" : "#/components/schemas/ExternalTMRIntegerEntryDTO" } }, "longEntries" : { "type" : "array", "description" : "all long values that should be reported", "items" : { "$ref" : "#/components/schemas/ExternalTMRLongEntryDTO" } }, "stringArrayEntries" : { "type" : "array", "description" : "all string arrays that should be reported", "items" : { "$ref" : "#/components/schemas/ExternalTMRStringArrayEntryDTO" } }, "stringEntries" : { "type" : "array", "description" : "all strings that should be reported", "items" : { "$ref" : "#/components/schemas/ExternalTMRStringEntryDTO" } } } }, "AcknowledgeFileResponseDTO" : { "type" : "object", "description" : "Contains the result for an acknowledge file request.", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" } } }, "AcknowledgeFileRequestDTO" : { "type" : "object", "description" : "Contains information about the result of a file transfer", "properties" : { "channelID" : { "type" : "string", "description" : "Indicates the use-case for transferring a file." }, "clientIdentCode" : { "type" : "string", "description" : "An identCode of the client. Controls data visibility." }, "fileReference" : { "$ref" : "#/components/schemas/SimpleFileDTO", "description" : "The file which was transferred." } } }, "SimpleFileDTO" : { "type" : "object", "description" : "Meta-data for a transfer file", "properties" : { "name" : { "type" : "string", "description" : "Name of a file" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Size of a file" } } }, "AnnounceStopResultDTO" : { "description" : "the result of the announce stop API" }, "AnnounceStopParmDTO" : { "type" : "object", "description" : "parameter necessary to announce a stop of the server", "properties" : { "utcStopAtYYYYMMDDHHMMSS" : { "type" : "string", "description" : "the server will stop at this date/time" }, "expectedDowntimeMinutes" : { "type" : "integer", "format" : "int32", "description" : "the server will be down for the period in minutes" }, "preventedLogonMinutes" : { "type" : "integer", "format" : "int32", "description" : "The server will prevent new logons for this number of minutes before the date specified for the stop (see property utcStopAtYYYYMMDDHHMMSS)." } } }, "CancelAnnounceStopResultDTO" : { "description" : "Contains the result information of the cancel announce stop bf" }, "CancelAnnounceStopParmDTO" : { "description" : "parameter necessary to cancel an announced stop" }, "ChangeAdminPasswordResultDTO" : { "type" : "object", "description" : "Contains the result information of the change admin password bf", "properties" : { "success" : { "type" : "boolean", "description" : "false, if old password was wrong" } } }, "ChangeAdminPasswordParmDTO" : { "type" : "object", "description" : "This class contains the old and the new admin password", "properties" : { "oldPassword" : { "type" : "string", "description" : "the old admin password" }, "newPassword" : { "type" : "string", "description" : "the new admin password" } } }, "CreateClientResponseDTO" : { "type" : "object", "description" : "encapsulates the response parameters", "properties" : { "resultState" : { "type" : "string", "description" : "result status" } } }, "CreateClientRequestDTO" : { "type" : "object", "description" : "encapsulates the request parameters", "properties" : { "clientIdentCode" : { "type" : "string", "description" : "The identification code of the client" }, "name" : { "type" : "string", "description" : "The name of the client" }, "debtorNumber" : { "type" : "string", "description" : "The debtor number (Kundennummer) of a client" } } }, "ActivationDataFlavor" : { "type" : "object", "properties" : { "mimeType" : { "type" : "string" }, "humanPresentableName" : { "type" : "string" } } }, "CommandInfo" : { "type" : "object", "properties" : { "commandClass" : { "type" : "string" }, "commandName" : { "type" : "string" } } }, "CommandMap" : { "type" : "object", "properties" : { "mimeTypes" : { "type" : "array", "items" : { "type" : "string" } } } }, "DataHandler" : { "type" : "object", "properties" : { "dataSource" : { "$ref" : "#/components/schemas/DataSource" }, "name" : { "type" : "string" }, "inputStream" : { }, "content" : { }, "contentType" : { "type" : "string" }, "outputStream" : { }, "transferDataFlavors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActivationDataFlavor" } }, "preferredCommands" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CommandInfo" } }, "commandMap" : { "$ref" : "#/components/schemas/CommandMap", "writeOnly" : true }, "allCommands" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CommandInfo" } } } }, "DataSource" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "inputStream" : { }, "contentType" : { "type" : "string" }, "outputStream" : { } } }, "DownloadFileResponseDTO" : { "type" : "object", "description" : "Contains the result for a download file request", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" }, "downloadFile" : { "$ref" : "#/components/schemas/FileDTO", "description" : "The requested file, selected or generated depending on the use-case" } } }, "FileDTO" : { "type" : "object", "description" : "Data Transfer Object for a file.", "properties" : { "name" : { "type" : "string", "description" : "Name of a file" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Size of a file" }, "content" : { "$ref" : "#/components/schemas/DataHandler", "description" : "The content of a file" }, "checksum" : { "type" : "string", "format" : "byte", "description" : "MD5-hash of a file" }, "creationTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "file attribute creationTime as FileTime millis" }, "lastModifiedTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "file attribute lastModifiedTime as FileTime millis" }, "lastAccessTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "file attribute lastAccessTime as FileTime millis" } } }, "DownloadFileRequestDTO" : { "type" : "object", "description" : "Contains information on how to select a file for transferring", "properties" : { "channelID" : { "type" : "string", "description" : "Indicates the use-case for transferring a file." }, "clientIdentCode" : { "type" : "string", "description" : "An identCode of the client. Controls data visibility." }, "fileReference" : { "$ref" : "#/components/schemas/SimpleFileDTO", "description" : "reference to file for download" }, "parameters" : { "type" : "array", "description" : "A list of generic parameters", "items" : { "$ref" : "#/components/schemas/TransferFileParameterDTO" } } } }, "TransferFileParameterDTO" : { "type" : "object", "description" : "A generic parameter for use-case specific information", "properties" : { "key" : { "type" : "string", "description" : "Key of the parameter" }, "value" : { "type" : "string", "description" : "Value of the parameter" } } }, "GenerateClientIdentCodeRequestDTO" : { "type" : "object", "description" : "encapsulates the request parameters", "properties" : { "clientIdentCode" : { "type" : "string", "description" : "client ident code should be generated" }, "debtorNumber" : { "type" : "string", "description" : "debtor number" } } }, "ClientDTO" : { "type" : "object", "description" : "DTO representing an XNSG Client.", "properties" : { "identCode" : { "type" : "string", "description" : "the client ident code" }, "name" : { "type" : "string", "description" : "the name of the client" }, "isDemo" : { "type" : "boolean", "description" : "true if demo client" }, "isActive" : { "type" : "boolean", "description" : "true if active client" }, "duplicationAllowed" : { "type" : "boolean", "description" : "true if the client can be duplicated with BF call" }, "debtorNumber" : { "type" : "string", "description" : "the debtor number of the client" } } }, "MonitoringDataProviderDTO" : { "type" : "object", "description" : "Data Transfer Object for monitoring provider", "properties" : { "groupName" : { "type" : "string", "description" : "Name of the group." }, "name" : { "type" : "string", "description" : "Name of the entry." }, "value" : { "type" : "string", "description" : "Value of the entry - this is a string representation." } } }, "DLFilesRefsResponseDTO" : { "type" : "object", "description" : "Contains the result for a request to get the number of files available for download", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" }, "downloadableFilesReferences" : { "type" : "array", "description" : "The references of files available for download", "items" : { "$ref" : "#/components/schemas/SimpleFileDTO" } } } }, "DLFilesRefsRequestDTO" : { "type" : "object", "description" : "Contains information on how to select files for transferring", "properties" : { "channelID" : { "type" : "string", "description" : "Indicates the use-case for transferring a file." }, "clientIdentCode" : { "type" : "string", "description" : "An identCode of the client. Controls data visibility." }, "parameters" : { "type" : "array", "description" : "A list of generic parameters", "items" : { "$ref" : "#/components/schemas/TransferFileParameterDTO" } } } }, "ProductInfoDTO" : { "type" : "object", "description" : "This class holds various information items of the server which serves this request.", "properties" : { "productName" : { "type" : "string", "description" : "This is the name of the product that is deployed to this server." }, "productVersion" : { "$ref" : "#/components/schemas/VersionInfoDTO", "description" : "This data contains the version of the product." }, "solutions" : { "type" : "array", "description" : "This contains a list of names of all solutions, which are deployed to the server.", "items" : { "type" : "string" } }, "productNameInternal" : { "type" : "string", "description" : "This is the name of the product that is deployed to this server in its original manner." } } }, "VersionInfoDTO" : { "type" : "object", "description" : "This class holds version information about a solution or product in a server.", "properties" : { "version" : { "type" : "string", "description" : "The version string of the solution/product. This String is typically of the form \"integer.integer.integer\"." }, "binaryVersion" : { "type" : "array", "description" : "The version of the solution/product as numeric value. The main version is the first entry in the integer array.", "items" : { "type" : "integer", "format" : "int32" } } } }, "RuntimeInfoDTO" : { "type" : "object", "description" : "This class holds various runtime information items of the server which serves this request.", "properties" : { "hostName" : { "type" : "string", "description" : "This is the name of the host, where the server is running which has answered the request" }, "serviceName" : { "type" : "string", "description" : "This is the service name, if the server is running as service or if not contains an empty String \"\"." }, "productUri" : { "type" : "string", "description" : "This is the URI used by the server at runtime." }, "serverUrl" : { "type" : "string", "description" : "This is server URL used by the server at runtime." }, "httpPort" : { "type" : "string", "description" : "This is the HTTP port used by the server at runtime." }, "ajpPort" : { "type" : "string", "description" : "This is the AJP port used by the server at runtime." }, "productHomeAbsolutePath" : { "type" : "string", "description" : "Absolute path in server view, where the server is installed." }, "productVersion" : { "type" : "string", "description" : "Product version as \"1.2-20070215\"." }, "installationDate" : { "type" : "string", "format" : "date-time", "description" : "Date of last installation/update" }, "isDBReadyToUse" : { "type" : "boolean", "description" : "True, if the DB is ready to use (connected, valid and not locked)." }, "isPreparedForStop" : { "type" : "boolean", "description" : "True, if an announcement for a job is active." }, "activeSessionsCount" : { "type" : "integer", "format" : "int32", "description" : "Total count of active sessions (summarized over all GUI-frameworks)." }, "additionalInfo" : { "type" : "string", "description" : "Additional runtime info." }, "productName" : { "type" : "string", "description" : "Product name." }, "authenticationStrategy" : { "type" : "string", "description" : "AuthenticationStrategy name." }, "runtimeProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "Runtime-Properties. These are valid cluster-wide and stored in the DB, replacing/supplementing properties in product_configuration.properties." } } }, "ScriptExecutionRowDTO" : { "type" : "object", "description" : "This dto contains the data of a single line in script result", "properties" : { "columns" : { "type" : "array", "description" : "columns of a row", "items" : { "type" : "string" } }, "dummy" : { "type" : "string", "description" : "dummy" } } }, "ScriptExecutionStateResultDTO" : { "type" : "object", "description" : "Contains the result information of the script execution bf", "properties" : { "content" : { "type" : "array", "description" : "this table represents the result of the script execution", "items" : { "$ref" : "#/components/schemas/ScriptExecutionRowDTO" } }, "isBusy" : { "type" : "boolean", "description" : "Returns true, if the script execution is running" }, "isFailed" : { "type" : "boolean", "description" : "Returns true, if the script execution failed" }, "info" : { "type" : "string", "description" : "information about the script execution" } } }, "ScriptExecutionStateParmDTO" : { "type" : "object", "description" : "parameters necessary to ask the server for the current state of the script execution", "properties" : { "uuid" : { "type" : "string", "description" : "uuid assigned to the BF call" } } }, "TableUpdateStateResultDTO" : { "type" : "object", "description" : "Contains the result information of the get table update state bf", "properties" : { "percentage" : { "type" : "integer", "format" : "int32", "description" : "How far has the table update went" }, "state" : { "type" : "string", "description" : "Whats the state of the table update? Is it still running, or was it successful?" }, "info" : { "type" : "string", "description" : "The current task of the table update" }, "isBusy" : { "type" : "boolean", "description" : "Returns true, if the schema synchronisation is running" }, "isFailed" : { "type" : "boolean", "description" : "Returns true, if the schema synchronisation failed" } } }, "TableUpdateStateParmDTO" : { "description" : "the parameter necessary to ask the server for the current state of the table update" }, "UploadSettingsResponseDTO" : { "type" : "object", "description" : "retrieves the server settings for uploading files via SFT interface", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" }, "maxFileSize" : { "type" : "integer", "format" : "int64", "description" : "maximum size of uploadable files" } } }, "UploadSettingsRequestDTO" : { "type" : "object", "description" : "retrieves the server settings for uploading files via SFT interface", "properties" : { "channelID" : { "type" : "string", "description" : "Indicates the use-case for transferring a file." }, "clientIdentCode" : { "type" : "string", "description" : "An identCode of the client. Controls data visibility." } } }, "MessageDataDTO" : { "type" : "object", "description" : "resulting user tip for one locale", "properties" : { "locale" : { "type" : "string", "description" : "locale of user tip whose results are given here" }, "uuid" : { "type" : "string", "description" : "the uuid of the tip (only filled when no error) - should be stored if later tip should be updated" }, "error" : { "type" : "string", "description" : "error message, if any error occurred during processing" } } }, "PublishMessageResponseDTO" : { "type" : "object", "description" : "Contains ids of user tips that were created, or error messages", "properties" : { "messageResultPerLocale" : { "type" : "array", "description" : "the data per locale, as supplied in request", "items" : { "$ref" : "#/components/schemas/MessageDataDTO" } } } }, "LinkDTO" : { "type" : "object", "properties" : { "url" : { "type" : "string", "description" : "url of the link" }, "name" : { "type" : "string", "description" : "text to be shown for the link" }, "position" : { "type" : "integer", "format" : "int32", "description" : "position of the link" } } }, "MessageTextsDTO" : { "type" : "object", "properties" : { "locale" : { "type" : "string", "description" : "locale for the texts - must be a language supported by the system" }, "uuid" : { "type" : "string", "description" : "uuid of user tip - should only be filled when updating existing tip" }, "title" : { "type" : "string", "description" : "title of the user tip" }, "text" : { "type" : "string", "description" : "text of the user tip" }, "titlePopup" : { "type" : "string", "description" : "title of the popup, when shown as popup" }, "textPopup" : { "type" : "string", "description" : "text of the popup, when shown as popup" }, "links" : { "type" : "array", "description" : "links associated with the tip", "items" : { "$ref" : "#/components/schemas/LinkDTO" } } } }, "PublishMessageRequestDTO" : { "type" : "object", "description" : "the for user tip, possibly in several locales", "properties" : { "contentPerLocale" : { "type" : "array", "description" : "locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.", "items" : { "$ref" : "#/components/schemas/MessageTextsDTO" } }, "clientIdentCode" : { "type" : "string", "description" : "ident code of client - when call is not done with administrative rights, this must match the client of authentication" }, "showAsPopup" : { "type" : "boolean", "description" : "true when tip is to be shown as popup" }, "clientGroup" : { "type" : "string", "description" : "client group for which this tip is valid - can only be used when call is authenticated with administrative rights" }, "validFrom" : { "type" : "string", "description" : "timestamp from which on the tip is valid, format yyyy-MM-dd or yyyy-MM-ddThh-mm-ss - when null, no restriction is assumed" }, "validTo" : { "type" : "string", "description" : "timestamp until which tip is valid, format yyyy-MM-dd or yyyy-MM-ddThh-mm-ss - when null tip is valid indefinitely" }, "isReleased" : { "type" : "boolean", "description" : "when true tip is shown - empty means true" }, "roleAccessType" : { "type" : "string", "description" : "one of the subclasses of CRoleAccessType, namely REVOK, NECCE, GRANT" }, "role" : { "type" : "string", "description" : "role of a user that determines if tip is shown - see roleAccessType which decides if tip is shown to users having this role, not shown to users not having this role" }, "isImportantMessage" : { "type" : "boolean", "description" : "when true tip is shown as important message" }, "clientLicenceRoles" : { "type" : "string", "description" : "when filled, tip is only shown for clients that have licenced the roles specified here" }, "visibilityProperties" : { "type" : "string", "description" : "other properties that define if tip is shown" }, "isMailToAdmin" : { "type" : "boolean", "description" : "when true an email is sent to admin to inform about new tip" }, "isRealUserTip" : { "type" : "boolean", "description" : "when true tip is considered as real user tip" } } }, "RoleInfoDTO" : { "type" : "object", "description" : "dto for roles", "properties" : { "identCode" : { "type" : "string", "description" : "the role ident code" }, "assignableByClientAdmin" : { "type" : "boolean", "description" : "true if assignable by client" }, "name" : { "type" : "string", "description" : "the role name" }, "description" : { "type" : "string", "description" : "the role description" }, "licenseRole" : { "type" : "boolean", "description" : "true if license role" }, "apiPredefined" : { "type" : "boolean", "description" : "true if predefined" }, "systemRole" : { "type" : "boolean", "description" : "true if system role" }, "clientIdentCode" : { "type" : "string", "description" : "client ident code or null if general role" }, "impliedRoles" : { "type" : "array", "description" : "the implied roles", "items" : { "type" : "string" } } } }, "SendMailResultDTO" : { "type" : "object", "description" : "Contains the result of the sendMail method.", "properties" : { "success" : { "type" : "boolean", "description" : "true on success" }, "errorMessage" : { "type" : "string", "description" : "error-message, if an error occured" } } }, "SendMailAttachmentParmDTO" : { "type" : "object", "description" : "Contains an attachment for an email.", "properties" : { "fileContent" : { "type" : "string", "format" : "byte", "description" : "Content of the attachment file" }, "fileContentType" : { "type" : "string", "description" : "Content-type of the attachment (e.g. \"application/octet-stream\")" }, "fileName" : { "type" : "string", "description" : "Name of the attachment file" } } }, "SendMailParmDTO" : { "type" : "object", "description" : "Parameter necessary for sending a mail", "properties" : { "receivers" : { "type" : "array", "description" : "receivers of the mail", "items" : { "type" : "string" } }, "replytos" : { "type" : "array", "description" : "reply to addresses of the mail", "items" : { "type" : "string" } }, "ccs" : { "type" : "array", "description" : "ccs of the mail", "items" : { "type" : "string" } }, "bccs" : { "type" : "array", "description" : "bccs of the mail", "items" : { "type" : "string" } }, "subject" : { "type" : "string", "description" : "subject of the mail" }, "content" : { "type" : "string", "description" : "content of the mail" }, "contentType" : { "type" : "string", "description" : "content-type of the mail" }, "mimeCharSet" : { "type" : "string", "description" : "MIME-characterset of the mail" }, "attachments" : { "type" : "array", "description" : "Attachments of the mail", "items" : { "$ref" : "#/components/schemas/SendMailAttachmentParmDTO" } } } }, "StartScriptExecutionResultDTO" : { "type" : "object", "description" : "result of start script execution", "properties" : { "uuid" : { "type" : "string", "description" : "uuid assigned to the BF call" }, "isFailed" : { "type" : "boolean", "description" : "Returns true, if start script execution failed, e.g. generation of uuid failed" }, "info" : { "type" : "string", "description" : "information about the start" } } }, "StartScriptExecutionParmDTO" : { "type" : "object", "description" : "parameters for start script execution", "properties" : { "scriptContent" : { "type" : "string", "description" : "string value represents the content of script" }, "maxRows" : { "type" : "integer", "format" : "int32", "description" : "max. number of rows included in result of script execution" }, "scriptType" : { "type" : "string", "description" : "type of script, sql, oql and java script are supported" }, "dataPoolName" : { "type" : "string", "description" : "name of the data pool with which the sql / oql script will be executed" } } }, "StartTableUpdateResultDTO" : { "description" : "Contains the result information of the start table update bf" }, "StartTableUpdateParmDTO" : { "description" : "parameter necessary for the table update" }, "SystemSearchResultDTO" : { "type" : "object", "description" : "DTO contained in the result array of systemSearch function", "properties" : { "category" : { "type" : "string", "description" : "search category where this result belongs to" }, "type" : { "type" : "string", "description" : "type of result, e.g. class name of model object - defined within the category" }, "state" : { "type" : "string", "description" : "state of the item described by this result - possible values are defined within the category" }, "key" : { "type" : "string", "description" : "key of the object described by this item. - format defined within the category for each type" }, "text" : { "type" : "string", "description" : "explanation of this search result" }, "relevance" : { "type" : "integer", "format" : "int32", "description" : "relevance of the result; an indication (in percent, ranging from 0 .. 100) of how much the result matches the query" }, "depth" : { "type" : "integer", "format" : "int32", "description" : "an integer >= 0 describing the hierarchical level of the result; it can be used to format the textual output" } } }, "SystemSearchParameterDTO" : { "type" : "object", "description" : "DTO used as argument to systemSearch function", "properties" : { "category" : { "type" : "string", "description" : "category to which this parameter belongs to" }, "parameterName" : { "type" : "string", "description" : "name of the query parameter - valid names are defined by the category" }, "parameterValue" : { "type" : "string", "description" : "value of the parameter" } } }, "UploadFileResponseDTO" : { "type" : "object", "description" : "Contains the result for a upload file request.", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" } } }, "UploadFileMultiPartRequestDTO" : { "type" : "object", "description" : "Contains information on how a transmitted file should be processed", "properties" : { "channelID" : { "type" : "string", "description" : "Indicates the use-case for transferring a file." }, "clientIdentCode" : { "type" : "string", "description" : "An identCode of the client. Controls data visibility." }, "name" : { "type" : "string", "description" : "Name of a file" }, "size" : { "type" : "integer", "format" : "int64", "description" : "Size of a file" }, "parameters" : { "type" : "array", "description" : "A list of generic parameters", "items" : { "$ref" : "#/components/schemas/TransferFileParameterDTO" } }, "checksum" : { "type" : "string", "description" : "MD5-hash of a file" }, "creationTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "file attribute creationTime as FileTime millis" }, "lastModifiedTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "file attribute lastModifiedTime as FileTime millis" }, "lastAccessTimeMillis" : { "type" : "integer", "format" : "int64", "description" : "file attribute lastAccessTime as FileTime millis" } } }, "RoleDTO" : { "type" : "object", "description" : "data about a role", "properties" : { "identCode" : { "type" : "string", "description" : "the role ident code - this value is unique in the system" }, "localizedTexts" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/RoleTextDTO" }, "description" : "localized data of the role - key is language, value is RoleTextDTO with 'name' and 'description'" }, "impliedRoles" : { "type" : "array", "description" : "the implied roles - a user having this role also has all the roles that appear in this list", "items" : { "type" : "string" } }, "apiPredefined" : { "type" : "boolean", "description" : "true if role is predefined by code, and not manually created by an administrator" }, "systemRole" : { "type" : "boolean", "description" : "true if this is a role which is referenced in code and implies various effects" }, "clientDefined" : { "type" : "boolean", "description" : "true if this role is defined specifically for the current client" } } }, "RoleTextDTO" : { "type" : "object", "description" : "language dependent values of a role", "properties" : { "name" : { "type" : "string", "description" : "the name of the role, a short word describing the role" }, "description" : { "type" : "string", "description" : "a longer description that explains what this role is for" } } }, "RolesOfClientDTO" : { "type" : "object", "description" : "Response DTO for listing roles assignable to users of a client.", "properties" : { "clientIdentCode" : { "type" : "string", "description" : "the ident code of the client for which the roles are returned" }, "roles" : { "type" : "array", "description" : "list of roles which are defined for the specified client", "items" : { "$ref" : "#/components/schemas/RoleDTO" } } } }, "ClientRolesDTO" : { "type" : "object", "description" : "Response DTO for listing client specific roles in GetRolesResponseDTO.", "properties" : { "client" : { "type" : "string", "description" : "Client identCode" }, "roleInfos" : { "type" : "array", "description" : "The role informations.", "items" : { "$ref" : "#/components/schemas/RoleInfoDTO" } } } }, "GetRolesResponseDTO" : { "type" : "object", "description" : "DTO for GetRoles response", "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" } }, "rolesInfos" : { "type" : "array", "description" : "List of role information DTO's that are client independant.", "items" : { "$ref" : "#/components/schemas/RoleInfoDTO" } }, "clientRoles" : { "type" : "array", "description" : "List of role information DTO's that are client dependant.", "items" : { "$ref" : "#/components/schemas/ClientRolesDTO" } } }, "xml" : { "name" : "getRolesResponseDTO" } }, "AcknowledgeEventsResponseDTO" : { "type" : "object", "description" : "Response DTO for acknowledging events.", "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" } } } }, "AcknowledgeEventsRequestDTO" : { "type" : "object", "description" : "Request DTO for acknowledging events.", "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" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for acknowledge.Pass this field with the value returned in syncId with the last call to SyncBFBean/getNotAcknowledgedEvents.
length=20
" }, "businessObjectType" : { "type" : "string", "description" : "Should be the same value, which was passed with businessObjectType with the last call to SyncBFBean/getNotAcknowledgedEvents. length=20" } } }, "SyncEventDTO" : { "type" : "object", "description" : "DTO to hold data of one synchronized event.", "properties" : { "businessObjectType" : { "type" : "string", "description" : "Code which identifies the business object type the event belongs to.", "maxLength" : 20 }, "businessObjectQualifier" : { "type" : "string", "description" : "Optional qualifier which can be used to specify the object in a more detailed way.", "maxLength" : 35 }, "businessObjectId" : { "type" : "string", "description" : "Unique ID of the business object.This ID is usually needed for subsequent calls, e.g. getBusinessObject(...)
", "maxLength" : 36 }, "eventType" : { "type" : "string", "description" : "Type of the event (e.g. CREATE, UPDATE or DELETE).Depending on the business object type and its configuration, additional event types are possible.
", "maxLength" : 20 }, "eventDate" : { "$ref" : "#/components/schemas/DateAndZoneDTO", "description" : "Date when the event happened." }, "syncId" : { "type" : "number", "description" : "Monotonously increasing event identifier.", "maxLength" : 20 }, "parameter" : { "$ref" : "#/components/schemas/GenericDataRecordDTO", "description" : "Additional values/parameters of the event.The definition of the included fields depends on the business object and event type and can be requested from the AEB.
" } } }, "SyncEventsResponseDTO" : { "type" : "object", "description" : "Response DTO for synchronizing events.", "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" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for delta-transmission.Use this syncId in subsequent calls to SyncBFBean/synchronizeEvents to enable delta-transmission of changes.
However, this syncId may be null if no events are found and the field events is an empty array. In this case use the last NOT NULL syncId returned in this field for subsequent calls to SyncBFBean/synchronizeEvents.
length=20
" }, "isComplete" : { "type" : "boolean", "description" : "True, if the synchronization is complete and currently no further events are available. False if not.Because a maximum of 100 events are returned with one call of SyncBFBean/synchronizeEvents, the result may be incomplete.
" }, "totalCount" : { "type" : "integer", "description" : "The total number of events that are available, regardless of the fetched block size. Filled only if returnTotalCount was set in request." }, "events" : { "type" : "array", "description" : "The resulting events, matching the requested parameters.A maximum number of 100 events are transmitted per call.
To get ALL events make repeated calls of SyncBFBean/synchronizeEvents, always passing the last returned syncId in the next call with syncId.
", "items" : { "$ref" : "#/components/schemas/SyncEventDTO" } } } }, "SyncEventsRequestDTO" : { "type" : "object", "description" : "Request DTO for synchronizing events.", "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" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for delta-transmission. In calls to SyncBFBean/synchronizeEvents:
Pass this field with the value returned in syncId with the last call to SyncBFBean/synchronizeEvents.
For initializing of delta-transmissions pass simply null.
In calls to SyncBFBean/getNotAcknowledgedEvents this field is not used.
length=20
" }, "businessObjectType" : { "type" : "string", "description" : "Optional parameter to resctrict the events to be polled to that business object type. May be null to get all subscribed events of all business object types.Start the initializing of delta transmission with with this age. Older events will not be synchronized.
" }, "blockSize" : { "type" : "integer", "format" : "int32", "description" : "For defining the block size. Can be null. If empty the default block size of 100 is used." }, "returnTotalCount" : { "type" : "boolean", "description" : "If set, the total number of available events is returned in the response.Note that requiring the total number of events may lead to substantial performance penalties in the service.
" } } }, "GetPartnerSystemSubscriptionsResponseDTO" : { "type" : "object", "description" : "Response parameter with fetched partner system subscriptions to sync events.", "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" } }, "syncPartnerSystems" : { "type" : "array", "description" : "All or filtered registered partner system subscriptions.", "items" : { "$ref" : "#/components/schemas/SyncPartnerSystemDTO" } } } }, "SyncPartnerSystemDTO" : { "type" : "object", "description" : "Identification and other data of a single partner system subscription.", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system (e.g. Installation ID of the sending host or ERP system).", "maxLength" : 20 }, "businessObjectType" : { "type" : "string", "description" : "Code which identifies the subscribed business object type.", "maxLength" : 20 }, "description" : { "type" : "string", "description" : "Description of the subscription (optional).", "maxLength" : 250 } }, "required" : [ "businessObjectType", "clientSystemId" ] }, "GetPartnerSystemSubscriptionsRequestDTO" : { "type" : "object", "description" : "Request parameter to fetch all or filtered partner system subscriptions to sync events.", "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" } }, "businessObjectType" : { "type" : "string", "description" : "Optional. Filter for code which identifies the subscribed business object type.", "maxLength" : 20 } } }, "SubscribePartnerSystemResponseDTO" : { "type" : "object", "description" : "Response parameter of a partner system subscription to sync events.", "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" } }, "syncPartnerSystem" : { "$ref" : "#/components/schemas/SyncPartnerSystemDTO", "description" : "Registered partner system subscription." } } }, "SubscribePartnerSystemRequestDTO" : { "type" : "object", "description" : "Request parameter to subscribe a partner system to sync events.", "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" } }, "businessObjectType" : { "type" : "string", "description" : "Code which identifies the subscribed business object type.", "maxLength" : 20 }, "description" : { "type" : "string", "description" : "Optional description of the subscription.", "maxLength" : 250 } }, "required" : [ "businessObjectType" ] }, "UnsubscribePartnerSystemResponseDTO" : { "type" : "object", "description" : "Response parameter of a partner system unsubscription from sync events.", "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" } }, "syncPartnerSystem" : { "$ref" : "#/components/schemas/SyncPartnerSystemDTO", "description" : "Previously registered partner system subscription (if any)." } } }, "UnsubscribePartnerSystemRequestDTO" : { "type" : "object", "description" : "Request parameter to unsubscribe a partner system from sync events.", "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" } }, "businessObjectType" : { "type" : "string", "description" : "Code which identifies the subscribed business object type.", "maxLength" : 20 } }, "required" : [ "businessObjectType" ] }, "Company" : { "type" : "object", "description" : "A complete address of a company.", "properties" : { "companyNumber" : { "type" : "string", "description" : "Company number. The company number is in some AEB services not unique.", "example" : 12345, "maxLength" : 20, "minLength" : 1, "readOnly" : true }, "name" : { "type" : "string", "description" : "Name of the company (first address line).", "example" : "AEB SE", "maxLength" : 40, "minLength" : 1 }, "name2" : { "type" : "string", "description" : "Address name line 2.", "maxLength" : 40, "minLength" : 0 }, "name3" : { "type" : "string", "description" : "Address name line 3.", "maxLength" : 40, "minLength" : 0 }, "name4" : { "type" : "string", "description" : "Address name line 4.", "maxLength" : 40, "minLength" : 0 }, "street" : { "type" : "string", "description" : "Street (line 1) of the address.", "example" : "Sigmaringer Str. 109", "maxLength" : 40, "minLength" : 0 }, "street2" : { "type" : "string", "description" : "Street (line 2) of the address.", "maxLength" : 40, "minLength" : 0 }, "postcode" : { "type" : "string", "description" : "Postcode of the street address.", "example" : 70567, "maxLength" : 10, "minLength" : 0 }, "city" : { "type" : "string", "description" : "City of the address.", "example" : "Stuttgart", "maxLength" : 40, "minLength" : 0 }, "district" : { "type" : "string", "description" : "District (city line 2) of the address.", "maxLength" : 40, "minLength" : 0 }, "countryIsoCode" : { "type" : "string", "description" : "Country of address. Unique alpha-2 ISO code of country according to ISO 3166.", "example" : "DE", "maxLength" : 2, "minLength" : 2, "pattern" : "[A-Z]{2}" }, "county" : { "type" : "string", "description" : "County of the address.", "example" : "BW", "maxLength" : 40, "minLength" : 0 }, "poBox" : { "type" : "string", "description" : "PO-Box.", "maxLength" : 10, "minLength" : 0 }, "postcodePoBox" : { "type" : "string", "description" : "Postcode of the poBox address.", "maxLength" : 10, "minLength" : 0 }, "cityPoBox" : { "type" : "string", "description" : "City of the po-box address.", "maxLength" : 40, "minLength" : 0 }, "emailAddress" : { "type" : "string", "format" : "email", "description" : "Email address of the address.", "example" : "support@aeb.com", "maxLength" : 256, "minLength" : 0 }, "phoneNumber" : { "type" : "string", "description" : "Phone number of reception.", "example" : "+49 711 72842 0", "maxLength" : 20, "minLength" : 0 }, "faxNumber" : { "type" : "string", "description" : "Fax number of reception.", "maxLength" : 20, "minLength" : 0 }, "vatNumber" : { "type" : "string", "description" : "International VAT identification number. Example of format: DE123456789", "example" : "DE123456789", "maxLength" : 20, "minLength" : 0 }, "isEnabled" : { "type" : "boolean", "description" : "If false, the company is logically deleted. Disabled companies will not be linked to new transactional data. It is possible to enable a disabled company by overwriting the value with 'true' or leave it empty.", "example" : true }, "disabledAt" : { "type" : "string", "format" : "date-time", "description" : "Date at wich the company was set as disabled. Empty if the company is not disabled. This date is always UTC time zone and has the RFC-3339 date format.", "example" : "2000-01-01T00:00:00.000", "readOnly" : true }, "homepage" : { "type" : "string", "description" : "Homepage of the company.", "example" : "www.aeb.com", "maxLength" : 250, "minLength" : 0 }, "remark" : { "type" : "string", "description" : "Remarks about the company.", "example" : ":)", "maxLength" : 4000, "minLength" : 0 }, "roles" : { "type" : "array", "description" : "Roles of the company. The possible roles depends on the AEB service. Use API method GET /company-roles to retrieve all possible company roles.", "items" : { "$ref" : "#/components/schemas/CompanyRole" } } }, "required" : [ "companyNumber", "countryIsoCode", "name" ] }, "CompanyRole" : { "type" : "object", "description" : "A role of a company. Company roles are domain specific characteristics and can differ between the different AEB services.", "properties" : { "identCode" : { "type" : "string", "description" : "The identCode of the role.", "example" : "DLSHIPPT", "maxLength" : 20, "minLength" : 1 }, "description" : { "type" : "string", "description" : "The name of the role in request language.", "example" : "Shipping point", "maxLength" : 80, "minLength" : 0, "readOnly" : true } }, "required" : [ "identCode" ] }, "CompanyPage" : { "type" : "object", "properties" : { "totalElements" : { "type" : "integer", "description" : "The total number of elements available to return.", "example" : 100, "readOnly" : true }, "content" : { "type" : "array", "description" : "List of companies.", "items" : { "$ref" : "#/components/schemas/Company" } } }, "required" : [ "content", "totalElements" ] }, "CompanyRoleList" : { "type" : "object", "properties" : { "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CompanyRole" } } }, "required" : [ "roles" ] }, "DesktopAgentInfo" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "registeredTime" : { "type" : "string", "format" : "date-time" }, "cloudServiceAgent" : { "type" : "boolean" }, "cloudAgent" : { "type" : "boolean" }, "diagnosticAgent" : { "type" : "boolean" }, "mainWorkstationAgent" : { "type" : "boolean" }, "childWorkstationAgent" : { "type" : "boolean" }, "clientId" : { "type" : "string" }, "locationLabel" : { "type" : "string" }, "workstationSessionId" : { "type" : "string" }, "processInfo" : { "$ref" : "#/components/schemas/ProcessInfo" }, "launcherInfo" : { "$ref" : "#/components/schemas/LauncherInfo" }, "sessionInfo" : { "$ref" : "#/components/schemas/SessionInfo" }, "tracingInfo" : { "$ref" : "#/components/schemas/TracingInfo" }, "perfMonitoringInfo" : { "$ref" : "#/components/schemas/PerfMonitoringInfo" }, "lastNetworkActivityTime" : { "type" : "string", "format" : "date-time" } } }, "LauncherInfo" : { "type" : "object", "properties" : { "version" : { "type" : "string" }, "zoneName" : { "type" : "string" } } }, "PerfMonitoringInfo" : { "type" : "object", "properties" : { "createdToRegisteredDurationMs" : { "type" : "integer", "format" : "int64" }, "createdToFirstNetworkActivityDurationMs" : { "type" : "integer", "format" : "int64" }, "createdToLaunchRequestedDurationMs" : { "type" : "integer", "format" : "int64" } } }, "ProcessInfo" : { "type" : "object", "properties" : { "host" : { "type" : "string" }, "os" : { "type" : "string" }, "pid" : { "type" : "string" }, "name" : { "type" : "string" }, "user" : { "type" : "string" }, "initError" : { "type" : "string" } } }, "SessionInfo" : { "type" : "object", "properties" : { "userName" : { "type" : "string" } } }, "TracingInfo" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "debugEnabled" : { "type" : "boolean" }, "count" : { "type" : "integer", "format" : "int32" }, "size" : { "type" : "integer", "format" : "int64" }, "oldestTime" : { "type" : "string", "format" : "date-time" }, "newestTime" : { "type" : "string", "format" : "date-time" } } }, "WorkstationSessionInfoDTO" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "UNKNOWN", "LAUNCH_REQUEST", "LAUNCHING", "CONNECTED" ] }, "info" : { "$ref" : "#/components/schemas/DesktopAgentInfo" } } }, "WorkstationAgentConnectionTimeouts" : { "type" : "object", "properties" : { "registerTimeoutMS" : { "type" : "integer", "format" : "int32" }, "processingTimeoutMS" : { "type" : "integer", "format" : "int32" }, "nextPollingRequestTimeoutMS" : { "type" : "integer", "format" : "int32" }, "userActivityTimeoutMS" : { "type" : "integer", "format" : "int64" } } } }, "securitySchemes" : { "SWAGGER_AUTH_KEY" : { "type" : "apiKey", "name" : "X-XNSG_WEB_TOKEN", "in" : "header" }, "BASIC_AUTH" : { "type" : "http", "scheme" : "basic" } } }, "x-proxy-enabled" : false }