Public Member Functions | Protected Attributes
uk.ac.open.webcontrollers.APIController Class Reference

List of all members.

Public Member Functions

 APIController ()
ModelAndView search (HttpServletRequest request, HttpServletResponse response,@PathVariable String searchCriteria)
ModelAndView getSimilar (HttpServletRequest request, HttpServletResponse response)
void downloadPdf (HttpServletRequest request, HttpServletResponse response,@PathVariable Integer pdfId)
void getPdf (HttpServletRequest request, HttpServletResponse response,@PathVariable Integer pdfId)
void getText (HttpServletRequest request, HttpServletResponse response,@PathVariable Integer documentId)
void downloadText (HttpServletRequest request, HttpServletResponse response,@PathVariable Integer documentId)

Protected Attributes

JGoogleAnalyticsTracker tracker = null
FocusPoint focusPoint = null

Detailed Description

API interface for CORE application.

TODO:

  • list all response status codes in javadoc
Author:
dh8835@openmail.open.ac.uk
Since:
2011-12-06

Constructor & Destructor Documentation

uk.ac.open.webcontrollers.APIController.APIController ( )

Class constructor.

Member Function Documentation

void uk.ac.open.webcontrollers.APIController.downloadPdf ( HttpServletRequest  request,
HttpServletResponse  response,
@PathVariable Integer  pdfId 
)

Method will download selected PDF.

Resource URL

http://core.kmi.open.ac.uk/api/download/pdf/<pdf_id>

Request methods

GET

Parameters

Required

  • pdf_id: ID of PDF to be loaded
  • api_key: registered API key

Optional

  • repository_id: repository in which the PDF belongs, this parameter is not mandatory but will make the response faster

