AEB

AEB Classification Proposal BF Bean API

API for classification proposals.

GitHub OpenAPI

Operations 10

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. #

Documentation

📖
Documentation
https://customsmanagement.docs.developers.aeb.com/
📖
APIReference
https://customsmanagement.docs.developers.aeb.com/reference/how-to-use-the-api-reference
📖
GettingStarted
https://customsmanagement.docs.developers.aeb.com/docs/your-first-consignment
📖
Documentation
https://customsmanagement.docs.developers.aeb.com/docs/about-product-classification
📖
Documentation
https://trade-compliance.docs.developers.aeb.com/
📖
APIReference
https://trade-compliance.docs.developers.aeb.com/reference/compliance-foundation
📖
GettingStarted
https://trade-compliance.docs.developers.aeb.com/docs/accessing-the-rest-services
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/shipping
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/createroutingtask
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/getshipmentsevents
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/docs/carrier-event-service/llms.txt
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/getbillingscenario
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/docs/logistics-cost-management/llms.txt
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/getworkstations
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/docs/document-service/llms.txt
📖
Documentation
https://sap-plugins.docs.developers.aeb.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-classificationproposalbfbean-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/AEB-labs/docs-trade-compliance
📦
GitHubRepository
https://github.com/AEB-labs/docs-transport-freight-management
📦
GitHubRepository
https://github.com/AEB-labs/docs-bsm

Other Resources

🔗
ChangeLog
https://customsmanagement.docs.developers.aeb.com/changelog
🔗
SOAP
https://rz3.aeb.de/test2ici/servlet/bf
🔗
SOAP
https://rz3.aeb.de/test2cim/servlet/bf
🔗
SOAP
https://rz3.aeb.de/test2broker/servlet/bf
🔗
SOAP
https://rz3.aeb.de/test2cl/servlet/bf
🔗
Pricing
https://www.aeb.com/en/carrier-connect/carrier-connect-api.php
🔗
Integrations
https://www.aeb.com/en/carrier-connect/all-transport-service-providers-carriers.php

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aeb-classificationproposalbfbean-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aeb-classificationproposalbfbean-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Product Classification HTTP Classification Proposal BF Bean API
  description: Thank you for using our HTTP API documentation.
  version: '4.0'
servers:
- url: https://rz3.aeb.de/test2cl/rest
security:
- SWAGGER_AUTH_KEY: []
- BASIC_AUTH: []
tags:
- name: ClassificationProposalBFBean
  description: API for classification proposals.
paths:
  /ClassificationProposalBFBean/certTemplate:
    put:
      tags:
      - ClassificationProposalBFBean
      summary: Creates a new document template.
      operationId: createCertTemplate
      parameters:
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the update.
        schema:
          maxLength: 254
          type: string
      requestBody:
        description: The parameters or the created document template.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCertTemplateRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCertTemplateResponseDTO'
  /ClassificationProposalBFBean/codeTemplate:
    put:
      tags:
      - ClassificationProposalBFBean
      summary: Creates a new classification code template.
      operationId: createCodeTemplate
      parameters:
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the update.
        schema:
          maxLength: 254
          type: string
      requestBody:
        description: The parameters or the created classification code template.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCodeTemplateRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCodeTemplateResponseDTO'
  /ClassificationProposalBFBean/certTemplate/{id}:
    get:
      tags:
      - ClassificationProposalBFBean
      summary: Gets the data of a document template.
      operationId: getCertTemplate
      parameters:
      - name: id
        in: path
        description: The unique identification of a document template.
        required: true
        schema:
          maxLength: 32
          type: string
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the call.
        schema:
          maxLength: 254
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCertTemplateResponseDTO'
    delete:
      tags:
      - ClassificationProposalBFBean
      summary: Deletes an existing document template.
      operationId: deleteCertTemplate
      parameters:
      - name: id
        in: path
        description: The unique identification of a document template.
        required: true
        schema:
          maxLength: 32
          type: string
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the update.
        schema:
          maxLength: 254
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCertTemplateResponseDTO'
    patch:
      tags:
      - ClassificationProposalBFBean
      summary: Updates an existing document template.
      operationId: updateCertTemplate
      parameters:
      - name: id
        in: path
        description: The unique identification of a document template.
        required: true
        schema:
          maxLength: 32
          type: string
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the update.
        schema:
          maxLength: 254
          type: string
      requestBody:
        description: The update parameters for the document template.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCertTemplateRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCertTemplateResponseDTO'
  /ClassificationProposalBFBean/codeTemplate/{id}:
    get:
      tags:
      - ClassificationProposalBFBean
      summary: Gets the data of a classification code template.
      operationId: getCodeTemplate
      parameters:
      - name: id
        in: path
        description: The unique identification of a classification code template.
        required: true
        schema:
          maxLength: 32
          type: string
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the call.
        schema:
          maxLength: 254
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCodeTemplateResponseDTO'
    delete:
      tags:
      - ClassificationProposalBFBean
      summary: Creates a new classification code template.
      operationId: deleteCodeTemplate
      parameters:
      - name: id
        in: path
        description: The unique identification of a classification code template.
        required: true
        schema:
          maxLength: 32
          type: string
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the update.
        schema:
          maxLength: 254
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCodeTemplateResponseDTO'
    patch:
      tags:
      - ClassificationProposalBFBean
      summary: Updates an existing classification code template.
      operationId: updateCodeTemplate
      parameters:
      - name: id
        in: path
        description: The unique identification of a classification code template.
        required: true
        schema:
          maxLength: 32
          type: string
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used..
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the update.
        schema:
          maxLength: 254
          type: string
      requestBody:
        description: The update parameters for the classification code template.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCodeTemplateRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCodeTemplateResponseDTO'
  /ClassificationProposalBFBean/certTemplate/search:
    post:
      tags:
      - ClassificationProposalBFBean
      summary: Searches for suitable document templates matching the criteria of the given search input.
      operationId: searchCertTemplates
      parameters:
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the call.
        schema:
          maxLength: 254
          type: string
      requestBody:
        description: The parameters for the document template search.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCertTemplatesRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCertTemplatesResponseDTO'
  /ClassificationProposalBFBean/codeTemplate/search:
    post:
      tags:
      - ClassificationProposalBFBean
      summary: Searches for suitable classification code templates matching the criteria of the given search input.
      operationId: searchCodeTemplates
      parameters:
      - name: clientIdentCode
        in: query
        description: The unique identification code of the client. If empty, the client of the authentication is used.
        schema:
          maxLength: 10
          type: string
      - name: userName
        in: query
        description: Names the user from the client system. Used to identify the origin of the call.
        schema:
          maxLength: 254
          type: string
      requestBody:
        description: The parameters for the classification code template search.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCodeTemplatesRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCodeTemplatesResponseDTO'
