| The Simple API |
|
The primary Web Services API is The REST API. However, this Simple API allows you to trivially access high-use services:
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.
Method Details
|
Option
|
Required
|
Option Description
|
Value
|
Value Description
|
document-url
|
Required
|
The location of the document to be validated.
|
{any URL}
|
This document likely resides on the XBRL Cloud server as well, but can be anywhere on the internet.
|
|
flavor
|
Not required: defaults to standard
|
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.
|
|
|
|
xbrls
|
This is standard XBRL 2.1 validation plus validation rules specified by The XBRL Simple Profile.
|
|
media
|
Not required: When not specified, media type is determined via Content Negotiation
|
The format of the return document (XML vs. XHTML vs. Excel, etc.)
|
xml
|
Request a text/xml document
|
|
|
|
xhtml
|
Request an application/xhtml document.
Note that Internet Explorer does not support application/xhtml: When the agent is IE, the server returns text/html
|
|
|
|
json
|
Request an application/json document.
|
|
|
|
excel
|
Request an application/excel document.
|
|
Example Usage
XBRL 2.1 validation on an instance document -- XHTML result
http://guest.xbrlcloud.com/simple/validate?document-url=http://guest.xbrlcloud.com/share/public/XBRLS-ComprehensiveExample-2008-04-18/gaap/Sample-Instance-Proof.xml?media=xhtml
EDGAR validation on an instance document -- XML result
http://guest.xbrlcloud.com/simple/validate?document-url=http://guest.xbrlcloud.com/share/public/XBRLS-ComprehensiveExample-2008-04-18/gaap/Sample-Instance-Proof.xml&flavor=EDGAR_V10&media=xml
|
|
Transformation Method
|
|
Purpose
You can easily transform an XBRL instance and/or taxonomy into a
much more usable single document. Common applications of this
API include created XML, XHTML, or Excel output. The
transformation engine implements XPath extension functions.
Method Details
|
Option
|
Required
|
Option Description
|
Value
|
Value Description
|
document-url
|
Required
|
The location of the document to be validated.
|
{any URL}
|
This document likely resides on the same XBRL Cloud subdomain as the user (see example above), but can be anywhere on the internet
|
|
xsl-url
|
Required
|
An XSL stylesheet.
Please note that the XBRL Cloud transformation engine is
based on the Coyote Reporting processor: you will likely need
the
extension function documentation.
|
{any URL}
|
This document likely resides on the same XBRL Cloud subdomain as the user (see example above), but can be anywhere on the internet
|
|
media
|
Not required: When not specified, media type is determined via Content Negotiation
|
The format of the return document (XML vs. XHTML vs. Excel, etc.)
|
xml
|
Request a text/xml document
|
|
|
|
xhtml
|
Request an application/xhtml document.
Note that Internet Explorer does not support application/xhtml: When the agent is IE, the server returns text/html
|
|
|
|
json
|
Request an application/json document.
|
|
|
|
excel
|
Request an application/excel document.
|
|
Example Usage
Basic XSLT Example
http://guest.xbrlcloud.com/simple/xslt?document-url=http://guest.xbrlcloud.com/share/public/...&xsl-url=http://guest.xbrlcloud.com/share/public/...
|
