| The SOAP API |
The SOAP API currently only supports validation.
- The Validation Method
Please call if you wish to write other methods
Regardless of what services you call, you will need the same login credentials that you use everywhere else in the system.
You may wish to consider:
|
|
Validation Method
|
|
Purpose
Validate an XBRL document. Validation might be as simple as basic XBRL 2.1 validation, or as complex as EDGAR validation.
WSDL
http://guest.xbrlcloud.com/ValidationService/services/XBRLValidationService?wsdl
Method Details
|
Option
|
Datatype
|
Required
|
Option Description
|
Value
|
Value Description
|
zipBytes
|
xsd:base64Binary
|
Required
|
A Base 64 encoded ZIP file that represents the documents to be validated
|
{A ZIP file}
|
A ZIP file that contains all of the files necessary to do the validation (instance if appropriate, schemas, and linkbases).
|
|
entryPoint
|
xsd:string
|
Required
|
The document from which to start discovery (typically an instance document or the main taxonomy entry point).
|
{A relative URL}
|
A relative URL that is the entry point. Note that "relative" means that if you were to unzip the file into a directory, how would you get to the entry document.
Example: my-instance.xml
Example: Test%202009-01-01/my-instance.xml
|
|
flavor
|
xsd:string
|
Required
|
Type of validation. Each flavor indicates a different set of rules to check. In all cases, the flavors include standard validation.
|
standard
|
Standard XBRL 2.1 Validation. per the XBRL 2.1 Specification.
|
|
|
|
|
frta
|
This is standard XBRL 2.1 validation plus validation rules specified by FRTA.
|
|
|
|
|
sec_informal_criteria
|
This is standard XBRL 2.1 validation plus validation
rules specified by
the SEC
Public Validation Criteria.
|
|
|
|
|
edgar_v10
|
This is standard XBRL 2.1 validation plus validation
rules specified by
the SEC's
EDGAR Filer Manual.
|
|
Return Value
|
Datatype
|
Description
|
|
xsd:string
|
An XML representation of the error messages
|
|
