Report package

OpenAPI V2

Create taxonomy report package

post

Create taxonomy report package. For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below. Response body will be for example:

{ 
    "zipContentBase64": "JVBERxLjQKMSAw...", 
    "hashResult": { 
        "Hash_Result": "nKDBo115PBhw3U3Y= " 
    } 
}

Authorizations

Query parameters

isHashedbooleanoptional

Specifies whether to have a hashcode included in the output. By default the value is false

Default: false

Header parameters

x-api-versionstringrequired

ApplicationNameanyoptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyoptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyoptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyoptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyoptional

Business Identification Number (BIN) of the customer.

ClientNameanyoptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyoptional

Business Identification Number (BIN) of the client.

Body

namestring | nullableoptional

identifierstring | nullableoptional

descriptionstring | nullableoptional

versionstring | nullableoptional

reportPackageLanguagestring | nullableoptional

publicationDatestring | nullableoptional

publisherstring | nullableoptional

publisherUrlstring | nullableoptional

publisherCountrystring | nullableoptional

reportPackageNamestring | nullableoptional

reportBase64Contentstring | nullableoptional

reportNamestring | nullableoptional

entrypointsobject[] | nullableoptional

base64ZipFilesstring | nullableoptional

base64ReportPackageJsonstring | nullableoptional

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /report-package HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "name": "text",
  "identifier": "text",
  "description": "text",
  "version": "text",
  "reportPackageLanguage": "text",
  "publicationDate": "text",
  "publisher": "text",
  "publisherUrl": "text",
  "publisherCountry": "text",
  "reportPackageName": "text",
  "reportBase64Content": "text",
  "reportName": "text",
  "entrypoints": [
    {
      "name": "text",
      "description": "text",
      "version": "text",
      "entryPointDocument": {
        "href": "text"
      },
      "languages": [
        "text"
      ]
    }
  ],
  "base64ZipFiles": "text",
  "base64ReportPackageJson": "text"
}

{
  "zipContentBase64": "JVBERxLjQKMSAw..."
}