| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| format | URI-Query | string | enum: [
"KateAPI",
"InternalAPIMap",
"OpenAPI",
"Swagger"
] |
Yes | "KateAPI" | Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache. |
| openApiVersion | URI-Query | int | enum: [
2,
3
] |
Yes | 2 | Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation). |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | The API-documentation. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| idMapping | URI-Path | string | minLength: 10 |
No | Mapping ID |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | string | JSON Mapping on this en,vironment |
| InvalidMappingIdException | 400 | Invalid XBRL Mapping ID: contains illegal characters. | |
| MappingNotFoundException | 404 | Unable to locate mapping definition. See error details for mapping ID. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| idMapping | POST-body | string | minLength: 10 |
No | Id of the mapping, for example 'mapping-vt15-taxatiegegevens'. | |
| idCustomer | POST-body | string | pattern: ^[A-Za-z0-9-]{3,15}$ |
No | Id of the customer. | |
| jsonValuation | POST-body | string | format: json maxLength: 4194304 |
No | JSON-stringified version a JSON valuation interpretable by the specified mapping. | |
| aggregateValidationErrors | POST-body | bool | Yes | false | If passed as true, does not just return the first ValidationFailedException, but collects as many as possible and returns them within an AggregateValidationFailedException |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | string | XBRL document |
| InvalidMappingIdException | 400 | Invalid XBRL Mapping ID: contains illegal characters. | |
| InvalidJSONException | 500 | JSON-string could not be parsed into valid JSON. | |
| MappingNotFoundException | 404 | Unable to locate mapping definition. See error details for mapping ID. | |
| XBRLInvalidMappingDefinitionException | 500 | The mapping definition is invalid. The description will contain additional details. | |
| InstanceAlreadyRunningException | 500 | Implementation error. One node can only process one mapping at once; a process is already running. | |
| PipeProcessingException | 200 | Runtime Error when a pipe encounters an error. The description will contain additional details. | |
| RunAlreadyCompletedException | 500 | Implementation error. When a completed processing (success or failure) is attempted to process again. | |
| ValidationFailedException | 200 | One of the validation constraints was unsatisfied (Input valuation is invalid). The error will contain extensive details in a fixed format. | |
| AggregateValidationFailedException | 200 | One or more of the validation constraints was unsatisfied (Input valuation is invalid). The error will contain extensive details in a fixed format. It is returned instead of ValidationFailedException when 'aggregateValidationErrors' is set to true. Its details contain an array, where entries have the same detail format as ValidationFailedException. / |
|
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |