...
AMANA recommends to implement a call for this webservice using tools that will auto-generate coresponding client code, like JAX-WS, Apache AXIS2 or Visual Studio "Add Reference" WCF (.NET). It is possible to test the webservice with SOAP UI.
Tjhe The webservices uses basic authentification to authorize requests. All users that are authorized in the XBRL Portal can use the webservice. However, AMANA recommends to use a technical user, that exists by default:
...
| Parameter | Required | Type | Description |
|---|---|---|---|
| zippedXbrlFile | Yes | base64 byte streambytes | The ZIP file containing one XBRL file with filename extension .xbrl, or an SEC Filing including the taxonomy extension files. |
| settings.Comment | No | string | A comment to the filing, will be displayed in the Filing Details. |
| settings.SenderId | Yes (No for ValidationOnly) | string | The XBRL context identifier used to map the XBRL file to an Entity. |
| settings FileName | Yes | string | The original filename of the ZIP file. |
| settings UserId | Yes | string | The technical user name. |
| settings.AdditionalSeetings | No | Dictionary<string,string> | An additional dictionary to pass configuration settings without changing the WSDL, see table below. |
| settings.ValidationOnly | Yes | boolean | If true, the XBRL file will be validated, but no further processing will be performed. |
...
| Additional Settings Key | Type | Description |
|---|---|---|
| XbrlFileName | string | The original XBRL file name., that will be used in the filing and for Filing Rule validation. |
| isSecFiling | boolean | Has to be true if an SEC filing ZIP will be processed. |
| DeactivateCustomValidations | boolean | If true, no Custom Validation will be performed. |
| AwsBucketFoldername | string | Basefolder name used for upload to "AWS Bucket" |
Returns
The ProcessFiling Method returns an ProcessingResult, that has the following properties. It is also returned by the GetProcessingResult method documented below.
...
| Property | Type | Description |
|---|---|---|
| ProcessingId | GUID | A unique GUID identifying the processing request. |
| FilingId | int | The filing ID of a processed XBRL file, if processing was successful. |
| Status | enum | The status of the actual processing job, RanToCompletion (5) means the process finished. See more details in the table below. |
| FilingId | int | The filing ID of a processed XBRL file, if processing was successful. |
| FilingVersionId | int | The filing version ID of a processed XBRL file, if processing was successful. |
| IsRejected | boolean | True if filing is rejected, if processing was successful. |
| IsServerError | boolean | True if any server error happened during processing, this usually means that an manual investigation has to be started. |
Md5Hash | string | The MD5 hash calculated on the XBRL file, if processing was successful. |
| IsDuplicateFiling | boolean | If true, a duplicate filing is detected and processing was successful. |
| DuplicateFilingId | int | The ID of the filing detected as a duplicate, if processing was successful. |
| DuplicateFilingXbrlProcessingId | GUID | The GUID of the processing that processed the duplicate filing. |
| ValidationResults | List<ValidationResult> | The XBRL validation results and messages from the XBRL processing, for more details see table below. |
| TaxonomyVersionIds | List<int> | The Ids of the taxonomies used in the XBRL file. |
| TaxonomyVersionEntrypoints | List<string> | All Taxonomy entrypoints found in the XBRL file |
| IsXbrlValid | boolean | The information if the XBRL file is valid (considering warnings as valid). |
Processing Job Status
The job status property of the ProcessingResult can have the following states:
| State | Integer Value | Description |
|---|---|---|
| Created | 0 | The job has been initialized but has not yet been scheduled. |
| WaitingForActivation | 1 | The job is waiting to be activated and scheduled internally. |
| WaitingToRun | 2 | The job has been scheduled for execution but has not yet begun executing. |
| Running | 3 | The job is running but has not yet completed. |
| WaitingForChildrenToComplete | 4 | The job has finished executing and is implicitly waiting for attached child tasks to complete. |
| RanToCompletion | 5 | The job completed execution successfully. |
| Canceled | 6 | The job has been manually cancelled. |
| Faulted | 7 | The job completed due to an unhandled exception. This usually means that the job will retried, and that a manual investigation has to be started. |
Validation Results
The validation results are returned as a list of ValidationResult nodes. Those have the following properties:
...