AEB Product Classification API
Assigns and validates commodity/tariff classification for materials — HS and national tariff numbers, classification profiles, classification proposals and value templates — and serves the resulting customs content data to the customs and compliance products.
AEB Product Classification API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Trade Compliance, Product Classification, HS Codes, Tariff, and Customs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 131 operations across 117 paths, organized into 17 resource areas, and defines 268 schemas. It is described by OpenAPI 3.0.1, at version 4.0.
Requests are made against a single base URL, https://rz3.aeb.de/test2cl/rest.
131 operations
117 paths
268 schemas
7 DELETE46 GET5 PATCH61 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB Product Classification API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY).
It accepts HTTP basic authentication (BASIC_AUTH).
By default, every request must be authenticated.
Paths & Operations 131
Across 117 paths, the API surfaces 131 operations — 7 DELETE, 46 GET, 5 PATCH, 61 POST, 12 PUT. They span 17 resource areas, including CoreBFBean, FoundationAFBean, Logon, DataFeedBFBean, ExternalTelemetryBFBean, FoundationBFBean, RemoteAdminBFBean, SyncBFBean, and 9 more. Each is listed below with its method, path, parameters, and response codes.
CoreBFBean 12
API for the XNSGFoundation
POST
/CoreBFBean/checkBFFunctionExists
Can be called to know if a BF function exist.
POST
/CoreBFBean/echo
Returns the given echo parameter value.
POST
/CoreBFBean/echoUpperCase
Returns the given echo parameter value in uppercase.
GET
/CoreBFBean/getAllMonitoringValues
Returns all available monitoring values of the server.
GET
/CoreBFBean/getBuildForSolution
Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFBLDSOL\".
GET
/CoreBFBean/getMonitoringValue
Returns the current monitoring value for the given group and name.
GET
/CoreBFBean/getProductInfo
Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is \"/AEB/XNSGIFPRINFO\".
GET
/CoreBFBean/getRuntimeInfo
Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is \"/AEB/XNSGIF…
POST
/CoreBFBean/getRuntimeState
Return runtime state information about the server that is answering this request. This includes if the server is doing fine or not. Also included are the supported operations (bfs) for the installati…
GET
/CoreBFBean/getThreadDump
Generate Thread-Dump.
GET
/CoreBFBean/getVersionForSolution
Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFVERSOL\".
POST
/CoreBFBean/restartRFCServer
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 def…
FoundationAFBean 2
Business facade for the XNSGFoundation UI API
POST
/FoundationAFBean/releaseApplicationFacade
Release a UI API which is no longer needed. This call will save resources in the server, because the server must not wait for the timeout of the UI API session but can release it earlier. The method…
POST
/FoundationAFBean/workplace
Creates an UI API to be able to display the workplace. The difference of this method compared to the the method \"IFoundationBF.getWorkplaceURL()\" is the fact, that no logon mask will be dipsplayed…
Logon 2
Authentication handler for the XNSGFoundation
GET
/logon/authToken
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".
POST
/logon/user
Logon with classical procedure: user, client and password.
DataFeedBFBean 3
DataFeedBFBean
POST
/DataFeedBFBean/acknowledgePublishedDataFeedParts
Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
POST
/DataFeedBFBean/getPublishedDataFeedParts
Poll data about the next 10 published data feed parts. This data contains an id, which can be used to download the content of a part. To download the content, use the endpoint /DataFeedBFBean/dataFee…
ExternalTelemetryBFBean 3
API for sending telemetry data from a third party system.
POST
/ExternalTelemetryBFBean/getStatus
Returns the current status of the telemetry system. The external system id must be sent with the request.
GET
/ExternalTelemetryBFBean/status
Returns the current status of the telemetry system. The external system id must be sent with the request.
POST
/ExternalTelemetryBFBean/telemetryReport
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.
FoundationBFBean 31
REST endpoint for FoundationBF
POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
POST
/FoundationBFBean/client
Create a client.
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
POST
/FoundationBFBean/restartRFCServer
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 def…
POST
/FoundationBFBean/sendMail
Sends a mail.
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
RemoteAdminBFBean 2
Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR).
GET
/RemoteAdminBFBean/clientRoles/{clientId}
getRoles
GET
/RemoteAdminBFBean/roles
getRoles
SyncBFBean 6
API for synchronizing data asynchronous from an engine to a client system.
POST
/SyncBFBean/acknowledgeEvents
Acknowledge events got with {@link getNotAcknowledgedEvents(SyncEventsRequestDTO)}. Since XNSG 4.0, Nov. FP, 2017 .
POST
/SyncBFBean/getNotAcknowledgedEvents
Poll any not acknowledged events for the client system. This method does not require, that the client system fills {@link SyncEventsRequestDTOsyncId}. However, it requires, that a call to {@link ackn…
POST
/SyncBFBean/getPartnerSystemSubscriptions
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…
POST
/SyncBFBean/subscribePartnerSystem
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 fi…
POST
/SyncBFBean/synchronizeEvents
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 SyncEventsRequestDTOsyncId} See {@…
POST
/SyncBFBean/unsubscribePartnerSystem
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 manda…
ClassificationProposalBFBean 10
API for classification proposals.
PUT
/ClassificationProposalBFBean/certTemplate
Creates a new document template.
PUT
/ClassificationProposalBFBean/codeTemplate
Creates a new classification code template.
GET
/ClassificationProposalBFBean/certTemplate/{id}
Gets the data of a document template.
DELETE
/ClassificationProposalBFBean/certTemplate/{id}
Deletes an existing document template.
PATCH
/ClassificationProposalBFBean/certTemplate/{id}
Updates an existing document template.
GET
/ClassificationProposalBFBean/codeTemplate/{id}
Gets the data of a classification code template.
DELETE
/ClassificationProposalBFBean/codeTemplate/{id}
Creates a new classification code template.
PATCH
/ClassificationProposalBFBean/codeTemplate/{id}
Updates an existing classification code template.
POST
/ClassificationProposalBFBean/certTemplate/search
Searches for suitable document templates matching the criteria of the given search input.
POST
/ClassificationProposalBFBean/codeTemplate/search
Searches for suitable classification code templates matching the criteria of the given search input.
FTMaterialClassification20BFBean 12
API for the foreign trade material classification (version 2.0)
PUT
/FTMaterialClassification20BFBean/closeMaterialTransfFromEngine
Closes the transfer of material data and its classifications from the Classification Engine back to the host system. See also openMaterialTransferFromEngine and transferMaterialFromEngine
PUT
/FTMaterialClassification20BFBean/closeMaterialTransferToEngine
Closes the transfer of material data and its classifications from the host system to the Classification Engine. See also openMaterialTransferToEngine and transferMaterialToEngine
POST
/FTMaterialClassification20BFBean/getActiveClassificationSettings
Returns all active classification settings for the given client.
POST
/FTMaterialClassification20BFBean/getClassificationData
Get classifications for a number of materials.
POST
/FTMaterialClassification20BFBean/getClientInfo
Get information about a specific client
POST
/FTMaterialClassification20BFBean/getMaterialData
Gets the material and its classification data for one concrete material.
PUT
/FTMaterialClassification20BFBean/openMaterialTransferFromEngine
Opens the transfer of material data and its classifications from the Classification Engine back to the host system. See also transferMaterialFromEngine and closeMaterialTransfFromEngine
PUT
/FTMaterialClassification20BFBean/openMaterialTransferToEngine
Opens the transfer of material data and its classifications from the host system to the Classification Engine. See also transferMaterialToEngine and closeMaterialTransferToEngine
PUT
/FTMaterialClassification20BFBean/setMaterialAttachment
Set the material attachment for one concrete material.
PUT
/FTMaterialClassification20BFBean/setMaterialData
Set the material data for one concrete material.
PUT
/FTMaterialClassification20BFBean/transferMaterialFromEngine
Transfers material data and its classifications from the classification server (engine) back to the host system. The transfer has to be opened before with the help of openMaterialTransferFromEngine .…
PUT
/FTMaterialClassification20BFBean/transferMaterialToEngine
Transfers material data and its classifications to the classification server (engine). The transfer has to be opened before with the help of openMaterialTransferToEngine . At the end of the transfer…
MaterialBFBean 11
API for maintaining and requesting classification master data.
PUT
/MaterialBFBean/materials/partnerSystems
Adds a new partner system to the materials. If a partner system subscription exists, journal entries will be created for the partner system.
DELETE
/MaterialBFBean/materials/partnerSystems
Removes a partner system from the materials.
GET
/MaterialBFBean/materials/{materialNumber}
Get the data for one material.
DELETE
/MaterialBFBean/materials/{materialNumber}
Initiates the deletion of a material if the caller is owner of the material. If this is not the case, the partnersystem with the caller's clientSystemId is removed from the material.
PATCH
/MaterialBFBean/materials/{materialNumber}
Update the data of one material.
GET
/MaterialBFBean/businessObjects/{type}/{id}
Gets the data of a material related business object.
GET
/MaterialBFBean/materials/{materialNumber}/classificationProfiles/{profileCode}
Returns classification values of a classification profile for the requested material.
PATCH
/MaterialBFBean/materials/{materialNumber}/classificationProfiles/{profileCode}
Ensures, that the a classification for the requested material and profile exists.
POST
/MaterialBFBean/materials/classificationProfiles/{profileCode}
Returns classification values of a classification profile for the requested materials.
POST
/MaterialBFBean/materials
Get the data for multiple materials.
PATCH
/MaterialBFBean/materials/{materialNumber}/attachmentFiles/{fileName}
Update an attachment file in the engine.
MaterialConfigurationBFBean 6
API for requesting settings regarding materials.
GET
/MaterialConfigurationBFBean/classificationValueTypes/{typeName}/values/{value}/validate
Check if the supplied value is valid for the given type.
GET
/MaterialConfigurationBFBean/classificationProfiles/{profileCode}
Get a specific classification profile of the client.
GET
/MaterialConfigurationBFBean/classificationProfiles
Get classification profiles of the client.
GET
/MaterialConfigurationBFBean/classificationValueTypes/{typeName}
Get a specific classification value type of the client.
GET
/MaterialConfigurationBFBean/classificationValueTypes
Get classification value types of the client.
GET
/MaterialConfigurationBFBean/clientInfo
Get information about a specific client.
Companies 5
Rest API for companies
GET
/companies/{id}
Returns the company with the requested ID (company number). In some cases the ID (company number) is not unique . In this case an error is returned.
PUT
/companies/{id}
Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updat…
DELETE
/companies/{id}
Delete the company with the specified ID (company number). The ID is in some AEB services not unique , in this case a conflict (409) is returned.
GET
/companies
Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If th…
GET
/company-roles
Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services.
WorkstationServiceAgent 6
Connection handler for the Workstation Service Agent
GET
/wssagent/connectdeprecated
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
POST
/wssagent/connection/{id}
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
GenericAFBean 2
API to open views that support this generic interface.
GET
/GenericAFBean/getGenericApplicationFacadeInfo
POST
/GenericAFBean/applications/{applicationName}
TariffContent20BFBean 15
API for the tariff content solution (version 2.0).
POST
/TariffContent20BFBean/getAESCertificateTypes
Gets all certificates for a specific country.
POST
/TariffContent20BFBean/getAdditionalCodeProposals
Gets proposals additional codes for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code.
POST
/TariffContent20BFBean/getCertificateProposals
Gets proposals for certificates/documents for a specific combination of commodity code, decisive date, country's ISO-code and a descriptions' language ISO-code.
POST
/TariffContent20BFBean/getCommodityCode
Gets the data of exactly one commodity code. This function can also be used to check the validity of a commodity code.
POST
/TariffContent20BFBean/getCommodityCodeSubstitutions
A list of commodity code substitutions, normally relevant for a turn of the year.
POST
/TariffContent20BFBean/getCommodityCodes
All valid commodity codes for the given decisive date.
POST
/TariffContent20BFBean/getContents
A list of contents which are licensed for the given client.
POST
/TariffContent20BFBean/getCountriesForCountryGroup
A list of countries referenced in the given country group.
POST
/TariffContent20BFBean/getCountryGroups
A list of all country groups related in the tariff content.
POST
/TariffContent20BFBean/getExportControlNumber
Gets the data of exactly one export control number. This function can also be used to check the validity of a export control number.
POST
/TariffContent20BFBean/getExportControlNumberMapping
Gets the mapping data of a commodity code to a list of export control numbers.
POST
/TariffContent20BFBean/getExportControlNumbers
All valid export control numbers for the given decisive date.
POST
/TariffContent20BFBean/getImportMeasures
Gets all valid import measures for a commodity code, country, content and decisive date.
POST
/TariffContent20BFBean/getKnCodeCertificateProposalsdeprecated
Gets the proposals for certificates/documents for a specific combination of commodity code, decisive date, destination country's ISO-code and a descriptions' language ISO-code. @deprecated This metho…
POST
/TariffContent20BFBean/getKnCodeCertificateTypes
Gets all certificates for a specific knCode/country/destination-id/decisive date combination.
CustomsContentServiceBF 3
API providing services around customs content (nomenclatures, export control lists).
GET
/CustomsContentServiceBF/content/{contentIdentCode}/finalCode/{code}
Requests one final code from a catalog.
GET
/CustomsContentServiceBF/content/{contentIdentCode}/finalCodes
Requests final codes from a catalog. Result may be resticted with a prefix.
GET
/CustomsContentServiceBF/content/{contentIdentCode}/search/{searchTerm}
Searches for codes matching the given criteria.
Schemas 268
The contract defines 268 schemas that model the data the API accepts and returns. The most detailed are Company (24 properties), GenericApplicationFacadeParmsDTO (18 properties), DesktopAgentInfo (16 properties), ApplicationFacadeParmsDTO (16 properties). Each schema is shown below with its type and property counts.
BFFunctionExistsDTO
object
Result DTO for the checkBusinessFacadeFunctionExists function
2 properties
BFFunctionDTO
object
Describe a API to be called.
2 properties
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 properties
ProductInfoDTO
object
This class holds various information items of the server which serves this request.
4 properties
VersionInfoDTO
object
This class holds version information about a solution or product in a server.
2 properties
RuntimeInfoDTO
object
This class holds various runtime information items of the server which serves this request.
16 properties
RuntimeStateResultDTO
object
This class holds various information items of the server which serves this request.
5 properties
RuntimeStateParmDTO
object
This class contains parameter about asking the server about its runtime state.
AFExecuteProcessParmsDTO
object
Parameters of UI API invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.
3 properties
AFShellExecuteParmsDTO
object
Parameters of application UI API when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the co…
2 properties
ApplicationFacadeDTO
object
A data transfer object which describes an UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of th…
5 properties
ApplicationFacadeParmsDTO
object
A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
16 properties
LogonResponse
object
5 properties
LogonArgument
object
4 properties
AcknowledgePublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
4 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
AcknowledgePublishedDataFeedPartsRequestDTO
object
Request parameter for Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
5 properties
GetPublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
7 properties
PublishedDataFeedPartDTO
object
DTO to hold the data of a published data feed part.
9 properties
GetPublishedDataFeedPartsRequestDTO
object
Request parameter for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
4 properties
ExternalTMStatusResponseDTO
object
Response DTO for ExternalTelemetryBFBean/getStatus & ExternalTelemetryBFBean/status.
8 properties
ExternalTMIdentificationRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
6 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
ExternalTMResponseDTO
object
Response DTO for all calls to ExternalTelemetryBFBean.
10 properties
ExternalTMRDateEntryDTO
object
telemetry report entry for date values
3 properties
ExternalTMRDoubleEntryDTO
object
telemetry report entry for string double
3 properties
ExternalTMRIntegerEntryDTO
object
telemetry report entry for integer values
3 properties
ExternalTMRLongEntryDTO
object
telemetry report entry for long values
3 properties
ExternalTMRStringArrayEntryDTO
object
telemetry report entry for string array values
3 properties
ExternalTMRStringEntryDTO
object
telemetry report entry for string values
3 properties
ExternalTMReportRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
8 properties
ExternalTelemetryReportDTO
object
report dto to ship the telemetry data to an XNSG engine
6 properties
AcknowledgeFileResponseDTO
object
Contains the result for an acknowledge file request.
2 properties
AcknowledgeFileRequestDTO
object
Contains information about the result of a file transfer
3 properties
SimpleFileDTO
object
Meta-data for a transfer file
2 properties
AnnounceStopResultDTO
object
the result of the announce stop API
AnnounceStopParmDTO
object
parameter necessary to announce a stop of the server
3 properties
CancelAnnounceStopResultDTO
object
Contains the result information of the cancel announce stop bf
CancelAnnounceStopParmDTO
object
parameter necessary to cancel an announced stop
ChangeAdminPasswordResultDTO
object
Contains the result information of the change admin password bf
1 property
ChangeAdminPasswordParmDTO
object
This class contains the old and the new admin password
2 properties
CreateClientResponseDTO
object
encapsulates the response parameters
1 property
CreateClientRequestDTO
object
encapsulates the request parameters
3 properties
ActivationDataFlavor
object
2 properties
CommandInfo
object
2 properties
CommandMap
object
1 property
DataHandler
object
The content of a file
10 properties
DataSource
object
4 properties
DownloadFileResponseDTO
object
Contains the result for a download file request
3 properties
FileDTO
object
Data Transfer Object for a file.
7 properties
DownloadFileRequestDTO
object
Contains information on how to select a file for transferring
4 properties
TransferFileParameterDTO
object
A generic parameter for use-case specific information
2 properties
GenerateClientIdentCodeRequestDTO
object
encapsulates the request parameters
2 properties
ClientDTO
object
DTO representing an XNSG Client.
6 properties
DLFilesRefsResponseDTO
object
Contains the result for a request to get the number of files available for download
3 properties
DLFilesRefsRequestDTO
object
Contains information on how to select files for transferring
3 properties
ScriptExecutionRowDTO
object
This dto contains the data of a single line in script result
2 properties
ScriptExecutionStateResultDTO
object
Contains the result information of the script execution bf
4 properties
ScriptExecutionStateParmDTO
object
parameters necessary to ask the server for the current state of the script execution
1 property
TableUpdateStateResultDTO
object
Contains the result information of the get table update state bf
5 properties
TableUpdateStateParmDTO
object
the parameter necessary to ask the server for the current state of the table update
UploadSettingsResponseDTO
object
retrieves the server settings for uploading files via SFT interface
3 properties
UploadSettingsRequestDTO
object
retrieves the server settings for uploading files via SFT interface
2 properties
MessageDataDTO
object
resulting user tip for one locale
3 properties
PublishMessageResponseDTO
object
Contains ids of user tips that were created, or error messages
1 property
LinkDTO
object
links associated with the tip
3 properties
MessageTextsDTO
object
locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.
7 properties
PublishMessageRequestDTO
object
the for user tip, possibly in several locales
14 properties
RoleInfoDTO
object
dto for roles
9 properties
SendMailResultDTO
object
Contains the result of the sendMail method.
2 properties
SendMailAttachmentParmDTO
object
Contains an attachment for an email.
3 properties
SendMailParmDTO
object
Parameter necessary for sending a mail
9 properties
StartScriptExecutionResultDTO
object
result of start script execution
3 properties
StartScriptExecutionParmDTO
object
parameters for start script execution
4 properties
StartTableUpdateResultDTO
object
Contains the result information of the start table update bf
StartTableUpdateParmDTO
object
parameter necessary for the table update
SystemSearchResultDTO
object
DTO contained in the result array of systemSearch function
7 properties
SystemSearchParameterDTO
object
DTO used as argument to systemSearch function
3 properties
UploadFileResponseDTO
object
Contains the result for a upload file request.
2 properties
UploadFileMultiPartRequestDTO
object
Contains information on how a transmitted file should be processed
9 properties
RoleDTO
object
data about a role
6 properties
RoleTextDTO
object
language dependent values of a role
2 properties
RolesOfClientDTO
object
Response DTO for listing roles assignable to users of a client.
2 properties
ClientRolesDTO
object
Response DTO for listing client specific roles in GetRolesResponseDTO.
2 properties
GetRolesResponseDTO
object
DTO for GetRoles response
6 properties
AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
AcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
6 properties
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
SyncEventsRequestDTO
object
Request DTO for synchronizing events.
9 properties
GetPartnerSystemSubscriptionsResponseDTO
object
Response parameter with fetched partner system subscriptions to sync events.
5 properties
SyncPartnerSystemDTO
object
Identification and other data of a single partner system subscription.
3 properties
2 required
GetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
5 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
SubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
6 properties
1 required
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
UnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
5 properties
1 required
CreateCertTemplateResponseDTO
object
Response of a document template creation.
5 properties
1 required
CertDataDTO
object
DTO holding the data of a document.
5 properties
3 required
CreateCertTemplateRequestDTO
object
DTO holding the parameters for the creation of a document template.
4 properties
3 required
CreateCodeTemplateResponseDTO
object
Response of a classification template creation.
5 properties
1 required
CreateCodeTemplateRequestDTO
object
DTO holding the parameters for the creation of a code template.
5 properties
4 required
DeleteCertTemplateResponseDTO
object
Response of a document template deletion.
4 properties
DeleteCodeTemplateResponseDTO
object
Response of a classification template deletion.
4 properties
CertTemplateDTO
object
DTO holding the data of a document template.
3 properties
2 required
GetCertTemplateResponseDTO
object
Response DTO for getCertTemplate
5 properties
CodeTemplateDTO
object
DTO holding the data of a classification template.
4 properties
3 required
GetCodeTemplateResponseDTO
object
Response DTO for getCodeTemplate
5 properties
SearchCertTemplatesResponseDTO
object
Response DTO for searchCertTemplate
5 properties
SearchCertTemplatesRequestDTO
object
DTO holding the parameters for a certificate template search.
7 properties
2 required
SearchCodeTemplatesResponseDTO
object
Response DTO for searchCodeTemplate
5 properties
SearchCodeTemplatesRequestDTO
object
DTO holding the parameters for a code template search.
3 properties
2 required
UpdateCertTemplateResponseDTO
object
Response of a classification document update.
4 properties
UpdateCertTemplateRequestDTO
object
DTO holding the parameters for the update of a document template.
2 properties
1 required
UpdateCodeTemplateResponseDTO
object
Response of a classification template update.
4 properties
UpdateCodeTemplateRequestDTO
object
DTO holding the parameters for the update of a template.
2 properties
FTMCCloseMaterialTransferResultDTO
object
Result DTO of the closure of the material transfer.
2 properties
FTMCUserMessageDTO
object
DTO encapsulates problem and information messages.
2 properties
FTMCCloseMaterialTransferRequestDTO
object
Request DTO to close a material transfer session.
3 properties
2 required
FTMCClassificationSettingDTO
object
DTO for active classification setting.
3 properties
FTMCGetActiveClassificationSettingsResultDTO
object
Maintains all classification settings available for a client,
2 properties
FTMClassificationFieldSettingDTO
object
Maintains data that relates a classification field to its content.
4 properties
TCContentDTO
object
DTO to hold meta data of a content.
2 properties
FTMCGetActiveClassificationSettingsRequestDTO
object
Maintains data for requesting classification settings.
2 properties
1 required
FTMCDateDTO
object
Contains a date as string.
1 property
FTMCGetClassificationDataResultDTO
object
Results of a call to getClassification data.
2 properties
FTMCMaterialClassificationLookupDTO
object
DTO to hold data of the classification.
5 properties
FTMCMaterialClassificationValueDTO
object
DTO to hold a set of data of a material classification value.
7 properties
FTMCGetClassificationDataRequestDTO
object
Request DTO to get a single type of classification for multiple materials.
5 properties
3 required
FTMCGetClassificationDataRequestParameterDTO
object
Class to hold request parameters. Currently only the material number is contained. To be prepared for future changes, this is wrapped in this parameter dto.
2 properties
1 required
FTMCClientInfoResultDTO
object
Results of a call to IFTMaterialClassification20BFgetClientInfo(FTMCClientInfoRequestDTO)
2 properties
FTMCClientInfoRequestDTO
object
Request DTO for IFTMaterialClassification20BFgetClientInfo(FTMCClientInfoRequestDTO)
2 properties
1 required
FTMCAdditionalClassificationInfoDTO
object
Additional information of FTMaterialClassification
2 properties
FTMCCertificateDTO
object
DTO to hold data of a certificate/document
10 properties
FTMCGetMaterialDataResult20DTO
object
Result DTO to hold classification data of one defined material.
2 properties
FTMCMaterial20DTO
object
DTO to hold data of a material.
10 properties
1 required
FTMCMaterialClassification20DTO
object
DTO to hold data of material classifications
7 properties
FTMCMaterialClassificationCode20DTO
object
DTO to hold data of additional classification codes of a material.
7 properties
1 required
FTMCMaterialDescriptionDTO
object
DTO to hold data of the description of a material in a defined language.
2 properties
1 required
FTMCMaterialFeatureDTO
object
DTO to hold data of a feature of a material.
3 properties
1 required
FTMCTimestampDTO
object
Contains a time stamp as string including the time zone the strings belongs to.
2 properties
FTMCGetMaterialDataRequestDTO
object
Request DTO to get classifications data of one defined material.
3 properties
2 required
FTMCOpenMaterialTransferResultDTO
object
Result DTO of the opening of the data transfer of materials and its classifications between the host system and the classification server (engine).
5 properties
FTMCOpenMaterialTransferFromEngineRequestDTO
object
Request DTO to open the material transfer session from the classification server (engine) back to the host system.
5 properties
1 required
FTMCOpenMaterialTransferToEngineRequestDTO
object
Request DTO to open the material transfer session from the host system to the Classification Engine.
5 properties
2 required
FTMCSetMaterialAttachmentResultDTO
object
Result DTO of setting of one defined material attachment.
2 properties
FTMCMaterialAttachmentDTO
object
DTO to hold data of a material attachment
7 properties
3 required
FTMCSetMaterialAttachmentRequestDTO
object
Request DTO to set a single attachment to a material.
3 properties
1 required
FTMCSetMaterialDataResultDTO
object
Result DTO of setting of one defined material.
2 properties
FTMCSetMaterialDataRequest20DTO
object
Request DTO to set material data of one defined material.
4 properties
2 required
FTMCTransferMaterialFromEngineResult20DTO
object
Result DTO of a material transfer call from the classification server (engine) back to the host system.
7 properties
FTMCTransferMaterialFromEngineRequestDTO
object
Request DTO to hold data of the material transfer from the classification server (engine) back to the host system.
4 properties
1 required
FTMCTransferMaterialToEngineResultDTO
object
Result DTO of a material transfer call from the host system to the Classification Engine.
3 properties
FTMCTransferMaterialToEngineRequest20DTO
object
Request DTO to hold data of the material transfer from the host system to the Classification Engine.
5 properties
1 required
AddPartnersystemToMaterialResponseDTO
object
Response DTO for IMaterialBFaddPartnersystem .
4 properties
MaterialNumbersDTO
object
DTO to hold multiple material numbers.
1 property
DeleteMaterialResponseDTO
object
Response DTO for deleteMaterial
4 properties
DeletePartnersystemOfMaterialRepsonseDTO
object
Response DTO for IMaterialBFdeletePartnersystem .
4 properties
GetBusinessObjectResponseDTO
object
Response DTO for IMaterialBFgetBusinessObject .
5 properties
ClassificationValueDTO
object
DTO holding data of a specific classification value.
6 properties
1 required
GetClassificationResultDTO
object
Response DTO for IMaterialBFgetClassification .
5 properties
ClassificationValuesOfMaterialDTO
object
DTO to hold classification values of a material.
2 properties
GetClassificationForMaterialsResultDTO
object
Response DTO for IMaterialBFgetClassificationForMaterials .
5 properties
AttachmentLinkDTO
object
DTO holding information about an attachment.
2 properties
CertificateDTO
object
DTO holding the information about a certificate.
8 properties
2 required
CertificateDataDTO
object
DTO holding information about the certificate instance.
6 properties
1 required
CertificateTypeDTO
object
DTO holding information about the type of the certificate.
6 properties
2 required
ClassificationDTO
object
A DTO containing the profile code of a classification that has been requested, or is about to be requested
5 properties
1 required
FeatureDTO
object
DTO holding information about a feature.
3 properties
2 required
GetMaterialResultDTO
object
Response DTO for getMaterial
5 properties
MaterialDataDTO
object
DTO to hold data of a material.
8 properties
MaterialDescriptionDTO
object
DTO to hold data of the description of a material in a defined language.
2 properties
1 required
MaterialDetailsDTO
object
The container for material specific details.
5 properties
GetMaterialsResultDTO
object
Response DTO for getMaterials
5 properties
RequestClassificationResultDTO
object
Response DTO for requestClassifications
5 properties
UpdateFileAttachmentResultDTO
object
Response DTO for updateFileAttachment
4 properties
FileContentDTO
object
DTO to hold the content of a file as byte array.
1 property
1 required
UpdateMaterialResultDTO
object
Response DTO for updateMaterial
4 properties
CheckCodeValueValidResultDTO
object
Response DTO for IMaterialConfigurationBFcheckClassificationValueValid .
5 properties
ClassificationCodeTypeDTO
object
DTO holding information about a classification code type.
7 properties
ClassificationProfileDTO
object
DTO holding information about a classification profile.
3 properties
GetClassificationProfileResultDTO
object
Response DTO for IMaterialConfigurationBFgetClassificationProfile .
5 properties
ProfileTypeContextDTO
object
If a type is requested in the context of a profile (getClassificationProfile or getClassificationProfiles) this additional information about the type is return…
2 properties
GetClassificationProfilesResultDTO
object
Response DTO for IMaterialConfigurationBFgetClassificationProfiles .
5 properties
GetClassificationValueTypeResultDTO
object
Response DTO for IMaterialConfigurationBFgetClassificationValueType .
5 properties
GetClassificationValueTypesResultDTO
object
Response DTO for IMaterialConfigurationBFgetClassificationValueTypes .
5 properties
GetClientInfoResultDTO
object
Response DTO for getClientInfo
5 properties
Company
object
A complete address of a company.
24 properties
3 required
CompanyRole
object
A role of a company. Company roles are domain specific characteristics and can differ between the different AEB services.
2 properties
1 required
CompanyPage
object
2 properties
2 required
CompanyRoleList
object
1 property
1 required
DesktopAgentInfo
object
16 properties
LauncherInfo
object
2 properties
PerfMonitoringInfo
object
3 properties
ProcessInfo
object
6 properties
SessionInfo
object
1 property
TracingInfo
object
6 properties
WorkstationSessionInfoDTO
object
3 properties
WorkstationAgentConnectionTimeouts
object
4 properties
ApplicationInfoDTO
object
Contains information about an application, that can be accessed via GenericAFopen
2 properties
GenericApplicationFacadeInfoDTO
object
The result DTO for getGenericApplicationFacadeInfo().
5 properties
GenericParameterInfoDTO
object
Information about a specific parameter for an application.
7 properties
GenericApplicationFacadeParmsDTO
object
A generic request for an application facade.
18 properties
GenericParameterDTO
object
A name-value pair representing a single parameter.
2 properties
TCAESCertificateTypeDTO
object
DTO containing the extended field of a aes certificate.
13 properties
TCDateDTO
object
Contains a date as string.
1 property
TCGetAESCertificateTypesResultDTO
object
Result DTO to hold all certificates for a given country.
2 properties
TCUserMessageDTO
object
DTO encapsulates problem and information messages.
2 properties
TCGetAESCertificateTypesRequestDTO
object
DTO to hold request data to get all certificates of a specific country
2 properties
TCCommodityCodeAdditionalCodeDTO
object
Result DTO to hold code and description of an additional code
1 property
TCCommodityCodeMeasureAdditionalCodeDTO
object
Result DTO to hold information of a measure with additional code.
2 properties
TCCommodityCodeMeasureTypeDTO
object
Result DTO to hold code and description of a measure.
2 properties
TCGetAdditionalCodeProposalsResultDTO
object
Result DTO to hold measures with additional codes.
2 properties
TCGetAdditionalCodeProposalsRequestDTO
object
DTO to hold request data to get additional codes.
6 properties
TCCommodityCodeCertificateDTO
object
Result DTO to hold the information of a certificate/produced document
2 properties
TCCommodityCodeMeasureCertificatesDTO
object
Result DTO to hold information of a measure with certificates.
4 properties
TCGetCertificateProposalsResultDTO
object
Result DTO to hold the proposals for certificates/documents. There will be a TCCommodityCodeMeasureCertificatesDTO for each measure that needs to be applied fo…
3 properties
TCGetCertificateProposalsRequestDTO
object
DTO to hold request data to get certificate/document proposals.
7 properties
TCCommodityCodeDTO
object
DTO to hold data of a valid commodity code.
6 properties
TCGetCommodityCodeResultDTO
object
Result DTO to hold exactly one commodity code
2 properties
TCGetCommodityCodeRequestDTO
object
DTO to hold request data to get exactly one commodity codes.
7 properties
TCCommodityCodeSubstitutionDTO
object
DTO to hold data of one commodity code substitution.
5 properties
TCGetCommodityCodeSubstitutionsResultDTO
object
DTO to hold a list of commodity code substitutions.
2 properties
TCGetCommodityCodeSubstitutionsRequestDTO
object
DTO to hold request data to get a list of commodity code substitutions.
5 properties
TCGetCommodityCodesResultDTO
object
Result DTO to hold list of TCCommodityCodeDTO
2 properties
TCGetCommodityCodesRequestDTO
object
DTO to hold request data to get a list of all valid commodity codes.
6 properties
TCGetContentsResultDTO
object
Result DTO to hold a list of licensed contents.
2 properties
TCGetContentsRequestDTO
object
DTO to hold request data to get all licensed contents for the given client.
1 property
TCCountryInGroupDTO
object
DTO to hold data of a country referenced in a country group.
3 properties
TCGetCountriesForGroupResultDTO
object
DTO to hold result data of countries referenced in a country group.
2 properties
TCGetCountriesForGroupRequestDTO
object
DTO to hold request data to get all countries which belong to a given group.
4 properties
TCCountryGroupDTO
object
DTO to hold data of a country group
2 properties
TCCountryGroupTTDTO
object
DTO to hold language specific data of a country group.
3 properties
TCGetCountryGroupsResultDTO
object
DTO to hold result data of country groups related in the tariff content.
2 properties
TCGetCountryGroupsRequestDTO
object
DTO to hold request data to get all country groups related in the tariff content.
2 properties
TCExportControlNumberDTO
object
DTO to hold data of a valid export control number.
4 properties
TCGetExportControlNumberResultDTO
object
Result DTO to hold exactly one export control number.
2 properties
TCGetExportControlNumberRequestDTO
object
DTO to hold request data to get exactly one export control number.
5 properties
TCGetExportControlNumberMappingResultDTO
object
Result DTO to hold export control number mappings of a given commodity code
2 properties
TCGetExportControlNumberMappingRequestDTO
object
DTO to hold request data to get all proposed AL numbers for a KN codes.
5 properties
TCGetExportControlNumbersResultDTO
object
Result DTO to hold list of TCExportControlNumberDTO
2 properties
TCGetExportControlNumbersRequestDTO
object
DTO to hold request data to get a list of all valid export control numbers.
4 properties
TCDateRangeDTO
object
Describes a date range, spanning all days between a pair of TCDateDTO .
2 properties
TCGetImportMeasuresResultDTO
object
Result DTO to hold a list of import measures matching the request criteria. A TCImportMeasureDTO is returned for each matching import measure
2 properties
TCImportMeasureAdditionalCodeDTO
object
Represents additional code information within a TCImportMeasureDTO .
2 properties
TCImportMeasureCertificateDTO
object
Represents a certificate within a TCImportMeasureConditionDTO .
1 property
TCImportMeasureConditionDTO
object
Describes a conditional rate within a TCImportMeasureDTO .
6 properties
TCImportMeasureDTO
object
Result DTO representing a single import measure.
13 properties
TCImportMeasureFootnoteDTO
object
Describes a footnote within a TCImportMeasureDTO .
3 properties
TCImportMeasureRateComponentDTO
object
Result DTO representing one rate component of an import measure.
12 properties
TCGetImportMeasuresRequestDTO
object
DTO to hold request data for import measure requests
6 properties
TCKnCodeCertProposalResultDTO
object
Result DTO to hold the proposals for certificates/documents. There will be a TCKnCodeMeasureInfoDTO for each measure that needs to be applied for materials wit…
3 properties
TCKnCodeMeasureCertificateDTO
object
Result DTO to hold the information about a certificate.
1 property
TCKnCodeMeasureInfoDTO
object
Result DTO to hold the certificate proposal for exactly one measure.
5 properties
TCKnCodeNationalCertificateDTO
object
Result DTO to hold the information of a national certificate.
2 properties
TCKnCodeCertProposalRequestDTO
object
DTO to hold request data to get certificate/document proposals.
5 properties
TCAESCertificateTypeSimpleDTO
object
DTO containing the basic fields of a certificate.
5 properties
TCGetKnCodeCertificateTypesResultDTO
object
Result DTO to hold all certificates for a given kn code.
2 properties
TCGetKnCodeCertificateTypesRequestDTO
object
DTO to hold request data to get all certificates for a specific kn code.
5 properties
CodeElementDTO
object
DTO to hold data of one code element of a nomenclature resp. an export control list.
5 properties
GetCodeResultDTO
object
DTO to hold a request result containing one code element of the nomenclature resp. the export control list.
5 properties
SupplementaryCodeElementInfoDTO
object
DTO to hold one type-casted supplementary information about a code element.
2 properties
GetFinalCodesResultDTO
object
DTO to hold a request result containing all final code elements of the nomenclature resp. the export control list.
5 properties
SearchCodesResultDTO
object
DTO to hold a search result containing all matching code elements of the nomenclature resp. the export control list.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 10
Other APIs AEB publishes across the network.
AEB Customs Management API
AEB Customs Inventory Management API
AEB Customs Broker Portal API
AEB Trade Compliance Management API
AEB Carrier Connect API
AEB Carrier Select API
AEB Carrier Event Service API
AEB Logistics Cost Management API
AEB Document Service API
AEB BSM API
#Trade Compliance#Product Classification#HS Codes#Tariff#Customs
Where this information came from
This is an independent, third-party profile of AEB Product Classification API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.