Returns

  • 200 OK
  • 401 Unauthorized (missing API key)
  • 404 Not Found (requested document doesn't exist)

Examples

Request

GET http://core.kmi.open.ac.uk/api/download/pdf/35760?repository_id=41&api_key=ks8d74h5b4uj

References

void uk.ac.open.webcontrollers.APIController.downloadText ( HttpServletRequest  request,
HttpServletResponse  response,
@PathVariable Integer  documentId 
)

Method will download extracted text for selected document.

Resource URL

http://core.kmi.open.ac.uk/api/download/text/<document_id>

Request methods

GET

Parameters

Required

  • document_id: ID of text to be downloaded
  • api_key: registered API key

Optional

  • repository_id: repository in which the PDF belongs this parameter is not mandatory but will make the response faster

Returns

  • 200 OK
  • 401 Unauthorized (missing API key)
  • 404 Not Found (requested document doesn't exist)

Examples

Request

GET http://core.kmi.open.ac.uk/api/download/text/35760?repository_id=41&api_key=ks8d74h5b4uj

References

void uk.ac.open.webcontrollers.APIController.getPdf ( HttpServletRequest  request,
HttpServletResponse  response,
@PathVariable Integer  pdfId 
)

Method will open selected PDF.

Resource URL

http://core.kmi.open.ac.uk/api/get/pdf/<pdf_id>

Request methods

GET

Parameters

Required

  • pdf_id: ID of PDF to be loaded
  • api_key: registered API key

Optional

  • repository_id: repository in which the PDF belongs this parameter is not mandatory but will make the response faster

Returns

  • 200 OK
  • 401 Unauthorized (missing API key)
  • 404 Not Found (requested document doesn't exist)

Examples

Request

GET http://core.kmi.open.ac.uk/api/get/pdf/35760?repository_id=41&api_key=ks8d74h5b4uj

Response

References

ModelAndView uk.ac.open.webcontrollers.APIController.getSimilar ( HttpServletRequest  request,
HttpServletResponse  response 
)

Method will search CORE database for similar documents.

Resource URL

http://core.kmi.open.ac.uk/api/get_similar

Request method

POST

Parameters

Required

  • text: text which will be analyzed for similarity
  • api_key: API key

Optional

  • format: XML or JSON, by default response is sent in XML format
  • count: number of results returned, 10 by default

Returns

  • 200 OK
  • 204 No Content (request was OK but no articles were found)
  • 400 Bad Request (missing text)
  • 401 Unauthorized (missing API key)

Examples

XML

Request

POST http://core.kmi.open.ac.uk/api/get_similar
POST DATA text=Some%20text%20to%20be%20analyzed.&count=5&api_key=ks8d74h5b4uj

Response

<?xml version="1.0" encoding="UTF-8"?>
<ListRecords>
<record>
<header>
<identifier>90157</identifier>
<core:repositoryIdentifier>1</core:repositoryIdentifier>
<MuSim:AssociationMethod>core:CosineTFIDFSim</MuSim:AssociationMethod>
<MuSim:weight>0.9952741</MuSim:weight>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:creator>David Corsar, Pete Edwards, Nagendra Velaga, John Nelson, Jeff Pan, School Aberdeen, dot Aberdeen, School Aberdeen and Geography Aberdeen</dc:creator>
<dc:title>Addressing the Challenges of Semantic Citizen-Sensing</dc:title>
<dc:description>Preprint</dc:description>
<dc:format>application/pdf</dc:format>
<dc:identifier>http://kmi-dev05.open.ac.uk:8080/COREWeb/download/pdf/90157/1</dc:identifier>
<dc:identifier>http://core.kmi.open.ac.uk/COREWeb/display/90157</dc:identifier>
<dc:identifier>oai:aura.abdn.ac.uk:2164/2261</dc:identifier>
<dc:source>Aberdeen University Research Archive (AURA)</dc:source>
<dc:source>http://research.ict.csiro.au/conferences/ssn/ssn11/semantic_sensor_networks_2011.pdf</dc:source>
<dc:date>2011-10-23</dc:date>
</oai_dc:dc>
</metadata>
</record>
</ListRecords>

JSON

Request

POST http://core.kmi.open.ac.uk/api/get_similar
POST DATA text=Some%20text%20to%20be%20analyzed.&response_format=json&api_key=ks8d74h5b4uj

Response

void uk.ac.open.webcontrollers.APIController.getText ( HttpServletRequest  request,
HttpServletResponse  response,
@PathVariable Integer  documentId 
)

Method will open extracted text for selected document.

Resource URL

http://core.kmi.open.ac.uk/api/get/text/<document_id>

Request methods

GET

Parameters

Required

  • document_id: ID of text to be loaded
  • api_key: registered API key

Optional

  • repository_id: repository in which the PDF belongs this parameter is not mandatory but will make the response faster

Returns

  • 200 OK
  • 401 Unauthorized (missing API key)
  • 404 Not Found (requested document doesn't exist)

Examples

Request

GET http://core.kmi.open.ac.uk/api/get/text/35760?repository_id=41&api_key=ks8d74h5b4uj

References

ModelAndView uk.ac.open.webcontrollers.APIController.search ( HttpServletRequest  request,
HttpServletResponse  response,
@PathVariable String  searchCriteria 
)

Method will search CORE database and retrieve documents corresponding to given criteria.

Resource URL

http://core.kmi.open.ac.uk/api/search/<search_criteria>

Request method

GET, POST

Parameters

Required

  • search_criteria: URL encoded search query
  • api_key: API key

Optional

  • format: XML or JSON, by default response is sent in XML format
  • count: number of results returned, 10 by default

Returns

  • 200 OK
  • 204 No Content (request was OK but no articles were found)
  • 401 Unauthorized (missing API key)

Examples

XML

Request

GET http://core.kmi.open.ac.uk/api/search/semantic%20web?api_key=ks8d74h5b4uj
GET http://core.kmi.open.ac.uk/api/search/title:%20(semantic%20web)?api_key=ks8d74h5b4uj

Response

<?xml version="1.0" encoding="UTF-8"?>
<ListRecords>
<record>
<header>
<identifier>90157</identifier>
<core:repositoryIdentifier>1</core:repositoryIdentifier>
</header>
<metadata>
<oai_dc:dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:creator>David Corsar, Pete Edwards, Nagendra Velaga, John Nelson, Jeff Pan, School Aberdeen, dot Aberdeen, School Aberdeen and Geography Aberdeen</dc:creator>
<dc:title>Addressing the Challenges of Semantic Citizen-Sensing</dc:title>
<dc:description>Preprint</dc:description>
<dc:format>application/pdf</dc:format>
<dc:identifier>http://kmi-dev05.open.ac.uk:8080/COREWeb/download/pdf/90157/1</dc:identifier>
<dc:identifier>http://core.kmi.open.ac.uk/COREWeb/display/90157</dc:identifier>
<dc:identifier>oai:aura.abdn.ac.uk:2164/2261</dc:identifier>
<dc:source>Aberdeen University Research Archive (AURA)</dc:source>
<dc:source>http://research.ict.csiro.au/conferences/ssn/ssn11/semantic_sensor_networks_2011.pdf</dc:source>
<dc:date>2011-10-23</dc:date>
</oai_dc:dc>
</metadata>
</record>
</ListRecords>

JSON

Request

GET http://core.kmi.open.ac.uk/api/search/semantic%20web?format=json&api_key=ks8d74h5b4uj

Response

The documentation for this class was generated from the following file:
 All Classes Functions