Archive 1.x:OSF Tagger (scones)/1.1

The scones web service system (subject concepts or named entities) is used to perform subject concepts and named entities tagging on a target document. The GATE system is used to perform the tagging. A GATE XML annotation file is returned to the user.

Developers communicate with the Search Web service using the HTTP POST method. You may request one mime types: (1) text/xml.

Version
This documentation page is used for the version 1.1 of this endpoint. Check at the top of this page to see the documentation pages for the other versions of this endpoint.

Usage
This Web service is intended to be used by users that wants to tag subjects concepts and named entities using the content of a target OSF Web Service instance.

Since the scones instance is re-using the ontologies & named entities defined on a specific OSF Web Service instance, tagging will be performed using this specific information. So, if a specific OSF Web Service instance is hosted, maintained and defined by an a Health related organization, than their scones web service should be better at tagging Health related documents.

So, not all scones instance are equal, and some are expected to be better at tagging specific articles than other, depending on the domain defined on a specific node.

Web Service Endpoint Information
This section describes all the permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.

To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.

Needed registered CRUD permission:


 * Create: False
 * Read: True
 * Update: False
 * Delete: False

Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.

Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.

HTTP method:


 * POST

Possible "Accept:" HTTP header field value:


 * text/xml

URI:


 * http://[...]/ws/scones/ ?document=param1&docmime=param2&application=param3&registered_ip=param4

URI dynamic parameters description:

Note: All parameters have to be URL-encoded


 * param1. Document content to process; or URL of a document accessible on the web to extract/process
 * The document types accessible at that URL can be either:
 * a plain text document
 * a HTML document
 * a PDF document
 * a MS Word document
 * a Email document
 * a RTF document
 * a SGML document
 * a XML document
 * param2. Mime type of the input document to tag. Currently supported mime types are:
 * "text/plain" (default)
 * param3.(default: defaultApplication). Application to use to tag the content of the input document. If other applications are available, these should be listed somewhere on the website of the agent that host the service.
 * param4.Target IP address registered in the WSF.

Example of Returned XML Document
This is an example of the XML document returned by this Web service endpoint for a given document's content. This example returns GATE XML annotated document

Query:


 * http://[...]/ws/scones/ parameters: document=CBC%20news%20Results%20in%20Winnipeg's%20poorest%20area%20Posted

"Accept:" HTTP header field value:


 * text/xml

Result:

HTTP Status Codes
Here are the possible HTTP status (error) codes returned by this Web service endpoint.

On error code and the specific error, a different message description can be issued (meaning a different error has been returned).


 * Code:200
 * Message:OK


 * Code:400
 * Message: Bad Request
 * Message description: No documents URI specified for this request
 * Message description: Scones is not configured.
 * Message description: Scones is not initialized.
 * Message description: Scones is being initialized.
 * Message description: Document MIME type not supported.
 * Message description: Document empty


 * Code:406
 * Message:Not Acceptable
 * Message description:Unacceptable mime type requested


 * Code:500
 * Message:Internal Error