components:
  schemas:
    DeleteCodeTemplateResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Response of a classification template deletion.
    UpdateCertTemplateResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Response of a classification document update.
    CreateCodeTemplateResponseDTO:
      required:
      - id
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        id:
          maxLength: 32
          type: string
          description: The unique identification code of a classification code template.
      description: Response of a classification template creation.
    CodeTemplateDTO:
      required:
      - id
      - targetTypeName
      - value
      type: object
      properties:
        id:
          maxLength: 32
          type: string
          description: The unique identification code of a classification template.
        targetTypeName:
          maxLength: 255
          type: string
          description: name of the source type of the template as defined in the system.
        value:
          maxLength: 800
          type: string
          description: The classification value of the template.
        applicationType:
          maxLength: 15
          type: string
          description: Defines how a classification template should be applied into a target value.
          enum:
          - MANUAL
          - AUTOMATIC
          - RULE_BASED
      description: DTO holding the data of a classification template.
    CertTemplateDTO:
      required:
      - certTemplateData
      - id
      type: object
      properties:
        id:
          maxLength: 32
          type: string
          description: The unique identification code of a document template.
        applicationType:
          maxLength: 15
          type: string
          description: Defines how a document template should be applied.
          enum:
          - MANUAL
          - AUTOMATIC
          - RULE_BASED
        certTemplateData:
          $ref: '#/components/schemas/CertDataDTO'
      description: DTO holding the data of a document template.
    SearchCodeTemplatesResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        codeTemplates:
          type: array
          description: The data of all the classification templates fitting the search input.
          items:
            $ref: '#/components/schemas/CodeTemplateDTO'
      description: 'Response DTO for #searchCodeTemplate'
    UpdateCodeTemplateRequestDTO:
      type: object
      properties:
        value:
          maxLength: 800
          type: string
          description: The classification value of the template.
        applicationType:
          maxLength: 15
          type: string
          description: Defines how a classification template should be applied into a target value.
          default: MANUAL
          enum:
          - MANUAL
          - AUTOMATIC
      description: DTO holding the parameters for the update of a template.
    SearchCodeTemplatesRequestDTO:
      required:
      - sourceTypeName
      - sourceValue
      type: object
      properties:
        sourceValue:
          maxLength: 800
          type: string
          description: The source value for which classification templates will be searched.
        sourceTypeName:
          maxLength: 255
          type: string
          description: The name of the source type of the template as defined in the system.
        targetTypeName:
          maxLength: 255
          type: string
          description: name of the source type of the template as defined in the system.
      description: DTO holding the parameters for a code template search.
    DeleteCertTemplateResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Response of a document template deletion.
    UpdateCodeTemplateResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Response of a classification template update.
    GetCertTemplateResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        certTemplate:
          $ref: '#/components/schemas/CertTemplateDTO'
      description: 'Response DTO for #getCertTemplate'
    SearchCertTemplatesRequestDTO:
      required:
      - sourceTypeName
      - sourceValue
      type: object
      properties:
        sourceValue:
          maxLength: 800
          type: string
          description: The source value for which document templates will be searched.
        sourceTypeName:
          maxLength: 255
          type: string
          description: The name of the source type of the template as defined in the system.
        countryOfCertificate:
          maxLength: 2
          minLength: 2
          type: string
          description: Issuer country of the templates document.
        areaOfDestination:
          maxLength: 10
          type: string
          description: Country or area code of the destination for which the document is valid.
        code:
          maxLength: 5
          type: string
          description: Code of the templates document type.
        qualifier:
          maxLength: 3
          type: string
          description: Qualifier for further specification of the document type.
        division:
          maxLength: 1
          type: string
          description: The division of the document of the template.
      description: DTO holding the parameters for a certificate template search.
    UpdateCertTemplateRequestDTO:
      required:
      - certData
      type: object
      properties:
        applicationType:
          maxLength: 15
          type: string
          description: Defines how a classification template should be applied into a target value.
          enum:
          - MANUAL
          - AUTOMATIC
        certData:
          $ref: '#/components/schemas/CertDataDTO'
      description: DTO holding the parameters for the update of a document template.
    TextInLanguageDTO:
      type: object
      properties:
        languageISOCode:
          type: string
          description: <p>2-letter ISO code of the language.</p><p>length=2</p>
          example: en
        text:
          type: string
          description: The translated text.
          example: Some free-form text
      description: A translated text in one of the specified languages.
    CreateCodeTemplateRequestDTO:
      required:
      - sourceTypeName
      - sourceValue
      - targetTypeName
      - targetValue
      type: object
      properties:
        sourceTypeName:
          maxLength: 255
          type: string
          description: The name of the source type of the template as defined in the system.
        sourceValue:
          maxLength: 800
          type: string
          description: The classification value of the template.
        targetTypeName:
          maxLength: 255
          type: string
          description: name of the source type of the template as defined in the system.
        targetValue:
          maxLength: 800
          type: string
          description: The classification value of the template.
        applicationType:
          maxLength: 15
          type: string
          description: Defines how a classification template should be applied into a target value.
          default: MANUAL
          enum:
          - MANUAL
          - AUTOMATIC
      description: DTO holding the parameters for the creation of a code template.
    CreateCertTemplateRequestDTO:
      required:
      - certData
      - sourceTypeName
      - sourceValue
      type: object
      properties:
        sourceTypeName:
          maxLength: 255
          type: string
          description: The name of the source type of the template as defined in the system.
        sourceValue:
          maxLength: 800
          type: string
          description: The source value for which a document templates will be created.
        applicationType:
          maxLength: 15
          type: string
          description: Defines how a document template should be applied into a target value.
          default: MANUAL
          enum:
          - MANUAL
          - AUTOMATIC
        certData:
          $ref: '#/components/schemas/CertDataDTO'
      description: DTO holding the parameters for the creation of a document template.
    CertDataDTO:
      maxLength: 255
      required:
      - areaOfDestination
      - code
      - countryOfCertificate
      type: object
      properties:
        countryOfCertificate:
          maxLength: 2
          minLength: 2
          type: string
          description: Country that issued this document.
        areaOfDestination:
          maxLength: 10
          type: string
          description: Country or area code of the destination for which the document is valid.
        code:
          maxLength: 5
          type: string
          description: Code of this document type.
        qualifier:
          maxLength: 3
          type: string
          description: Qualifier for further specification of the document type.
        division:
          maxLength: 1
          type: string
          description: The division of the document of the template.
      description: DTO holding the data of a document.
    GetCodeTemplateResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        codeTemplate:
          $ref: '#/components/schemas/CodeTemplateDTO'
      description: 'Response DTO for #getCodeTemplate'
    CreateCertTemplateResponseDTO:
      required:
      - id
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        id:
          maxLength: 32
          type: string
          description: The unique identification code of a document template.
      description: Response of a document template creation.
    SearchCertTemplatesResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        certTemplates:
          type: array
          description: The data of all the document templates fitting the search input.
          items:
            $ref: '#/components/schemas/CertTemplateDTO'
      description: 'Response DTO for #searchCertTemplate'
    ResponseMessageDTO:
      type: object
      properties:
        messageType:
          type: string
          description: '<p>Message type</p><p>If not stated otherwise, the possible types are:</p><ul><li>ERROR</li><li>WARNING</li><li>INFO</li></ul><p>Maximum length: 50</p>'
          example: WARNING
        messageIdentCode:
          type: string
          description: '<p>Optional identification code for further classification of the message type.</p><p>Maximum length: 50</p>'
          example: '5627'
        messageTexts:
          type: array
          description: <p>Detailed message texts in the requested languages.</p>
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        indentationLevel:
          type: integer
          description: <p>The indentation level of the message.</p><p>'0' indicates a top level message.</p>
          format: int32
          example: 0
      description: Result messages like errors or warnings.
  securitySchemes:
    SWAGGER_AUTH_KEY:
      type: apiKey
      name: X-XNSG_WEB_TOKEN
      in: header
    BASIC_AUTH:
      type: http
      scheme: basic
x-proxy-enabled: false