Difference between revisions of "ASL HTTP InformationRetrieval"
From Gcube Wiki
(→listing of searchable collections) |
(→listing of searchable collections) |
||
| Line 6: | Line 6: | ||
* ''URL request example'': http://localhost:8080/aslHttpInformationRetrieval/ShowCollections | * ''URL request example'': http://localhost:8080/aslHttpInformationRetrieval/ShowCollections | ||
* ''Response in XML'': | * ''Response in XML'': | ||
| − | * ''Response in JSON'': < | + | * ''Response in JSON'': <pre style="white-space: pre-wrap; |
| + | white-space: -moz-pre-wrap; | ||
| + | white-space: -pre-wrap; | ||
| + | white-space: -o-pre-wrap; | ||
| + | word-wrap: break-word">[{"name":"Maps and National Overviews","collections":[{"name":"FARM Cultured Aquatic Species Fact Sheets","colId":"7f78c200-f877-11dd-8103-acc6e633ea9e"},{"name":"FARM Current National Aquaculture Sector Overview (NASO)","colId":"8964ce50-f875-11dd-8103-acc6e633ea9e"},{"name":"FARM Current National Legislation Overview (NALO)","colId":"dfe59f60-f876-11dd-8103-acc6e633ea9e"},{"name":"FARM FAO Country Maps","colId":"c5b83790-f35f-11dd-9a37-9b05ac676cca"}]},{"name":"Time Series Graphs","collections":[{"name":"FARM Aquaculture Time Series Graphs","colId":"cba3b770-f1e2-11dd-836f-ed8453cc0b6c"},{"name":"FARM Capture Time Series Graphs","colId":"9ac21cf0-f160-11dd-96f7-b87cc0f0b075"},{"name":"FARM Production Time Series Graphs","colId":"18611ed0-f162-11dd-96f7-b87cc0f0b075"},{"name":"FARM Trade Time Series Graphs","colId":"d14baeb0-f162-11dd-96f7-b87cc0f0b075"}]},{"name":"External Repositories","collections":[{"name":"Aquatic Commons","colId":"3b9e3ad0-ee64-11df-8ac0-e72586f1640d"},{"name":"WHOAS at MBLWHOI Library","colId":"6b9e8ad0-eh68-11jf-8ac0-e72586n1670a"}]},{"name":"Fact Sheets","collections":[{"name":"FARM Introduced Species Fact sheets","colId":"0a0574d0-f400-11dd-9a38-9b05ac676cca"},{"name":"FARM Cultured Aquatic Species Fact Sheets","colId":"7f78c200-f877-11dd-8103-acc6e633ea9e"}]}]</pre> | ||
==retrieval of information about searchable collections== | ==retrieval of information about searchable collections== | ||
Revision as of 12:38, 28 August 2012
The ASL HTTP Information Retrieval component is part of the HTTP Front End Framework and provides aggregated access to mandated functionality for performing a gCube search. It follows the all the framework principles for data interchange formats, error handling, and context management, supporting both JSON and XML, using the common framework utilities for user authentication and HTTP error responses, supporting all authentication modes and following the suggested design patterns for scope management and session management as well as coding guidelines. The features provided are listed as follows:
Contents
listing of searchable collections
Once logged in to a scope (either in named or anonymous access), the user is able to get the list of the available, searchable collections in the corresponding VO/VRE. By submitting a GET request to the ShowCollections servlet of the InformationRetrieval group of services, the user can retrieve an XML or a JSON representation of the list that aggregates the necessary information for the accessible collections.
- Parameters needed: none
- URL request example: http://localhost:8080/aslHttpInformationRetrieval/ShowCollections
- Response in XML:
- Response in JSON:
[{"name":"Maps and National Overviews","collections":[{"name":"FARM Cultured Aquatic Species Fact Sheets","colId":"7f78c200-f877-11dd-8103-acc6e633ea9e"},{"name":"FARM Current National Aquaculture Sector Overview (NASO)","colId":"8964ce50-f875-11dd-8103-acc6e633ea9e"},{"name":"FARM Current National Legislation Overview (NALO)","colId":"dfe59f60-f876-11dd-8103-acc6e633ea9e"},{"name":"FARM FAO Country Maps","colId":"c5b83790-f35f-11dd-9a37-9b05ac676cca"}]},{"name":"Time Series Graphs","collections":[{"name":"FARM Aquaculture Time Series Graphs","colId":"cba3b770-f1e2-11dd-836f-ed8453cc0b6c"},{"name":"FARM Capture Time Series Graphs","colId":"9ac21cf0-f160-11dd-96f7-b87cc0f0b075"},{"name":"FARM Production Time Series Graphs","colId":"18611ed0-f162-11dd-96f7-b87cc0f0b075"},{"name":"FARM Trade Time Series Graphs","colId":"d14baeb0-f162-11dd-96f7-b87cc0f0b075"}]},{"name":"External Repositories","collections":[{"name":"Aquatic Commons","colId":"3b9e3ad0-ee64-11df-8ac0-e72586f1640d"},{"name":"WHOAS at MBLWHOI Library","colId":"6b9e8ad0-eh68-11jf-8ac0-e72586n1670a"}]},{"name":"Fact Sheets","collections":[{"name":"FARM Introduced Species Fact sheets","colId":"0a0574d0-f400-11dd-9a38-9b05ac676cca"},{"name":"FARM Cultured Aquatic Species Fact Sheets","colId":"7f78c200-f877-11dd-8103-acc6e633ea9e"}]}]
