Package de.aeb.xnsg.tariffcontent.bf.v3

Interface ICustomsContentServiceBF

@BusinessFacade public interface ICustomsContentServiceBF
API providing services around customs contents (e.g. nomenclatures, export control lists).

  • Method Details

    • searchCodes

      SearchCodesResultDTO searchCodes(String clientIdentCode, String userName, String contentIdentCode, String searchTerm, String languageISOCode, String decisiveDate, Integer maxNumberResults)
      Searches for codes matching the given criteria.
      Parameters:
      clientIdentCode - Optional. The unique identifier of the client. If empty, the client of the authentication is used.
      userName - Optional. Names the user from the client system. Used to identify the origin of the call.
      contentIdentCode - Required. The unique identifier of the catalog the matching codes shall belong to.
      searchTerm - Required. Search term that either the code itself shall start with or that shall be contained in its text. Enclose with quotes to search for an exact term or group of words.
      languageISOCode - Optional. 2-digit ISO code of the language which the returned code descriptions shall have. Also the language in which the textual search will be executed. Default is determined by the catalog.
      decisiveDate - Optional. Date for which the returned code shall be valid. Format: YYYY-MM-DD
      maxNumberResults - Optional. Maximum number of matching code elements that shall be returned. Default is 10.
      Returns:
      matching codes in the catalog

    • getFinalCode

      GetCodeResultDTO getFinalCode(String clientIdentCode, String userName, String contentIdentCode, String code, String languageISOCodes, String decisiveDate, Boolean includeSupplementaryInfos)
      Parameters:
      clientIdentCode - Optional. The unique identifier of the client. If empty, the client of the authentication is used.
      userName - Optional. Names the user from the client system. Used to identify the origin of the call.
      contentIdentCode - Required. The unique identifier of the catalog the code shall belong to.
      code - Required. Code that is requested.
      decisiveDate - Optional. Date for which the returned code shall be valid. Format: YYYY-MM-DD
      includeSupplementaryInfos - Optional. Specifies whether the returned codes shall contain supplementary information (like special units in case of commodity codes). Default false.
      languageISOCode - Optional. Comma-separated 2-digit ISO codes of the languages which the returned code descriptions shall have. Default are all available languages of the catalog. Format: XX,YY
      Returns:
      requested code from the catalog

    • getFinalCodes

      GetFinalCodesResultDTO getFinalCodes(String clientIdentCode, String userName, String contentIdentCode, String prefix, String languageISOCodes, String decisiveDate, Boolean includeSupplementaryInfos)
      Parameters:
      clientIdentCode - Optional. The unique identifier of the client. If empty, the client of the authentication is used.
      userName - Optional. Names the user from the client system. Used to identify the origin of the call.
      contentIdentCode - Required. The unique identifier of the catalog the final codes shall belong to.
      prefix - Optional. Restricts the returned codes to codes that start with this prefix (e.g. some chapter of a nomenclature).
      languageISOCodes - Optional. Comma-separated 2-digit ISO codes of the languages which the returned code descriptions shall have. Default are all available languages of the catalog. Format: XX,YY
      decisiveDate - Optional. Date for which the returned codes shall be valid. Format: YYYY-MM-DD
      includeSupplementaryInfos - Optional. Specifies whether the returned codes shall contain supplementary information (like special units in case of commodity codes). Default false.
      Returns:
      final codes from the catalog