Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
The HXL Proxy supports a simple transactional API for validation.
HTTP method: POST
The result will have the CORS header
Access-allow-origin: * set to allow browser-side inclusion.
One of these two is required, and they are mutually-exclusive:
- content - the HXL dataset as a file upload
- url - a URL pointing to the HXL dataset
One of these two is optional, and they are mutually-exclusive (if omitted, the HXL Proxy will use a built-in default schema):
- schema_content - the HXL schema as a file upload
- schema_url - a URL pointing to the HXL schema
These parameters are optional:
- sheet - the index of the Excel workbook sheet to use for the dataset (first sheet is 0); ignored for other formats.
- schema_sheet - the index of Excel workbook sheet to use for the schema (first sheet is 0); ignored for other formats.
- include_dataset - if truthy ("on", etc), include a JSON version of the original data in the validation report, with the key "dataset".
The service will return an HTTP status code of 200 with a JSON Validation report as content unless there was an low-level error (e.g. the data wasn't accessible), in which case there will be an appropriate HTTP error status code and a JSON description of the error as content.