{
"openapi" : "3.0.1",
"info" : {
"title" : "Carrier Connect HTTP API",
"description" : "Thank you for using our HTTP API documentation. Please do not use Microsoft Edge Legacy on this page. Microsoft Edge will not return responses properly when you try them out.",
"version" : "3.0"
},
"servers" : [ {
"url" : "https://rz3.aeb.de/demo1cai/rest"
} ],
"security" : [ {
"SWAGGER_AUTH_KEY" : [ ]
}, {
"BASIC_AUTH" : [ ]
} ],
"tags" : [ {
"name" : "DLCarrierBFBean",
"description" : "Business facade for the CarrierEngine"
}, {
"name" : "FoundationAFBean",
"description" : "Business facade for the XNSGFoundation AF"
}, {
"name" : "ExternalTelemetryBFBean",
"description" : "Business facade for sending telemetry data from a third party system."
}, {
"name" : "FoundationBFBean",
"description" : "REST endpoint for FoundationBF"
}, {
"name" : "InternalProvisioningBFBean",
"description" : "REST endpoint for InternalProvisioningBF"
}, {
"name" : "RemoteAdminBFBean",
"description" : " Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR)."
}, {
"name" : "SyncBFBean",
"description" : "Business facade for synchronizing data asynchronous from an engine to a client system."
} ],
"paths" : {
"/cloudagent/connect" : {
"get" : {
"description" : "Returns a connection string for the Cloud Service Agent.",
"operationId" : "connect",
"responses" : {
"200" : {
"description" : "The connection string.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
},
"401" : {
"description" : "Authentication is missing."
}
}
},
"delete" : {
"description" : "Disconnects the Cloud Service Agent with the given id.",
"operationId" : "disconnect",
"parameters" : [ {
"name" : "id",
"in" : "query",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Cloud Service Agent has been disconnected, but does not indicate if Cloud Service Agent with given id existed or not."
},
"401" : {
"description" : "Authentication is missing."
}
}
}
},
"/DLCarrierBFBean/createShipment" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "createShipment",
"description" : "Creates a shipment with the data specified in the shipment request.
An error will be returned when the shipment exists already.
Optionally various operations like label preparation and label output can be applied on the shipment. A complete processing including the pickup assignment is also possible.
The operations are handled asynchronously, so operation processing errors and label documents are not part of the response. They can be retrieved with a 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" : [ "DLCarrierBFBean" ],
"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/deletePickup" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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.
Warning: EDI data for the existing pickup might have already been sent to the carrier. So check with the carrier that it's fine to cancel the pickup and create a new (differing) one.",
"operationId" : "deletePickup",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePickupRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePickupRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePickupResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLDeletePickupResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/getShipments" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "getShipments",
"description" : "Returns detail information about specific shipments.",
"operationId" : "getShipments",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetShipmentsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetShipmentsRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetShipmentsResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetShipmentsResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/processShipment" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a 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/cancelShipment" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "cancelShipment",
"description" : "Cancels a shipment.",
"operationId" : "cancelShipment",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLCancelShipmentRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLCancelShipmentRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLCancelShipmentResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLCancelShipmentResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/deletePackage" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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/processPickup" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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/getPickups" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "getPickups",
"description" : "Returns detail information about specific pickups.",
"operationId" : "getPickups",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetPickupsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetPickupsRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetPickupsResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetPickupsResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/syncPickups" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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/processPackage" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "processPackage",
"description" : "Allows to perform various operations on an existing package. Especially document preparation and document (label) output can be triggered.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a further 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/validateShipment" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "validateShipment",
"description" : "Validates a shipment with the data specified in the shipment request.
Various validation operations can be applied on the shipment to determine, whether the shipment can be processed.",
"operationId" : "validateShipment",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLValidateShipmentRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLValidateShipmentRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLValidateShipmentResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLValidateShipmentResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/createPickup" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "createPickup",
"description" : "Creates a new pickup for the shipments specified in the request.
Depending on the request, an error may be returned when the shipments can't form a single pickup, e.g. when they have different carriers.
Optionally the new pickup can be manifested. That means that the EDI is sent to the carrier if necessary and the pickup will be closed.
When specified in request, the manifest documents are printed.",
"operationId" : "createPickup",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreatePickupRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreatePickupRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreatePickupResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLCreatePickupResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/updateCustomsData" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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/getAllCarriers" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "getAllCarriers",
"description" : "Returns a list of all carrier available for the requested client.",
"operationId" : "getAllCarriers",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetAllCarriersRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetAllCarriersRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetAllCarriersResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetAllCarriersResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/syncShipments" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"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/getCarrierPortfolioNames" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "getCarrierPortfolioNames",
"description" : "Returns a list of the names of all supported carriers.",
"operationId" : "getCarrierPortfolioNames",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioNamesRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioNamesRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioNamesResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioNamesResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/getCarrierProperties" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "getCarrierProperties",
"description" : "Returns the properties of the requested carrier.",
"operationId" : "getCarrierProperties",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPropertiesRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPropertiesRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPropertiesResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPropertiesResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/addShipmentAttachments" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "addShipmentAttachments",
"description" : "Adds attachments to a shipment (e.g. invoices, origin documents, etc.).",
"operationId" : "addShipmentAttachments",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLAddShipmentAttachmentsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLAddShipmentAttachmentsRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLAddShipmentAttachmentsResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLAddShipmentAttachmentsResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/DLCarrierBFBean/getCarrierPortfolioDetails" : {
"post" : {
"tags" : [ "DLCarrierBFBean" ],
"summary" : "getCarrierPortfolioDetails",
"description" : "Returns detailed information about the requested carriers.",
"operationId" : "getCarrierPortfolioDetails",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioDetailsRequestDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioDetailsRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioDetailsResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/DLGetCarrierPortfolioDetailsResponseDTO"
}
}
}
}
},
"security" : [ {
"BASIC_AUTH" : [ ]
} ]
}
},
"/FoundationAFBean/workplace" : {
"post" : {
"tags" : [ "FoundationAFBean" ],
"description" : "Creates an application facade to be able to display the (Casabac-)workplace.
The difference of this method compared to the the method \\\"IFoundationBF.getWorkplaceURL()\\\" is the fact, that no logon mask will be dipsplayed before entering the workplace
The RFC name of this function is \\\"/AEB/XNSG_IF_WPL\\\".",
"operationId" : "workplace",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeParmsDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplicationFacadeDTO"
}
}
}
}
}
}
},
"/FoundationAFBean/releaseApplicationFacade" : {
"post" : {
"tags" : [ "FoundationAFBean" ],
"description" : "Release a application facade which is no longer needed.
This call will save resources in the server, because the server must not wait for the timeout of the application facades session but can release it earlier.
The method should only be called if it is definitively known, that no access to the application facade by the user is possible any more, e.g. because the surrounding client GUI window was closed.
The RFC name of this function is \\\"/AEB/XNSG_IF_RELAF\\\".",
"operationId" : "releaseApplicationFacade",
"parameters" : [ {
"name" : "sessionid",
"in" : "query",
"description" : "sessionid The sessionid returned by any application facade method, e.g. workplace @throws RemoteException",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "No result.",
"content" : {
"application/json" : { }
}
}
}
}
},
"/logon/authToken" : {
"get" : {
"description" : "Logon from the \"Authorization\" header (e.g. type \"Basic\"). The generated authentication token can be used in subsequent calls in the \"Authorization\" header, type \"Bearer\".",
"operationId" : "authToken",
"responses" : {
"200" : {
"description" : "Returns the authentication token.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
},
"401" : {
"description" : "Returns the cause why authentication has failed.",
"content" : {
"text/plain" : {
"schema" : {
"type" : "string"
}
}
}
}
}
}
},
"/logon/user" : {
"post" : {
"description" : "Logon with classical procedure: user, client and password.",
"operationId" : "logonUser",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserClientLoginDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "Returns information on logon process, including roles that have been granted to the user and a login token, or an error message when auth data is not correct.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogonResponse"
}
}
}
}
}
}
},
"/ExternalTelemetryBFBean/getStatus" : {
"post" : {
"tags" : [ "ExternalTelemetryBFBean" ],
"description" : "Returns the current status of the telemetry system.
The external system id must be sent with the request.",
"operationId" : "getTelemetryStatus",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExternalTMIdentificationRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExternalTMStatusResponseDTO"
}
}
}
}
}
}
},
"/ExternalTelemetryBFBean/status" : {
"get" : {
"tags" : [ "ExternalTelemetryBFBean" ],
"description" : "Returns the current status of the telemetry system.
The external system id must be sent with the request.",
"operationId" : "getTelemetryStatusByParams",
"parameters" : [ {
"name" : "externalSystemId",
"in" : "query",
"description" : "externalSystemId, the id of the calling system, mandatory",
"schema" : {
"type" : "string"
}
}, {
"name" : "reportClientIdentCode",
"in" : "query",
"description" : "reportClientIdentCode, the identCode of the client to call the status for",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExternalTMStatusResponseDTO"
}
}
}
}
}
}
},
"/ExternalTelemetryBFBean/telemetryReport" : {
"post" : {
"tags" : [ "ExternalTelemetryBFBean" ],
"description" : "Submits telemetry data for a new telemetry report.
The external system id must be sent with the request, a client IdentCode only if client dependent.",
"operationId" : "sendTelemetryReport",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExternalTMReportRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExternalTMResponseDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/sendMail" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Sends a mail.",
"operationId" : "sendMail",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SendMailParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SendMailResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/downloadFile" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Retrieves a file for download.",
"operationId" : "downloadFile",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadFileRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadFileResponseDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/client" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests all clients from this engine.",
"operationId" : "getAllClients",
"responses" : {
"200" : {
"description" : "Contains the client infos.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ClientDTO"
}
}
}
}
}
}
},
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Create a client.",
"operationId" : "createClient",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateClientRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateClientResponseDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/productInfo" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the product info from this engine.",
"operationId" : "getProductInfo",
"responses" : {
"200" : {
"description" : "Contains the product info.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductInfoDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/roles" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the current engine to report all its roles",
"operationId" : "requestReport",
"responses" : {
"200" : {
"description" : "Contains all roles and clients.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoleInfoDTO"
}
}
}
}
}
}
}
},
"/FoundationBFBean/roles/{clientIdentCode}" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the current engine to report all roles for a specific client",
"operationId" : "requestReport_1",
"parameters" : [ {
"name" : "clientIdentCode",
"in" : "path",
"description" : "Client ident code for retrieving its roles.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Contains the roles of a specific client from the queried engine.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoleInfoDTO"
}
}
}
}
},
"400" : {
"description" : "Client ident code is invalid."
},
"404" : {
"description" : "No client with that ident code exists."
}
}
}
},
"/FoundationBFBean/announceStop" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Announces a stop of the installation.",
"operationId" : "announceStop",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AnnounceStopParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AnnounceStopResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/runtimeInfo" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the runtime info from this engine.",
"operationId" : "getRuntimeInfo",
"responses" : {
"200" : {
"description" : "Contains the runtime info.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RuntimeInfoDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/cancelAnnounceStop" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Revokes an already announced stop.",
"operationId" : "cancelAnnounceStop",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CancelAnnounceStopParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CancelAnnounceStopResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/startTableUpdate" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Starts the table update.",
"operationId" : "startTableUpdate",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StartTableUpdateParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TableUpdateStateResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/restartRFCServer" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure definitions had changed, e.g. after installing a transport. The RFC name of this function is \"/AEB/XNSG_IF_RSTRFCSRV\"",
"operationId" : "restartRFCServer",
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : { }
}
}
}
}
},
"/FoundationBFBean/monitoringValue/{groupName}/{valueName}" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests a specific monitoring value from this engine.",
"operationId" : "getMonitoringValue",
"parameters" : [ {
"name" : "groupName",
"in" : "path",
"description" : "group name",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "valueName",
"in" : "path",
"description" : "value name",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The monitoring value."
}
}
}
},
"/FoundationBFBean/systemSearch/{language}" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Performs a system search in this engine.",
"operationId" : "systemSearch",
"parameters" : [ {
"name" : "language",
"in" : "path",
"description" : "the langauge",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SystemSearchParameterDTO"
}
}
}
}
},
"responses" : {
"200" : {
"description" : "The search results.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SystemSearchResultDTO"
}
}
}
}
}
}
}
},
"/FoundationBFBean/workplaceURL" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the workplace url from this engine.",
"operationId" : "getWorkplaceURL",
"responses" : {
"200" : {
"description" : "The workspace url."
}
}
}
},
"/FoundationBFBean/uploadSettings" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Retrieves the upload settings.",
"operationId" : "getUploadSettings",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadSettingsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The upload settings.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadSettingsResponseDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/acknowledgeFile" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Acknowledges a file download.",
"operationId" : "acknowledgeFile",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcknowledgeFileRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcknowledgeFileResponseDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/numberOfClients" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Returns the number of clients.",
"operationId" : "getNumberOfClients",
"responses" : {
"200" : {
"description" : "The client count."
}
}
}
},
"/FoundationBFBean/client/duplicate" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Duplicates a client.
This method is deprecated. It's no longer supported for external access.
It is only supported for AEB internal use in InternalProvisioningBF
.",
"operationId" : "duplicateClient",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DuplicateClientRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DuplicateClientResponseDTO"
}
}
}
}
},
"deprecated" : true
}
},
"/FoundationBFBean/uploadFileMultiPart" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Uploads a file using multipart.",
"operationId" : "uploadFileMultiPart",
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"file" : {
"type" : "string",
"description" : "Attach file to upload",
"format" : "binary"
},
"metaInfo" : {
"$ref" : "#/components/schemas/UploadFileMultiPartRequestDTO"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadFileResponseDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/client/active" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests all active clients from this engine.",
"operationId" : "getAllActiveClients",
"responses" : {
"200" : {
"description" : "Contains the client infos.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ClientDTO"
}
}
}
}
}
}
}
},
"/FoundationBFBean/solution/{name}/version" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the version info for a solution from this engine.",
"operationId" : "getVersionForSolution",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "Name of solution.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Contains the version info.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VersionInfoDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/solution/{name}/build" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests the build info for a solution from this engine.",
"operationId" : "getBuildForSolution",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "Name of solution.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Contains the build info."
}
}
}
},
"/FoundationBFBean/monitoringValue" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Requests all monitoring values from this engine.",
"operationId" : "getAllMonitoringValues",
"responses" : {
"200" : {
"description" : "Contains all monitoring values.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MonitoringDataProviderDTO"
}
}
}
}
}
}
}
},
"/FoundationBFBean/checkDebtorNumber" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Checks if debtor number is known.",
"operationId" : "isDebtorNumberKnown",
"parameters" : [ {
"name" : "debtorNumber",
"in" : "query",
"description" : "the debtor number to check",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "True if known."
}
}
}
},
"/FoundationBFBean/changeAdminPassword" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Changes the admin password.",
"operationId" : "changeAdminPassword",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangeAdminPasswordParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangeAdminPasswordResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/generateClientIdentCode" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Generates a client ident code.",
"operationId" : "generateClientIdentCode",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateClientIdentCodeRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The client ident code."
}
}
}
},
"/FoundationBFBean/tableUpdateState" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Retrieve the status of the table update.",
"operationId" : "getTableUpdateState",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TableUpdateStateParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The table update status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TableUpdateStateResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/startScriptExecution" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Starts a script execution",
"operationId" : "startScriptExecution",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StartScriptExecutionParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/StartScriptExecutionResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/scriptExecutionState" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "gets a script execution state",
"operationId" : "getScriptExecutionState",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScriptExecutionStateParmDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScriptExecutionStateResultDTO"
}
}
}
}
}
}
},
"/FoundationBFBean/client/duplicate/{processId}" : {
"get" : {
"tags" : [ "FoundationBFBean" ],
"description" : "The duplication status of a client.
This method is deprecated. It's no longer supported for external access.
It is only supported for AEB internal use in InternalProvisioningBF
.",
"operationId" : "getDuplicateClientProgress",
"parameters" : [ {
"name" : "processId",
"in" : "path",
"description" : "the process id to check",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The duplication progress.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DuplicateClientProgressResponseDTO"
}
}
}
}
},
"deprecated" : true
}
},
"/FoundationBFBean/downloadableFileRefs" : {
"post" : {
"tags" : [ "FoundationBFBean" ],
"description" : "Retrieves refs for download.",
"operationId" : "getDownloadableFilesRefs",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLFilesRefsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The download refs.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DLFilesRefsResponseDTO"
}
}
}
}
}
}
},
"/InternalProvisioningBFBean/getClientFeatures" : {
"post" : {
"tags" : [ "InternalProvisioningBFBean" ],
"description" : "Retrieve all client features for a given client.",
"operationId" : "getClientFeatures",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetClientFeaturesRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetClientFeaturesResponseDTO"
}
}
}
}
}
}
},
"/InternalProvisioningBFBean/setClientFeatures" : {
"post" : {
"tags" : [ "InternalProvisioningBFBean" ],
"description" : "Update the client features for a given client.",
"operationId" : "setClientFeatures",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetClientFeaturesRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetClientFeaturesResponseDTO"
}
}
}
}
}
}
},
"/InternalProvisioningBFBean/createClientFromTemplate" : {
"post" : {
"tags" : [ "InternalProvisioningBFBean" ],
"description" : "Creates a new client by duplicating it from a given template client. Start the process here and check its progress using getCreateClientFromTemplateStatus
",
"operationId" : "createClientFromTemplate",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateClientFromTemplateRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateClientFromTemplateResponseDTO"
}
}
}
}
}
}
},
"/InternalProvisioningBFBean/getCreateClientFromTemplateStatus" : {
"post" : {
"tags" : [ "InternalProvisioningBFBean" ],
"description" : "Retrieve the status of an ongoing or completed client duplication process started by createClientFromTemplate
.",
"operationId" : "getCreateClientFromTemplateStatus",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCreateClientFromTemplateStatusRequestDTO"
}
}
}
},
"responses" : {
"default" : {
"description" : "default response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCreateClientFromTemplateStatusResponseDTO"
}
}
}
}
}
}
},
"/RemoteAdminBFBean/roles" : {
"get" : {
"tags" : [ "RemoteAdminBFBean" ],
"summary" : "getRoles",
"description" : "Returns a list of roles",
"operationId" : "getRolesGET",
"parameters" : [ {
"name" : "scope",
"in" : "query",
"description" : "the dataset to return",
"schema" : {
"type" : "string"
}
}, {
"name" : "clientIdentCodes",
"in" : "query",
"description" : "includeClientIdentCodes",
"schema" : {
"type" : "string"
}
}, {
"name" : "resultLanguageIsoCodes",
"in" : "query",
"description" : "resultLanguageIsoCodes",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRolesResponseDTO"
}
},
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/GetRolesResponseDTO"
}
}
}
}
}
}
},
"/SyncBFBean/synchronizeEvents" : {
"post" : {
"tags" : [ "SyncBFBean" ],
"description" : "Poll the next events for the client system.
This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link SyncEventsRequestDTO#syncId}
See {@link #getNotAcknowledgedEvents(SyncEventsRequestDTO)} for a version of the method, were the syncronisation state is kept within the Engine.",
"operationId" : "synchronizeEvents",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncEventsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncEventsResponseDTO"
}
}
}
}
}
}
},
"/SyncBFBean/acknowledgeEvents" : {
"post" : {
"tags" : [ "SyncBFBean" ],
"description" : "Acknowledge events got with {@link #getNotAcknowledgedEvents(SyncEventsRequestDTO)}.
Since XNSG 4.0, Nov. FP, 2017
.",
"operationId" : "acknowledgeEvents",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcknowledgeEventsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AcknowledgeEventsResponseDTO"
}
}
}
}
}
}
},
"/SyncBFBean/getNotAcknowledgedEvents" : {
"post" : {
"tags" : [ "SyncBFBean" ],
"description" : "Poll any not acknowledged events for the client system.
This method does not require, that the client system fills {@link SyncEventsRequestDTO#syncId}.
However, it requires, that a call to {@link #acknowledgeEvents(AcknowledgeEventsRequestDTO)} is done for acknowledge of the events.
Since XNSG 4.0, Nov. FP, 2017
.",
"operationId" : "getNotAcknowledgedEvents",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncEventsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncEventsResponseDTO"
}
}
}
}
}
}
},
"/SyncBFBean/subscribePartnerSystem" : {
"post" : {
"tags" : [ "SyncBFBean" ],
"description" : "Subscribe a partner system to be able to receive events for the specified business object type.
The subscription is uniquely identified by the clientSystemId
and businessObjectType
(both mandatory fields).
Since XNSG 4.0, Nov. FP, 2021
",
"operationId" : "subscribePartnerSystem",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscribePartnerSystemRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SubscribePartnerSystemResponseDTO"
}
}
}
}
}
}
},
"/SyncBFBean/getPartnerSystemSubscriptions" : {
"post" : {
"tags" : [ "SyncBFBean" ],
"description" : "Fetch a list of registered subscriptions (either all or filtered by the business object type).
Only subscription belonging to the provided clientSystemId
are returned (mandatory field)
Since XNSG 4.0, Nov. FP, 2021
",
"operationId" : "getPartnerSystemSubscriptions",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPartnerSystemSubscriptionsRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPartnerSystemSubscriptionsResponseDTO"
}
}
}
}
}
}
},
"/SyncBFBean/unsubscribePartnerSystem" : {
"post" : {
"tags" : [ "SyncBFBean" ],
"description" : "Unsubscribe a partner system from being able to receive events for the specified business object type.
The subscription is uniquely identified by the clientSystemId
and businessObjectType
(both mandatory fields).
Since XNSG 4.0, Nov. FP, 2021
",
"operationId" : "unsubscribePartnerSystem",
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UnsubscribePartnerSystemRequestDTO"
}
}
}
},
"responses" : {
"200" : {
"description" : "The operation result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UnsubscribePartnerSystemResponseDTO"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"DLCreateShipmentResponseDTO" : {
"type" : "object",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "
True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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
" }, "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" }, "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"
}
}
},
"description" : "Response DTO for the createShipment business facade method",
"xml" : {
"name" : "createShipmentResponseDTO"
}
},
"DLDocumentDTO" : {
"type" : "object",
"properties" : {
"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", "description" : "Only filled for \"image\" mime types. Specifies resolution of the image.length = 8
", "format" : "int32" }, "content" : { "type" : "array", "description" : "The document content", "items" : { "type" : "string", "description" : "The document content", "format" : "byte" } } }, "description" : "DTO for a document to be printed out by the client system." }, "DLPackageProcessingResultDTO" : { "type" : "object", "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
" }, "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" } } }, "description" : "DTO holding result information of a package processing.syncShipments
call."
},
"DLShipmentAccountInfoResponseDataDTO" : {
"type" : "object",
"properties" : {
"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." } }, "description" : "Holds information from the account used for the shipment" }, "ResponseMessageDTO" : { "type" : "object", "properties" : { "messageType" : { "type" : "string", "description" : "Message type
If not stated otherwise, the possible types are:
Maximum length: 50
", "example" : "WARNING" }, "messageIdentCode" : { "type" : "string", "description" : "Optional identification code for further classification of the message type.
Maximum length: 50
", "example" : "5627" }, "messageTexts" : { "type" : "array", "description" : "Detailed message texts in the requested languages.
", "items" : { "$ref" : "#/components/schemas/TextInLanguageDTO" } }, "indentationLevel" : { "type" : "integer", "description" : "The indentation level of the message.
'0' indicates a top level message.
", "format" : "int32", "example" : 0 } }, "description" : "Result messages like errors or warnings." }, "TextInLanguageDTO" : { "type" : "object", "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" } }, "description" : "A translated text in one of the specified languages." }, "AmountOfMoneyDTO" : { "type" : "object", "properties" : { "value" : { "type" : "number", "description" : "The value of the amount of money.length=15, scale=2
" }, "currencyIso" : { "type" : "string", "description" : "The three letter ISO code of the currency of the amount of money.length=3
" } }, "description" : "An amount of money with a value and an currency ISO code." }, "DLContainerDataDTO" : { "type" : "object", "properties" : { "verifiedGrossMass" : { "$ref" : "#/components/schemas/QuantityDTO" }, "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
" } }, "description" : "DTO containing data for container package types." }, "DLCreateShipmentRequestDTO" : { "required" : [ "creationParms", "processParms", "shipment" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "creationParms" : { "$ref" : "#/components/schemas/DLShipmentCreationParmsDTO" }, "shipment" : { "$ref" : "#/components/schemas/DLShipmentRequestDataDTO" }, "processParms" : { "$ref" : "#/components/schemas/DLShipmentProcessParmsDTO" } }, "description" : "Request DTO for the createShipment business facade method", "xml" : { "name" : "createShipmentRequestDTO" } }, "DLCuboidDimensionsDTO" : { "required" : [ "height", "identCode", "length", "width" ], "type" : "object", "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
" } }, "description" : "DLCuboidDimensionsDTO with length, width, height and identCode." }, "DLDocumentOutputModeDTO" : { "required" : [ "mode" ], "type" : "object", "properties" : { "mode" : { "type" : "string", "description" : "The output mode for the documents. Valid values are:
length=15
" } }, "description" : "DTO specifying the output mode for documents." }, "DLDocumentScopeDTO" : { "required" : [ "scope" ], "type" : "object", "properties" : { "scope" : { "type" : "string", "description" : "The scope of documents to be processed (prepared or printed). Valid values are:
length=20
" } }, "description" : "DTO specifying the scope of documents to be processed." }, "DLHazardousGoodsItemRequestDataDTO" : { "required" : [ "hazardRegulation" ], "type" : "object", "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 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) 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" }, "hazardNetQuantity" : { "$ref" : "#/components/schemas/QuantityDTO" }, "netExplosiveWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "numberOfPackages" : { "type" : "integer", "description" : "Number of packages -->do we really want to keept this fieldlength=10
", "format" : "int32" }, "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", "description" : "Hazardous points
length=5
", "format" : "int32" }, "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" }, "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" : "DTO for request information of a DLHazardousGoodsItem." }, "DLPackageCumulationRequestDataDTO" : { "required" : [ "numberOfPackages", "packageTypeIdentCode" ], "type" : "object", "properties" : { "numberOfPackages" : { "type" : "integer", "description" : "The number of packages.
length=3
", "format" : "int32" }, "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" }, "volume" : { "$ref" : "#/components/schemas/QuantityDTO" }, "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
" } }, "description" : "DTO for package cumulation data." }, "DLPackageHazardousGoodsDataRequestDTO" : { "required" : [ "hazardousGoodsType" ], "type" : "object", "properties" : { "hazardousGoodsType" : { "type" : "string", "description" : "Indicates the type of hazardous goods packaged in the package. Valid values are:length=2, scale=1
" } }, "description" : "Holds hazardous goods data concerning the package." }, "DLPackageRequestDataDTO" : { "required" : [ "packageTransactionId", "packageTypeIdentCode" ], "type" : "object", "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", "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=4
", "format" : "int32" }, "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" }, "dimensions" : { "$ref" : "#/components/schemas/DLCuboidDimensionsDTO" }, "alternativeVolume" : { "$ref" : "#/components/schemas/QuantityDTO" }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" }, "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
" } }, "description" : "DTO for package data." }, "DLPartyDTO" : { "type" : "object", "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 mode in which the operation is processed. Valid values are:
length=10
" } }, "description" : "DTO specifying the mode in which an operation is processed." }, "DLReferenceTextDTO" : { "type" : "object", "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
" } }, "description" : "DTO for reference numbers and texts of a certain (predefined) type." }, "DLShipmentCarrierInfoTextDTO" : { "required" : [ "identCode" ], "type" : "object", "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
" } }, "description" : "DTO specifying a carrier's info text for a shipment." }, "DLShipmentCreationParmsDTO" : { "required" : [ "creationMode" ], "type" : "object", "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
" } }, "description" : "Creation parameters for a shipment. Specifies when and how to create a shipment or it's packages." }, "DLShipmentItemReferenceDTO" : { "required" : [ "shipmentReference" ], "type" : "object", "properties" : { "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "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.length=4
", "format" : "int32" }, "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" }, "netWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "despatchProcedureIdentCode" : { "type" : "string", "description" : "The despatch procedure. Possible values are:
length=10
" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" }, "hazardousGoodsItems" : { "type" : "array", "description" : "Hazardous goods items.", "items" : { "$ref" : "#/components/schemas/DLHazardousGoodsItemRequestDataDTO" } } }, "description" : "DTO for shipment item data in a request." }, "DLShipmentProcessParmsDTO" : { "required" : [ "doCompletion", "documentOutputMode", "documentOutputScope", "documentPrepareScope", "processMode", "workstationId" ], "type" : "object", "properties" : { "processMode" : { "$ref" : "#/components/schemas/DLProcessModeDTO" }, "documentPrepareScope" : { "$ref" : "#/components/schemas/DLDocumentScopeDTO" }, "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=20
" }, "documentOutputScope" : { "$ref" : "#/components/schemas/DLDocumentScopeDTO" }, "documentOutputMode" : { "$ref" : "#/components/schemas/DLDocumentOutputModeDTO" }, "doCompletion" : { "type" : "boolean", "description" : " '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.
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
" } }, "description" : "DTO for uniquely identifying a DLShipment within a specific client." }, "DLShipmentRequestDataDTO" : { "required" : [ "carrierIdentCode", "consignee", "contents", "referenceNumber1", "serviceCode", "shippingDate", "shippingPt", "termsOfDeliveryCode", "transactionId" ], "type" : "object", "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", "description" : "Registration number (MRN, etc.) of the customs declaration. The number is assigned by the customs authorities.length=35
" }, "transportRegistrationNumber" : { "type" : "string", "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", "description" : "The number of exchange pallets. Used for the pallet exchange system if supported by carrier.length=5
", "format" : "int32" }, "shopId" : { "type" : "string", "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 timezone 'UTC'.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" }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "consignee" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "consigneeContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "altInvoiceRecipient" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "altInvoiceRecipientContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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 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
" }, "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
" }, "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
" }, "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" }, "pickupAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "notifyAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "notifyAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "coverAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "coverAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "customsAgent" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "customsAgentContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "alternativeCarrierAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "alternativeCarrierAddrContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "importerAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "importerAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "exporterAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "exporterAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "payerOfChargRole" : { "type" : "string", "description" : "The payer of charges. Valid values are:
length=10
" }, "payerOfCharg" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "payerOfChargContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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" }, "payerOfDutContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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.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" : "DTO for shipment data in a request." }, "DLShipmentTotalsRequestDataDTO" : { "type" : "object", "properties" : { "numberOfPackagesExpected" : { "type" : "integer", "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
", "format" : "int32" }, "grossWeightExpected" : { "$ref" : "#/components/schemas/QuantityDTO" }, "loadingMeters" : { "type" : "number", "description" : "The loading meters needed for the shipment. When left empty, the sum of the values specified in request field 'packageCumulations' will be used whereever the loading meters are needed on shipment level.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
" } }, "description" : "DTO for shipment totals in a request." }, "DLTransportEquipmentDTO" : { "required" : [ "equipmentTransactionId", "equipmentTypeIdentCode" ], "type" : "object", "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" }, "dimensions" : { "$ref" : "#/components/schemas/DLCuboidDimensionsDTO" }, "containerData" : { "$ref" : "#/components/schemas/DLContainerDataDTO" }, "sealNumbers" : { "type" : "array", "description" : "Seal (serial numbers and/or barcodes) of the transport equipment.length = 35
", "items" : { "type" : "string", "description" : "Seal (serial numbers and/or barcodes) of the transport equipment.length = 35
" } } }, "description" : "DTO representing a specific transport equipment such as a containers or a pallets." }, "DLTransportEquipmentReferenceDTO" : { "required" : [ "equipmentTransactionId" ], "type" : "object", "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
" } }, "description" : "DTO for uniquely identifying a transport equipment within a shipment." }, "DLValueAddedServiceReferenceDTO" : { "required" : [ "identCode" ], "type" : "object", "properties" : { "identCode" : { "type" : "string", "description" : "Value added service ident code of the carrier.length=20
" } }, "description" : "DTO to reference a value added service within a carrier." }, "GenericDataFieldDTO" : { "type" : "object", "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/.
length=15, scale=3
" }, "unit" : { "type" : "string", "description" : "Identifier of the quantity unit (must be unique). E.g. St / h / kg for pieces / hours / kilograms.length=10
" } }, "description" : "A quantity with a value and a quantity unit.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" } } }, "description" : "Response DTO for the deleteItem business facade method", "xml" : { "name" : "deleteItemResponseDTO" } }, "DLDeleteItemRequestDTO" : { "required" : [ "shipmentItemReference" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "shipmentItemReference" : { "$ref" : "#/components/schemas/DLShipmentItemReferenceDTO" } }, "description" : "Request DTO for the deleteItem business facade method", "xml" : { "name" : "deleteItemRequestDTO" } }, "DLDeletePickupResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : "Response DTO for the cancelPickup business facade method", "xml" : { "name" : "deletePickupResponseDTO" } }, "DLDeletePickupRequestDTO" : { "required" : [ "pickupReference" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "pickupReference" : { "$ref" : "#/components/schemas/DLPickupReferenceDTO" } }, "description" : "Request DTO for the cancelShipment business facade method", "xml" : { "name" : "deletePickupRequestDTO" } }, "DLPickupReferenceDTO" : { "type" : "object", "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
" } }, "description" : "DTO for uniquely identifying a shipment pickup within a client." }, "ComboboxEntryDTO" : { "type" : "object", "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" } } }, "description" : "For common use in BF methods which return combobox entries, e.g. for a list of master file data." }, "DLGetShipmentsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "shipments" : { "type" : "array", "description" : "The resulting shipments.", "items" : { "$ref" : "#/components/schemas/DLShipmentResponseDataDTO" } } }, "description" : "Data Transfer Object for shipment search result.", "xml" : { "name" : "getShipmentsResponseDTO" } }, "DLHazardousGoodsItemResponseDataDTO" : { "type" : "object", "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) 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" }, "hazardNetQuantity" : { "$ref" : "#/components/schemas/QuantityDTO" }, "netExplosiveWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "numberOfPackages" : { "type" : "integer", "description" : "Number of packageslength=10
", "format" : "int32" }, "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", "description" : "Hazardous points
length=5
", "format" : "int32" }, "flashPoint" : { "type" : "string", "description" : "Flash pointlength=20
" }, "emergencyContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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" : "DTO for response information of a DLHazardousGoodsItem." }, "DLPackageHazardousGoodsDataResponseDTO" : { "type" : "object", "properties" : { "hazardousGoodsType" : { "type" : "string", "description" : "Indicates the type of hazardous goods packaged in the package. Possible values are:
length=2, scale=1
" } }, "description" : "Holds hazardous goods data concerning the package." }, "DLPackageResponseDataDTO" : { "type" : "object", "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=4
", "format" : "int32" }, "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
" }, "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" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" }, "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" }, "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=4
", "format" : "int32" }, "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" }, "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" }, "netWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "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" } }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" }, "hazardousGoodsItems" : { "type" : "array", "description" : "Hazardous goods items.", "items" : { "$ref" : "#/components/schemas/DLHazardousGoodsItemResponseDataDTO" } } }, "description" : "DTO for shipment item data in a response." }, "DLShipmentResponseDataDTO" : { "type" : "object", "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 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
" }, "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", "description" : "Revision number.length=3
", "format" : "int32" }, "referenceNumber1" : { "type" : "string", "description" : "Reference number 1.length=50
" }, "referenceNumber2" : { "type" : "string", "description" : "Reference number 2.length=50
" }, "customsRegistrationNumber" : { "type" : "string", "description" : "Registration number (MRN, etc.) of the customs declaration. The number is assigned by the customs authorities.length=35
" }, "transportRegistrationNumber" : { "type" : "string", "description" : "Transport registration number like EKAER (Hungary) or SENT (Poland). The number is assigned by the local authorities.length=35
" }, "shopId" : { "type" : "string", "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" }, "isCompleted" : { "type" : "boolean", "description" : "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" }, "shippingDate" : { "type" : "string", "description" : "Shipping date in the format 'yyyy-MM-dd'.length=10
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "consignee" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "consigneeContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "altInvoiceRecipient" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "altInvoiceRecipientContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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'.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" }, "pickupAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "notifyAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "notifyAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "coverAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "coverAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "customsAgent" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "customsAgentContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "alternativeCarrierAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "alternativeCarrierAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "importerAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "importerAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "exporterAddress" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "exporterAddressContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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" }, "payerOfChargContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "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" }, "payerOfDutContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "payerOfDutAccountNo" : { "type" : "string", "description" : "The payer of duties and taxes account number.length=50
" }, "contents" : { "type" : "string", "description" : "Additional content discriptionlength=250
" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "insuranceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "codValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "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", "description" : "The number of packageslength=5
", "format" : "int32" }, "shipmentTotals" : { "$ref" : "#/components/schemas/DLShipmentTotalsResponseDataDTO" }, "accountInfo" : { "$ref" : "#/components/schemas/DLShipmentAccountInfoResponseDataDTO" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" }, "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" } } }, "description" : "DTO for response information of a DLShipment.length=5
", "format" : "int32" }, "numberOfPackagesExpected" : { "type" : "integer", "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
", "format" : "int32" }, "grossWeight" : { "$ref" : "#/components/schemas/QuantityDTO" }, "grossWeightExpected" : { "$ref" : "#/components/schemas/QuantityDTO" }, "loadingMeters" : { "type" : "number", "description" : "The loading 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
" }, "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
" } }, "description" : "DTO for shipment totals in a request." }, "DLValueAddedServiceDTO" : { "type" : "object", "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
" } }, "description" : "Response information about a value added service." }, "DLGetShipmentsRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "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" : "DTO to search for shipments and request detail information about them.", "xml" : { "name" : "getShipmentsRequestDTO" } }, "DLShipmentFilterDTO" : { "type" : "object", "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", "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
", "format" : "date-time" }, "shippingDateTo" : { "type" : "string", "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
", "format" : "date-time" }, "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", "description" : "The maximum number of shipments to be returned. If no value is specified, a default of 100 is assumed.length=4
", "format" : "int32" } }, "description" : "DTO to set a filter for a shipment query." }, "DLProcessShipmentResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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
" }, "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"
}
}
},
"description" : "Response DTO for the processShipment business facade method.Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "creationParms" : { "$ref" : "#/components/schemas/DLShipmentCreationParmsDTO" }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "shipmentTotals" : { "$ref" : "#/components/schemas/DLShipmentTotalsRequestDataDTO" }, "shipmentUpdateData" : { "$ref" : "#/components/schemas/DLShipmentUpdateRequestDataDTO" }, "packages" : { "type" : "array", "description" : "The packages to be added to the shipment. The field may be empty when only processing is required and no new packages are to be added to the shipment.", "items" : { "$ref" : "#/components/schemas/DLPackageRequestDataDTO" } }, "packageCumulations" : { "type" : "array", "description" : "The package cumulations to be added to the shipment. The field may be empty when only processing is required and no new package cumulations are to be added to the shipment.", "items" : { "$ref" : "#/components/schemas/DLPackageCumulationRequestDataDTO" } }, "items" : { "type" : "array", "description" : "The items to be added to the shipment. The field may be empty when only processing is required and no new items are to be added to the shipment.", "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 to be added to the shipment. The field may be empty when only processing is required and no new transport equipments are to be added to the shipment.", "items" : { "$ref" : "#/components/schemas/DLTransportEquipmentDTO" } }, "processParms" : { "$ref" : "#/components/schemas/DLShipmentProcessParmsDTO" }, "carrierInfoTexts" : { "type" : "array", "description" : "Carrier info texts for the shipment.", "items" : { "$ref" : "#/components/schemas/DLShipmentCarrierInfoTextDTO" } } }, "description" : "Request DTO for the processShipment business facade method", "xml" : { "name" : "processShipmentRequestDTO" } }, "DLShipmentUpdateRequestDataDTO" : { "type" : "object", "properties" : { "shippingDate" : { "type" : "string", "description" : "The new shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in timezone 'UTC'.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" }, "insuranceValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "customsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "customsRegistrationNumber" : { "type" : "string", "description" : "Update registration number (MRN, etc.) of the customs declaration." }, "transportRegistrationNumber" : { "type" : "string", "description" : "Update transport registration number like EKAER (Hungary) or SENT (Poland)." }, "shopId" : { "type" : "string", "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" }, "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." } }, "description" : "DTO for shipment fields which can be updated after the initial creation of the shipment" }, "DLCancelShipmentResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : "Response DTO for the cancelShipment business facade method", "xml" : { "name" : "cancelShipmentResponseDTO" } }, "DLCancelShipmentRequestDTO" : { "required" : [ "processParms", "shipmentReference" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "processParms" : { "$ref" : "#/components/schemas/DLShipmentCancelParmsDTO" } }, "description" : "Request DTO for the cancelShipment business facade method", "xml" : { "name" : "cancelShipmentRequestDTO" } }, "DLShipmentCancelParmsDTO" : { "required" : [ "processMode" ], "type" : "object", "properties" : { "processMode" : { "$ref" : "#/components/schemas/DLProcessModeDTO" } }, "description" : "Parameters for the cancle operation for a shipment." }, "DLDeletePackageResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : "Response DTO for the deletePackage business facade method", "xml" : { "name" : "deletePackageResponseDTO" } }, "DLDeletePackageRequestDTO" : { "required" : [ "packageReference" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "packageReference" : { "$ref" : "#/components/schemas/DLPackageReferenceDTO" } }, "description" : "Request DTO for the deletePackage business facade method", "xml" : { "name" : "deletePackageRequestDTO" } }, "DLPackageReferenceDTO" : { "required" : [ "packageTransactionId", "shipmentReference" ], "type" : "object", "properties" : { "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "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
" } }, "description" : "DTO for uniquely identifying a package. The context settingsclientIdentCode
and clientSystemId
are also applied when filled."
},
"DLProcessPickupResponseDTO" : {
"type" : "object",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "documents" : { "type" : "array", "description" : "The documents (manifests) of the pickup. Only filled, when specified indocumentOutputMode
of request.",
"items" : {
"$ref" : "#/components/schemas/DLDocumentDTO"
}
}
},
"description" : "Response DTO for the printDocumentsForPickup business facade method",
"xml" : {
"name" : "processPickupResponseDTO"
}
},
"DLPickupCreationParmsDTO" : {
"required" : [ "creationMode" ],
"type" : "object",
"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
" } }, "description" : "Creation parameters for a shipment. Specifies when and how to create a pickup and the shipment it contains." }, "DLPickupProcessParmsDTO" : { "required" : [ "doManifest", "documentOutputMode", "workstationId" ], "type" : "object", "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" }, "workstationId" : { "type" : "string", "description" : "The workstation where the documents should be printed out in the case of direct printing.length=20
" } }, "description" : "Process parameters for a pickup. Especially controls the handling of the manifest documents." }, "DLPickupUpdateRequestDataDTO" : { "type" : "object", "properties" : { "driverSignature" : { "$ref" : "#/components/schemas/DLSignatureDTO" } }, "description" : "DTO for pickup fields which can be updated after the initial creation of the pickup" }, "DLProcessPickupRequestDTO" : { "required" : [ "pickupReference", "processParms" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "pickupReference" : { "$ref" : "#/components/schemas/DLPickupReferenceDTO" }, "creationParms" : { "$ref" : "#/components/schemas/DLPickupCreationParmsDTO" }, "pickupUpdateData" : { "$ref" : "#/components/schemas/DLPickupUpdateRequestDataDTO" }, "shipments" : { "type" : "array", "description" : "Shipments to be added to the pickup.", "items" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" } }, "processParms" : { "$ref" : "#/components/schemas/DLPickupProcessParmsDTO" } }, "description" : "Request DTO for the printDocumentsForPickup business facade method", "xml" : { "name" : "processPickupRequestDTO" } }, "DLSignatureDTO" : { "type" : "object", "properties" : { "text" : { "type" : "string", "description" : "Driver's signature text.length=50
" }, "image" : { "type" : "array", "description" : "Driver's signature image.", "items" : { "type" : "string", "description" : "Driver's signature image.", "format" : "byte" } }, "mimetype" : { "type" : "string", "description" : "The mimetype of the drivers signature image e.g. image/jpeg or image/png.length=250
" } }, "description" : "DLSignatureDTO containing driver's signature data" }, "DLGetPickupsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "pickups" : { "type" : "array", "description" : "The resulting pickups.", "items" : { "$ref" : "#/components/schemas/DLPickupResponseDataDTO" } } }, "description" : "Data Transfer Object for pickup search result.", "xml" : { "name" : "getPickupsResponseDTO" } }, "DLPickupResponseDataDTO" : { "type" : "object", "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" }, "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" }, "shippingDate" : { "type" : "string", "description" : "Shipping date in the format 'yyyy-MM-dd'.length=10
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "boStatus" : { "$ref" : "#/components/schemas/ComboboxEntryDTO" }, "isClosed" : { "type" : "boolean", "description" : "Indicates whether the pickup has been compiled. In that case no further shipping orders will be assigned to it." }, "isManifested" : { "type" : "boolean", "description" : "Indicates whether the pickup has been manifested." }, "isManifestedWithWarnings" : { "type" : "boolean", "description" : "Indicates that warnings occurred while transmitting at least one of the EDI messages." }, "isManifestDocumentsCreated" : { "type" : "boolean", "description" : "Indicates that the manifest documents have been created." }, "entryCertificateTS" : { "type" : "string", "description" : "Transfer timestamp of the entry certificate relevant documents to the VCP in format \"yyyy-MM-dd HH:mm:ss\"." }, "numberOfPackages" : { "type" : "integer", "description" : "The number of packages actually included in the pickup.length=5
", "format" : "int32" }, "numberOfShipments" : { "type" : "integer", "description" : "The number of shipments actually included in the pickup.length=5
", "format" : "int32" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" }, "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" } } }, "description" : "DTO for response information of a DLShipmentPickup." }, "DLShipmentPickupEDIDTO" : { "type" : "object", "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" }, "numberOfShipmentsInEDI" : { "type" : "integer", "description" : "The number of shipping orders contained in the EDI message.
", "format" : "int32" }, "shipmentReferences" : { "type" : "array", "description" : "The shipments included in the EDI message.
", "items" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" } } }, "description" : "Response-DTO for an EDI message for a pickup." }, "DLGetPickupsRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "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" : "DTO to search for pickups and request detail information about them.", "xml" : { "name" : "getPickupsRequestDTO" } }, "DLPickupFilterDTO" : { "type" : "object", "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", "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
", "format" : "date-time" }, "shippingDateTo" : { "type" : "string", "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
", "format" : "date-time" }, "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", "description" : "The maximum number of pickups to be returned. If no value is specified, a default of 100 is assumed.length=4
", "format" : "int32" } }, "description" : "DTO to set a filter for a pickup query." }, "DLSyncPickupsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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", "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\"]" } }, "ageInDays" : { "type" : "integer", "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
", "format" : "int32" }, "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'." } }, "description" : "Request DTO for pickup synchronization.", "xml" : { "name" : "syncPickupsRequestDTO" } }, "DLProcessPackageResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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" } } }, "description" : "Response DTO for the getPackageDocuments business facade method", "xml" : { "name" : "processPackageResponseDTO" } }, "DLMasterPackageReferenceDTO" : { "required" : [ "packageTransactionId" ], "type" : "object", "properties" : { "packageTransactionId" : { "type" : "string", "description" : "The number of the client system uniquely referencing a master shipment package.length=50
" } }, "description" : "DTO for uniquely identifying a master package." }, "DLPackageDocumentPrepareModeDTO" : { "required" : [ "mode" ], "type" : "object", "properties" : { "mode" : { "type" : "string", "description" : "The prepare mode for the package documents. Valid values are:
length=20
" } }, "description" : "DTO specifying the prepare mode for documents on package level." }, "DLPackageOperationModeDTO" : { "required" : [ "mode" ], "type" : "object", "properties" : { "mode" : { "type" : "string", "description" : "The operation mode for the operation to be performed on the package. Valid values are:
length=15
" } }, "description" : "Holds a special operation ID to be performed on the package. NOTE: this function has BETA status." }, "DLPackageProcessParmsDTO" : { "required" : [ "documentOutputMode", "documentPrepareMode", "processMode", "workstationId" ], "type" : "object", "properties" : { "processMode" : { "$ref" : "#/components/schemas/DLProcessModeDTO" }, "documentPrepareMode" : { "$ref" : "#/components/schemas/DLPackageDocumentPrepareModeDTO" }, "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=20
" }, "documentOutputMode" : { "$ref" : "#/components/schemas/DLDocumentOutputModeDTO" }, "operationMode" : { "$ref" : "#/components/schemas/DLPackageOperationModeDTO" } }, "description" : "Process parameters for a package. Specifies which operations have to be performed on a package." }, "DLProcessPackageRequestDTO" : { "required" : [ "packageReference", "processParms" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "packageReference" : { "$ref" : "#/components/schemas/DLPackageReferenceDTO" }, "processParms" : { "$ref" : "#/components/schemas/DLPackageProcessParmsDTO" }, "targetShipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "masterPackageReference" : { "$ref" : "#/components/schemas/DLMasterPackageReferenceDTO" }, "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" } } }, "description" : "Request DTO for the getPackageDocuments business facade method.", "xml" : { "name" : "processPackageRequestDTO" } }, "DLValidateShipmentResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "validationResult" : { "type" : "string", "description" : "\"VALIDATION_OK\" or any of the other constants to indicate the result of the validation." } }, "description" : "Possible Result Values: VALIDATION_FAILED VALIDATION_OK VALIDATION_REQUEST_NOT_SUPPORTED VALIDATION_MISSING_DATA VALIDATION_NO_CHECK_SELECTED VALIDATION_EXECUTION_ERROR", "xml" : { "name" : "validateShipmentReponseDTO" } }, "DLShipmentValidationParmsDTO" : { "required" : [ "validationMode" ], "type" : "object", "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", "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\"]" } }, "shipment" : { "$ref" : "#/components/schemas/DLShipmentRequestDataDTO" }, "validationParms" : { "$ref" : "#/components/schemas/DLShipmentValidationParmsDTO" } }, "description" : "DTO class for shipment validation request data.", "xml" : { "name" : "validateShipmentRequestDTO" } }, "DLCreatePickupResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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"
}
}
},
"description" : "Response DTO for the processPickup business facade method",
"xml" : {
"name" : "createPickupResponseDTO"
}
},
"DLCreatePickupRequestDTO" : {
"required" : [ "creationParms", "pickup", "processParms" ],
"type" : "object",
"properties" : {
"clientSystemId" : {
"type" : "string",
"description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "creationParms" : { "$ref" : "#/components/schemas/DLPickupCreationParmsDTO" }, "pickup" : { "$ref" : "#/components/schemas/DLPickupRequestDataDTO" }, "processParms" : { "$ref" : "#/components/schemas/DLPickupProcessParmsDTO" } }, "description" : "Request DTO for the processPickup business facade method", "xml" : { "name" : "createPickupRequestDTO" } }, "DLPickupRequestDataDTO" : { "required" : [ "referenceNumber1", "shipments", "shippingDate", "shippingPt", "transactionId" ], "type" : "object", "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" }, "carrierIdentCode" : { "type" : "string", "description" : "Carrier of the pickup.length=20
" }, "shippingDate" : { "type" : "string", "description" : "Shipping date in the format 'yyyy-MM-dd'.length=10
" }, "shippingPt" : { "$ref" : "#/components/schemas/DLPartyDTO" }, "shippingPtContact" : { "$ref" : "#/components/schemas/DLPersonDTO" }, "shipments" : { "type" : "array", "description" : "The shipments contained in the pickup. All shipments must belong to the pickup's carrier (specified in fieldcarrierIdentCode
) and the pickup's shipping point (specified in field shippingPoint
).",
"items" : {
"$ref" : "#/components/schemas/DLShipmentReferenceDTO"
}
}
},
"description" : "DTO for pickup data."
},
"DLUpdateCustomsDataResponseDTO" : {
"type" : "object",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : "Response DTO for the updateCustomsData business facade method", "xml" : { "name" : "updateCustomsDataResponseDTO" } }, "DLReferenceTextUCDDTO" : { "type" : "object", "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
" } }, "description" : "DTO for reference numbers and texts of a certain (predefined) type." }, "DLShipmentItemReferenceUCDDTO" : { "type" : "object", "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
" } }, "description" : "DTO for uniquely identifying an item within a shipment." }, "DLUpdateCustomsDataRequestDTO" : { "required" : [ "shipmentReference" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "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: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" }, "goodsValue" : { "$ref" : "#/components/schemas/AmountOfMoneyDTO" }, "additionalValues" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" } }, "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." }, "DLCarrierListItemDTO" : { "type" : "object", "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
" } }, "description" : "Minimum carrier info to use in lists." }, "DLGetAllCarriersResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "carriers" : { "type" : "array", "description" : "The list of available carriers.", "items" : { "$ref" : "#/components/schemas/DLCarrierListItemDTO" } } }, "description" : "Response DTO containing a list of available carrier for a client.", "xml" : { "name" : "getAllCarriersResponseDTO" } }, "DLGetAllCarriersRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } } }, "description" : "Request DTO to retrieve the codes and names of all available carriers for a client.", "xml" : { "name" : "getAllCarriersRequestDTO" } }, "DLSyncShipmentsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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", "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\"]" } }, "ageInDays" : { "type" : "integer", "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
", "format" : "int32" }, "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'." } }, "description" : "Request DTO for shipment synchronization.", "xml" : { "name" : "syncShipmentsRequestDTO" } }, "DLCarrierBusinessDivisionDTO" : { "type" : "object", "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" } } }, "description" : "Response information about the supported business Divisions from a carrier" }, "DLCarrierDespatchCountryDTO" : { "type" : "object", "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
" } }, "description" : "Response information about the supported by a countries from a carrier" }, "DLCarrierPortfolioNameDTO" : { "type" : "object", "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 {@link #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." } }, "description" : "DTO for the code and name of a carrier." }, "DLGetCarrierPortfolioNamesResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "carrierNames" : { "type" : "array", "description" : "Codes and names of all available carriers.", "items" : { "$ref" : "#/components/schemas/DLCarrierPortfolioNameDTO" } } }, "description" : "Response DTO containing the codes and names of all available carriers.", "xml" : { "name" : "getCarrierPortfolioNamesResponseDTO" } }, "DLGetCarrierPortfolioNamesRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "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", "description" : "List of additional infos which are requested for all carriers. If no list is supplied, no additional infos will be returned." } } }, "description" : "Request DTO to retrieve the codes and names of all available carriers.", "xml" : { "name" : "getCarrierPortfolioNamesRequestDTO" } }, "DLAdditionalValueDTO" : { "type" : "object", "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
" } }, "description" : "Information about an additional value defined for a carrier." }, "DLCarrierExtendedInfosDTO" : { "type" : "object", "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" : "array", "description" : "The WebLogo of the carrier from the Carrier-website. Possible values are:
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" } } }, "description" : "Information about an additional info text a carrier offers." }, "DLCarrierNetworkDTO" : { "type" : "object", "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" } } }, "description" : "Response information about the networks in which the carrier is involved." }, "DLGetCarrierPropertiesResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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 {@link #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"
},
"isDespatchCountriesGlobal" : {
"type" : "boolean",
"description" : "Indicates if the carrier operates globally. Therefore the list of despatchCountries contains all countries."
}
},
"description" : "Response DTO containing the properties of a specific carrier.",
"xml" : {
"name" : "getCarrierPropertiesResponseDTO"
}
},
"DLServiceDTO" : {
"type" : "object",
"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." } }, "description" : "Information about a service a carrier offers." }, "DLGetCarrierPropertiesRequestDTO" : { "required" : [ "carrierIdentCode" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "carrierIdentCode" : { "type" : "string", "description" : "Code uniquely referencing the requested carrier.length=20
" } }, "description" : "Request DTO to retrieve various properties for a specific carrier.", "xml" : { "name" : "getCarrierPropertiesRequestDTO" } }, "DLAddShipmentAttachmentsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : " Response DTO for the addShipmentAttachments business facade method", "xml" : { "name" : "addShipmentAttachmentsResponseDTO" } }, "DLAddShipmentAttachmentsRequestDTO" : { "required" : [ "shipmentReference" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "shipmentReference" : { "$ref" : "#/components/schemas/DLShipmentReferenceDTO" }, "mode" : { "type" : "string", "description" : "Manages how the system should react if an attachment already exists. If empty {@link #MODE_ADD} will be used.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" : "array", "description" : "Attachment data/content.", "items" : { "type" : "string", "description" : "Attachment data/content.", "format" : "byte" } }, "contentType" : { "type" : "string", "description" : "Attachment type.Possible values:
length=30
" } }, "description" : "DTO to hold attachment data." }, "DLGetCarrierPortfolioDetailsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "carriers" : { "type" : "array", "description" : "The list of all requested carriers with their detail information.", "items" : { "$ref" : "#/components/schemas/DLGetCarrierPropertiesResponseDTO" } } }, "description" : "Response DTO for all available carriers with their detail information.", "xml" : { "name" : "getCarrierPortfolioDetailsResponseDTO" } }, "DLGetCarrierPortfolioDetailsRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "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", "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." } } }, "description" : "Response DTO for carrier properties for all carriers", "xml" : { "name" : "getCarrierPortfolioDetailsRequestDTO" } }, "AFExecuteProcessParmsDTO" : { "type" : "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" } }, "description" : "Parameters of application facade 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." }, "AFShellExecuteParmsDTO" : { "type" : "object", "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" : "array", "description" : "This is the contents that has to be written to the file", "items" : { "type" : "string", "description" : "This is the contents that has to be written to the file", "format" : "byte" } } }, "description" : "Parameters of application facade invocation 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" }, "ApplicationFacadeDTO" : { "type" : "object", "properties" : { "sessionid" : { "type" : "string", "description" : "The session id of the application facade which may be used as a parameter to read results from the application facade. (Currently not supported.)" }, "httpUrl" : { "type" : "string", "description" : "Used when the application facade is to be opened in a browser An http:// or https:// URL which is a (Casabac-) web side to display the application facade." }, "urlCloseToken" : { "type" : "string", "description" : "URL token to check on the remote system (for example SAP) if the browser was closed." }, "executeProcess" : { "$ref" : "#/components/schemas/AFExecuteProcessParmsDTO" }, "shellExecute" : { "$ref" : "#/components/schemas/AFShellExecuteParmsDTO" } }, "description" : "A data transfer object which describes an application facade. 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 includetrue
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" : "Customized styleVariant (one of {@link ProductStyleVariant} for application facade.",
"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.: CAPTAIN_CASA_THIN or 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 - only available when technology is set to CAPTAIN_CASA_* -"
},
"productShortName" : {
"type" : "string",
"description" : "Optional field, which may be set if productShortName differs from standard product name"
},
"preferredWidth" : {
"type" : "integer",
"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",
"format" : "int32"
},
"preferredHeight" : {
"type" : "integer",
"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",
"format" : "int32"
},
"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"
}
},
"description" : "A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()"
},
"LogonResponse" : {
"type" : "object",
"properties" : {
"token" : {
"type" : "string"
},
"userName" : {
"type" : "string"
},
"client" : {
"type" : "string"
},
"roles" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"error" : {
"type" : "string"
}
}
},
"AdditionalUserInfo" : {
"type" : "object",
"properties" : {
"userName" : {
"type" : "string"
},
"firstName" : {
"type" : "string"
},
"lastName" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"userEnvironment" : {
"type" : "string"
}
}
},
"UserClientLoginDTO" : {
"type" : "object",
"properties" : {
"userName" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"clientName" : {
"type" : "string"
},
"localeName" : {
"type" : "string"
},
"createUser" : {
"type" : "boolean"
},
"loginContext" : {
"$ref" : "#/components/schemas/XNSGLoginDiagnosticContext"
},
"isExternalLogon" : {
"type" : "boolean"
},
"isApplicationFacadeAuthentication" : {
"type" : "boolean"
},
"additionalInfo" : {
"$ref" : "#/components/schemas/AdditionalUserInfo"
}
}
},
"XNSGLoginDiagnosticContext" : {
"type" : "object",
"properties" : {
"loginType" : {
"type" : "string",
"enum" : [ "GUI", "AF", "BF", "REST", "GRAPQHL", "INTERNAL", "GUI_REDIRECT_GET_WEBTOKEN_XNSG", "ATC", "UNKNOWN" ]
},
"credentialType" : {
"type" : "string",
"enum" : [ "ADMIN", "DBUSER", "LDAP", "RFC", "ENGINE", "LOCAL_ACCESS", "ANONYMOUS", "WEBTOKEN_XNSG", "WEBTOKEN_EXTERNAL_DBUSER", "WEBTOKEN_EXTERNAL", "HTTP_BASIC", "HTTP_BEARER", "K8S_SESSION_RESTORE", "UNKNOWN" ]
},
"originalCredentialType" : {
"type" : "string",
"enum" : [ "ADMIN", "DBUSER", "LDAP", "RFC", "ENGINE", "LOCAL_ACCESS", "ANONYMOUS", "WEBTOKEN_XNSG", "WEBTOKEN_EXTERNAL_DBUSER", "WEBTOKEN_EXTERNAL", "HTTP_BASIC", "HTTP_BEARER", "K8S_SESSION_RESTORE", "UNKNOWN" ]
},
"language" : {
"type" : "string"
},
"wrongPasswordCount" : {
"type" : "integer",
"format" : "int32"
},
"locked" : {
"type" : "boolean"
},
"errorMsg" : {
"type" : "string"
},
"tokenInfo" : {
"type" : "string"
},
"fromRoleCache" : {
"type" : "boolean"
}
}
},
"ExternalTMStatusResponseDTO" : {
"type" : "object",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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" } }, "description" : "Response DTO for the {@link IExternalTelemetryBF#getTelemetryStatus} method." }, "ExternalTMIdentificationRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "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" } }, "description" : "Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status." }, "DateAndZoneDTO" : { "type" : "object", "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
" } }, "description" : "Date and timezone." }, "ExternalTMResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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" }, "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)" } }, "description" : "Response DTO for all calls to the {@link IExternalTelemetryBF} interface." }, "ExternalTMRDateEntryDTO" : { "type" : "object", "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" : "telemetry report entry for date values" }, "ExternalTMRDoubleEntryDTO" : { "type" : "object", "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", "description" : "data for the entry to report", "format" : "double" } }, "description" : "telemetry report entry for string double" }, "ExternalTMRIntegerEntryDTO" : { "type" : "object", "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", "description" : "data for the entry to report", "format" : "int32" } }, "description" : "telemetry report entry for integer values" }, "ExternalTMRLongEntryDTO" : { "type" : "object", "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", "description" : "data for the entry to report", "format" : "int64" } }, "description" : "telemetry report entry for long values" }, "ExternalTMRStringArrayEntryDTO" : { "type" : "object", "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", "description" : "data for the entry to report" } } }, "description" : "telemetry report entry for string array values" }, "ExternalTMRStringEntryDTO" : { "type" : "object", "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" } }, "description" : "telemetry report entry for string values" }, "ExternalTMReportRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "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" }, "updateComment" : { "type" : "string", "description" : "comment for the current filing" } }, "description" : "Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status." }, "ExternalTelemetryReportDTO" : { "type" : "object", "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" } } }, "description" : "report dto to ship the telemetry data to an XNSG engine" }, "SendMailResultDTO" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "true on success" }, "errorMessage" : { "type" : "string", "description" : "error-message, if an error occured" } }, "description" : "Contains the result of the sendMail method." }, "SendMailAttachmentParmDTO" : { "type" : "object", "properties" : { "fileContent" : { "type" : "array", "description" : "Content of the attachment file", "items" : { "type" : "string", "description" : "Content of the attachment file", "format" : "byte" } }, "fileContentType" : { "type" : "string", "description" : "Content-type of the attachment (e.g. \"application/octet-stream\")" }, "fileName" : { "type" : "string", "description" : "Name of the attachment file" } }, "description" : "Contains an attachment for an email." }, "SendMailParmDTO" : { "type" : "object", "properties" : { "receivers" : { "type" : "array", "description" : "receivers of the mail", "items" : { "type" : "string", "description" : "receivers of the mail" } }, "replytos" : { "type" : "array", "description" : "reply to addresses of the mail", "items" : { "type" : "string", "description" : "reply to addresses of the mail" } }, "ccs" : { "type" : "array", "description" : "ccs of the mail", "items" : { "type" : "string", "description" : "ccs of the mail" } }, "bccs" : { "type" : "array", "description" : "bccs of the mail", "items" : { "type" : "string", "description" : "bccs of the mail" } }, "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" } } }, "description" : "Parameter necessary for sending a mail" }, "DownloadFileResponseDTO" : { "type" : "object", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" }, "downloadFile" : { "$ref" : "#/components/schemas/FileDTO" } }, "description" : "Contains the result for a download file request" }, "FileDTO" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of a file" }, "size" : { "type" : "integer", "description" : "Size of a file", "format" : "int64" }, "content" : { "type" : "object", "properties" : { "dataSource" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "inputStream" : { "type" : "object" }, "contentType" : { "type" : "string" }, "outputStream" : { "type" : "object" } } }, "name" : { "type" : "string" }, "content" : { "type" : "object" }, "inputStream" : { "type" : "object" }, "contentType" : { "type" : "string" }, "outputStream" : { "type" : "object" }, "transferDataFlavors" : { "type" : "array", "items" : { "type" : "object", "properties" : { "mimeType" : { "type" : "string" }, "humanPresentableName" : { "type" : "string" }, "primaryType" : { "type" : "string" }, "representationClassReader" : { "type" : "boolean" }, "representationClassCharBuffer" : { "type" : "boolean" }, "representationClassInputStream" : { "type" : "boolean" }, "representationClassByteBuffer" : { "type" : "boolean" }, "subType" : { "type" : "string" }, "mimeTypeSerializedObject" : { "type" : "boolean" }, "defaultRepresentationClassAsString" : { "type" : "string" }, "representationClassSerializable" : { "type" : "boolean" }, "representationClassRemote" : { "type" : "boolean" }, "flavorSerializedObjectType" : { "type" : "boolean" }, "flavorRemoteObjectType" : { "type" : "boolean" }, "flavorJavaFileListType" : { "type" : "boolean" }, "flavorTextType" : { "type" : "boolean" } } } }, "preferredCommands" : { "type" : "array", "items" : { "type" : "object", "properties" : { "commandClass" : { "type" : "string" }, "commandName" : { "type" : "string" } } } }, "commandMap" : { "type" : "object", "properties" : { "mimeTypes" : { "type" : "array", "items" : { "type" : "string" } } }, "writeOnly" : true }, "allCommands" : { "type" : "array", "items" : { "type" : "object", "properties" : { "commandClass" : { "type" : "string" }, "commandName" : { "type" : "string" } } } } }, "description" : "The content of a file" }, "checksum" : { "type" : "array", "description" : "MD5-hash of a file", "items" : { "type" : "string", "description" : "MD5-hash of a file", "format" : "byte" } }, "creationTimeMillis" : { "type" : "integer", "description" : "file attribute creationTime as FileTime millis", "format" : "int64" }, "lastModifiedTimeMillis" : { "type" : "integer", "description" : "file attribute lastModifiedTime as FileTime millis", "format" : "int64" }, "lastAccessTimeMillis" : { "type" : "integer", "description" : "file attribute lastAccessTime as FileTime millis", "format" : "int64" } }, "description" : "Data Transfer Object for a file." }, "DownloadFileRequestDTO" : { "type" : "object", "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" }, "parameters" : { "type" : "array", "description" : "A list of generic parameters", "items" : { "$ref" : "#/components/schemas/TransferFileParameterDTO" } } }, "description" : "Contains information on how to select a file for transferring" }, "SimpleFileDTO" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of a file" }, "size" : { "type" : "integer", "description" : "Size of a file", "format" : "int64" } }, "description" : "Meta-data for a transfer file" }, "TransferFileParameterDTO" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "Key of the parameter" }, "value" : { "type" : "string", "description" : "Value of the parameter" } }, "description" : "A generic parameter for use-case specific information" }, "ClientDTO" : { "type" : "object", "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" } }, "description" : "DTO representing an XNSG Client." }, "ProductInfoDTO" : { "type" : "object", "properties" : { "productName" : { "type" : "string", "description" : "This is the name of the product that is deployed to this server." }, "productVersion" : { "$ref" : "#/components/schemas/VersionInfoDTO" }, "solutions" : { "type" : "array", "description" : "This contains a list of names of all solutions, which are deployed to the server.", "items" : { "type" : "string", "description" : "This contains a list of names of all solutions, which are deployed to the server." } }, "productNameInternal" : { "type" : "string", "description" : "This is the name of the product that is deployed to this server in its original manner." } }, "description" : "This class holds various information items of the server which serves this request." }, "VersionInfoDTO" : { "type" : "object", "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", "description" : "The version of the solution/product as numeric value. The main version is the first entry in the integer array.", "format" : "int32" } } }, "description" : "This class holds version information about a solution or product in a server." }, "RoleInfoDTO" : { "type" : "object", "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", "description" : "the implied roles" } } }, "description" : "dto for roles" }, "CreateClientResponseDTO" : { "type" : "object", "properties" : { "resultState" : { "type" : "string", "description" : "result status" } }, "description" : "encapsulates the response parameters" }, "CreateClientRequestDTO" : { "type" : "object", "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" } }, "description" : "encapsulates the request parameters" }, "AnnounceStopResultDTO" : { "type" : "object", "description" : "the result of the announce stop business facade" }, "AnnounceStopParmDTO" : { "type" : "object", "properties" : { "utcStopAtYYYYMMDDHHMMSS" : { "type" : "string", "description" : "the server will stop at this date/time" }, "expectedDowntimeMinutes" : { "type" : "integer", "description" : "the server will be down for the period in minutes", "format" : "int32" }, "preventedLogonMinutes" : { "type" : "integer", "description" : "The server will prevent new logons for this number of minutes before the date specified for the stop. (See {@link #utcStopAtYYYYMMDDHHMMSS}).", "format" : "int32" } }, "description" : "parameter necessary to announce a stop of the server" }, "RuntimeInfoDTO" : { "type" : "object", "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", "description" : "Date of last installation/update", "format" : "date-time" }, "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", "description" : "Total count of active sessions (summarized over all GUI-frameworks).", "format" : "int32" }, "additionalInfo" : { "type" : "string", "description" : "Additional runtime info." }, "productName" : { "type" : "string", "description" : "Product name." }, "authenticationStrategy" : { "type" : "string", "description" : "AuthenticationStrategy name." } }, "description" : "This class holds various runtime information items of the server which serves this request." }, "CancelAnnounceStopResultDTO" : { "type" : "object", "description" : "Contains the result information of the cancel announce stop bf" }, "CancelAnnounceStopParmDTO" : { "type" : "object", "description" : "parameter necessary to cancel an announced stop" }, "TableUpdateStateResultDTO" : { "type" : "object", "properties" : { "percentage" : { "type" : "integer", "description" : "How far has the table update went", "format" : "int32" }, "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" } }, "description" : "Contains the result information of the get table update state bf" }, "StartTableUpdateResultDTO" : { "type" : "object", "description" : "Contains the result information of the start table update bf" }, "StartTableUpdateParmDTO" : { "type" : "object", "description" : "parameter necessary for the table update" }, "SystemSearchResultDTO" : { "type" : "object", "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", "description" : "relevance of the result; an indication (in percent, ranging from 0 .. 100) of how much the result matches the query", "format" : "int32" }, "depth" : { "type" : "integer", "description" : "an integer >= 0 describing the hierarchical level of the result; it can be used to format the textual output", "format" : "int32" } }, "description" : "DTO contained in the result array of systemSearch function" }, "SystemSearchParameterDTO" : { "type" : "object", "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" } }, "description" : "DTO used as argument to systemSearch function" }, "UploadSettingsResponseDTO" : { "type" : "object", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" }, "maxFileSize" : { "type" : "integer", "description" : "maximum size of uploadable files", "format" : "int64" } }, "description" : "retrieves the server settings for uploading files via SFT interface" }, "UploadSettingsRequestDTO" : { "type" : "object", "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." } }, "description" : "retrieves the server settings for uploading files via SFT interface" }, "AcknowledgeFileResponseDTO" : { "type" : "object", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" } }, "description" : "Contains the result for an acknowledge file request." }, "AcknowledgeFileRequestDTO" : { "type" : "object", "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" : "Contains information about the result of a file transfer" }, "DuplicateClientResponseDTO" : { "type" : "object", "properties" : { "processId" : { "type" : "string", "description" : "the process id" } }, "description" : "Response for duplicateClient() call" }, "DuplicateClientRequestDTO" : { "type" : "object", "properties" : { "clientToDuplicateIdentCode" : { "type" : "string", "description" : "The id of the client that should be duplicated" }, "newClientIdentCode" : { "type" : "string", "description" : "The identcode of new client created by the duplication" }, "newClientDescription" : { "type" : "string", "description" : "The description of new client created by the duplication" }, "adminUiUsers" : { "type" : "array", "description" : "The clientadmin users that should be created for the new client", "items" : { "$ref" : "#/components/schemas/DuplicateClientUserDTO" } }, "adminBfUsers" : { "type" : "array", "description" : "The clientadmin bf users that should be created for the new client", "items" : { "$ref" : "#/components/schemas/DuplicateClientUserDTO" } }, "newDebtorNumber" : { "type" : "string", "description" : "The debtor number (Kundennummer) of a client" } }, "description" : "DTO with the configuration for duplication of a client" }, "DuplicateClientUserDTO" : { "type" : "object", "properties" : { "userName" : { "type" : "string", "description" : "user name" }, "password" : { "type" : "string", "description" : "password" }, "changePwdAfterFirstLogin" : { "type" : "boolean", "description" : "change password after first login" } }, "description" : "DTO for creating a user when duplicating a client." }, "UploadFileResponseDTO" : { "type" : "object", "properties" : { "errorCode" : { "type" : "string", "description" : "A short error code." }, "errorMessage" : { "type" : "string", "description" : "A human-readable error message" } }, "description" : "Contains the result for a upload file request." }, "UploadFileMultiPartRequestDTO" : { "type" : "object", "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", "description" : "Size of a file", "format" : "int64" }, "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", "description" : "file attribute creationTime as FileTime millis", "format" : "int64" }, "lastModifiedTimeMillis" : { "type" : "integer", "description" : "file attribute lastModifiedTime as FileTime millis", "format" : "int64" }, "lastAccessTimeMillis" : { "type" : "integer", "description" : "file attribute lastAccessTime as FileTime millis", "format" : "int64" } }, "description" : "Contains information on how a transmitted file should be processed" }, "MonitoringDataProviderDTO" : { "type" : "object", "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." } }, "description" : "Data Transfer Object for monitoring provider" }, "ChangeAdminPasswordResultDTO" : { "type" : "object", "properties" : { "success" : { "type" : "boolean", "description" : "false, if old password was wrong" } }, "description" : "Contains the result information of the change admin password bf" }, "ChangeAdminPasswordParmDTO" : { "type" : "object", "properties" : { "oldPassword" : { "type" : "string", "description" : "the old admin password" }, "newPassword" : { "type" : "string", "description" : "the new admin password" } }, "description" : "This class contains the old and the new admin password" }, "GenerateClientIdentCodeRequestDTO" : { "type" : "object", "properties" : { "clientIdentCode" : { "type" : "string", "description" : "client ident code should be generated" }, "debtorNumber" : { "type" : "string", "description" : "debtor number" } }, "description" : "encapsulates the request parameters" }, "TableUpdateStateParmDTO" : { "type" : "object", "description" : "the parameter necessary to ask the server for the current state of the table update" }, "StartScriptExecutionResultDTO" : { "type" : "object", "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" } }, "description" : "result of start script execution" }, "StartScriptExecutionParmDTO" : { "type" : "object", "properties" : { "scriptContent" : { "type" : "string", "description" : "string value represents the content of script" }, "maxRows" : { "type" : "integer", "description" : "max. number of rows included in result of script execution", "format" : "int32" }, "scriptType" : { "type" : "string", "description" : "type of script, sql, oql and java script are supported" } }, "description" : "parameters for start script execution" }, "ScriptExecutionRowDTO" : { "type" : "object", "properties" : { "columns" : { "type" : "array", "description" : "columns of a row", "items" : { "type" : "string", "description" : "columns of a row" } }, "dummy" : { "type" : "string", "description" : "dummy" } }, "description" : "This dto contains the data of a single line in script result" }, "ScriptExecutionStateResultDTO" : { "type" : "object", "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" } }, "description" : "Contains the result information of the script execution bf" }, "ScriptExecutionStateParmDTO" : { "type" : "object", "properties" : { "uuid" : { "type" : "string", "description" : "uuid assigned to the BF call" } }, "description" : "parameters necessary to ask the server for the current state of the script execution" }, "DuplicateClientProgressResponseDTO" : { "type" : "object", "properties" : { "progress" : { "type" : "integer", "description" : "The progress of the duplication from 0-100.", "format" : "int32" }, "description" : { "type" : "string", "description" : "The description of the current stage of the duplication." }, "errors" : { "type" : "array", "description" : "Errors that happened during the duplication process.", "items" : { "type" : "string", "description" : "Errors that happened during the duplication process." } } }, "description" : "Contains information about the current progress of a client duplication." }, "DLFilesRefsResponseDTO" : { "type" : "object", "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" } } }, "description" : "Contains the result for a request to get the number of files available for download" }, "DLFilesRefsRequestDTO" : { "type" : "object", "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" } } }, "description" : "Contains information on how to select files for transferring" }, "ClientFeatureDTO" : { "required" : [ "active", "key", "name", "readOnly" ], "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "key of the feature", "example" : "LICENSE_MODULE.I_TEST" }, "active" : { "type" : "boolean", "description" : "active state of the feature", "example" : true }, "name" : { "type" : "string", "description" : "name of the feature", "example" : "Test" }, "description" : { "type" : "string", "description" : "description of the feature", "example" : "Test license module" }, "readOnly" : { "type" : "boolean", "description" : "read only feature", "example" : false } }, "description" : "client feature" }, "GetClientFeaturesResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "clientFeatures" : { "type" : "array", "description" : "list of client features", "items" : { "$ref" : "#/components/schemas/ClientFeatureDTO" } } }, "description" : "get client feature DTOs" }, "GetClientFeaturesRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } } }, "description" : "get client features" }, "SetClientFeaturesResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : "client feature update response" }, "ClientFeatureSetDTO" : { "required" : [ "active", "key" ], "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "key of the feature", "example" : "LICENSE_MODULE.I_TEST" }, "active" : { "type" : "boolean", "description" : "active state of the feature", "example" : true } }, "description" : "client feature" }, "SetClientFeaturesRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "clientFeatures" : { "type" : "array", "description" : "list of client features to update", "items" : { "$ref" : "#/components/schemas/ClientFeatureSetDTO" } } }, "description" : "client features to update" }, "CreateClientFromTemplateResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "processId" : { "type" : "string", "description" : "The processId that can be used to query the process' status." } }, "description" : "Result DTO for starting a client duplication process." }, "CreateClientFromTemplateRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "newClientIdentCode" : { "type" : "string", "description" : "The identcode of the new client created by this duplication.clientIdentCode
"
},
"newClientDescription" : {
"type" : "string",
"description" : "The description of the new client created by this duplication."
},
"newDebtorNumber" : {
"type" : "string",
"description" : "The debtor number (Kundennummer) of the client."
},
"notificationEmailAddress" : {
"type" : "string",
"description" : "Primary email address to send important notifications to, e.g. user tips."
},
"adminBfUsers" : {
"type" : "array",
"description" : "The clientadmin bf users that should be created for the new client.",
"items" : {
"$ref" : "#/components/schemas/DuplicateClientUserDTO"
}
}
},
"description" : "Request parameters for creating a client by duplicating another."
},
"GetCreateClientFromTemplateStatusResponseDTO" : {
"type" : "object",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "progress" : { "maximum" : 100, "minimum" : 0, "type" : "integer", "description" : "The progress of the duplication from0
to 100
.100
means the duplication has finished completely.-1
means the duplication failed. For error details see messages
",
"format" : "int32"
},
"description" : {
"type" : "string",
"description" : "The description of the current stage of the duplication."
}
},
"description" : "Status of an ongoing or completed client duplication process started by {@link IInternalProvisioningBF#createClientFromTemplate(CreateClientFromTemplateRequestDTO)}"
},
"GetCreateClientFromTemplateStatusRequestDTO" : {
"type" : "object",
"properties" : {
"clientSystemId" : {
"type" : "string",
"description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "processId" : { "type" : "string", "description" : "The processId obtained byIInternalProvisioningBF#createClientFromTemplate
."
}
},
"description" : "Request parameters for querying a duplication process' status."
},
"ClientRolesDTO" : {
"type" : "object",
"properties" : {
"client" : {
"type" : "string",
"description" : "Client identCode"
},
"roleInfos" : {
"type" : "array",
"description" : "The role informations.",
"items" : {
"$ref" : "#/components/schemas/RoleInfoDTO"
}
}
},
"description" : "Response DTO for listing client specific roles in GetRolesResponseDTO."
},
"GetRolesResponseDTO" : {
"type" : "object",
"properties" : {
"hasErrors" : {
"type" : "boolean",
"description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "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" } } }, "description" : "DTO for GetRoles response", "xml" : { "name" : "getRolesResponseDTO" } }, "SyncEventDTO" : { "type" : "object", "properties" : { "businessObjectType" : { "maxLength" : 20, "type" : "string", "description" : "Code which identifies the business object type the event belongs to." }, "businessObjectQualifier" : { "maxLength" : 35, "type" : "string", "description" : "Optional qualifier which can be used to specify the object in a more detailed way." }, "businessObjectId" : { "maxLength" : 36, "type" : "string", "description" : "Unique ID of the business object.This ID is usually needed for subsequent calls, e.g. getBusinessObject(...)
" }, "eventType" : { "maxLength" : 20, "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.
" }, "eventDate" : { "$ref" : "#/components/schemas/DateAndZoneDTO" }, "parameter" : { "$ref" : "#/components/schemas/GenericDataRecordDTO" } }, "description" : "DTO to hold data of one synchronized event." }, "SyncEventsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for delta-transmission.Use this syncId in subsequent calls to {@link ISyncBF#synchronizeEvents(SyncEventsRequestDTO)} to enabledelta-transmission of changes.
However, this syncId may be null if no events are found an the field {@link SyncEventsResponseDTO#events} is an empty array. In this case usethe last NOT NULL syncId returned in this field for subsequent calls to {@link ISyncBF#synchronizeEvents(SyncEventsRequestDTO)}.
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 {@link ISyncBF#synchronizeEvents(SyncEventsRequestDTO)}, 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 {@link SyncEventsRequestDTO#returnTotalCount} is set." }, "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 {@link ISyncBF#synchronizeEvents(SyncEventsRequestDTO)}, always passing the last returned {@link SyncEventsResponseDTO#syncId} in the next callwith {@link SyncEventsRequestDTO#syncId}.
", "items" : { "$ref" : "#/components/schemas/SyncEventDTO" } } }, "description" : "Response DTO for synchronizing events." }, "SyncEventsRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for delta-transmission. In calls to {@link ISyncBF#synchronizeEvents(SyncEventsRequestDTO)}:
Pass this field with the value returned in {@link SyncEventsResponseDTO#syncId} with the last call to{@link ISyncBF#synchronizeEvents(SyncEventsRequestDTO)}.
For initializing of delta-transmissions pass simply null.
In calls to {@link ISyncBF#getNotAcknowledgedEvents(SyncEventsRequestDTO)} 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.
", "format" : "int32" }, "blockSize" : { "type" : "integer", "description" : "For defining the block size. Can be null. If empty the default block size of 100 is used.", "format" : "int32" }, "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.
" } }, "description" : "Request DTO for synchronizing events." }, "AcknowledgeEventsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } } }, "description" : "Response DTO for acknowledging events." }, "AcknowledgeEventsRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "syncId" : { "type" : "string", "description" : "Synchronization ID for acknowledge.Pass this field with the value returned in {@link SyncEventsResponseDTO#syncId} with the last call to{@link ISyncBF#getNotAcknowledgedEvents(SyncEventsRequestDTO)}.
length=20
" }, "businessObjectType" : { "type" : "string", "description" : "Should be the same value, which was passed with {@link SyncEventsRequestDTO#businessObjectType} with the last call to{@link ISyncBF#getNotAcknowledgedEvents(SyncEventsRequestDTO)}. length=20" } }, "description" : "Request DTO for acknowledging events." }, "SubscribePartnerSystemResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "syncPartnerSystem" : { "$ref" : "#/components/schemas/SyncPartnerSystemDTO" } }, "description" : "Response parameter of a partner system subscription to sync events." }, "SyncPartnerSystemDTO" : { "required" : [ "businessObjectType", "clientSystemId" ], "type" : "object", "properties" : { "clientSystemId" : { "maxLength" : 20, "type" : "string", "description" : "Id of the sending client system (e.g. Installation ID of the sending host or ERP system)." }, "businessObjectType" : { "maxLength" : 20, "type" : "string", "description" : "Code which identifies the subscribed business object type." }, "description" : { "maxLength" : 250, "type" : "string", "description" : "Description of the subscription (optional)." } }, "description" : "Identification and other data of a single partner system subscription." }, "SubscribePartnerSystemRequestDTO" : { "required" : [ "businessObjectType" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "businessObjectType" : { "maxLength" : 20, "type" : "string", "description" : "Code which identifies the subscribed business object type." }, "description" : { "maxLength" : 250, "type" : "string", "description" : "Optional description of the subscription." } }, "description" : "Request parameter to subscribe a partner system to sync events." }, "GetPartnerSystemSubscriptionsResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "syncPartnerSystems" : { "type" : "array", "description" : "All or filtered registered partner system subscriptions.", "items" : { "$ref" : "#/components/schemas/SyncPartnerSystemDTO" } } }, "description" : "Response parameter with fetched partner system subscriptions to sync events." }, "GetPartnerSystemSubscriptionsRequestDTO" : { "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "businessObjectType" : { "maxLength" : 20, "type" : "string", "description" : "Optional. Filter for code which identifies the subscribed business object type." } }, "description" : "Request parameter to fetch all or filtered partner system subscriptions to sync events." }, "UnsubscribePartnerSystemResponseDTO" : { "type" : "object", "properties" : { "hasErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
An error usually means that the request could not be performed.
Error details are provided in the messages[] array.
", "example" : false }, "hasOnlyRetryableErrors" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "hasWarnings" : { "type" : "boolean", "description" : "True, if there are any error messages.
Error details are provided in the messages[] array.
", "example" : true }, "messages" : { "type" : "array", "description" : "Error or warning messages at the request level.
There may be additional messages[] arrays at lower data levels as specified in the documentation.
", "items" : { "$ref" : "#/components/schemas/ResponseMessageDTO" } }, "syncPartnerSystem" : { "$ref" : "#/components/schemas/SyncPartnerSystemDTO" } }, "description" : "Response parameter of a partner system unsubscription from sync events." }, "UnsubscribePartnerSystemRequestDTO" : { "required" : [ "businessObjectType" ], "type" : "object", "properties" : { "clientSystemId" : { "type" : "string", "description" : "Id of the sending client system.
e.g. Installation ID of the sending host or ERP system.
Maximum length: 20
", "example" : "TEST_ID" }, "clientIdentCode" : { "type" : "string", "description" : "Client identification code.
Maximum length: 10
", "example" : "APITEST" }, "userName" : { "type" : "string", "description" : "User who initiated the request from the client system.
If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.
If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.
Actual authentication is handled separately via the request's headers, so no password is required in the request's data.
", "example" : "API_TEST" }, "resultLanguageIsoCodes" : { "type" : "array", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : [ "en", "de" ], "items" : { "type" : "string", "description" : "2-letter ISO codes of the languages in which texts will be returned.
English ('en') and German ('de') are typically supported by default. Other languages may be supported.
Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.
", "example" : "[\"en\",\"de\"]" } }, "businessObjectType" : { "maxLength" : 20, "type" : "string", "description" : "Code which identifies the subscribed business object type." } }, "description" : "Request parameter to unsubscribe a partner system from sync events." } }, "securitySchemes" : { "SWAGGER_AUTH_KEY" : { "type" : "apiKey", "name" : "X-XNSG_WEB_TOKEN", "in" : "header" }, "BASIC_AUTH" : { "type" : "http", "scheme" : "basic" } } }, "x-proxy-enabled" : false }