Moxie Library API Documentation

Transcription

1 Moxie Library API Documentation Release 0.1 Mobile Oxford team, IT Services, University of Oxford January 30, 2014

2

3 Contents 1 HTTP API Library endpoint Internal API Overview Indices and tables 7 HTTP Routing Table 9 i

4 ii

5 CHAPTER 1 HTTP API 1.1 Library endpoint Endpoint to search and retrieve information about media in libraries. Follows specification of Moxie. GET /library/item:(string: id) Get details of a media by its ID Example request: GET /library/item: HTTP/1.1 Host: api.m.ox.ac.uk Accept: application/json Example response as JSON: HTTP/ OK Content-Type: application/json "publisher": "[Paris] : Minist\u00e8re de la Reconstruction et de l Urbanisme, 1951.", "description": "2 maps.", "author": null, "holdings": "BODBL": "holdings": [ "materials_specified": null, "shelfmark": "C21:50 Arreau (1)", "availability": "available", "availability_display": "Available", ] "control_number": " ", "copies": 1, "edition": null, "isbns": [], "title": "Arreau. [map]", "issns": [] 1

6 Moxie Library API Documentation, Release 0.1 Each library holding the book might have the properties availability and availability_display. The property availability is readable by computers and is one of: unavailable, unknown, stack, reference, available. The property availability_display is readable by humans and the text may vary depending on the provider used. Parameters id (string) ID of the resource availability (boolean) true if media should be annotated with real-time availability (defaults to true) Status Codes 200 resource found 404 no resource found GET /library/search Search for media by title and/or author or ISBN. Example request: GET /library/search?title=python HTTP/1.1 Host: api.m.ox.ac.uk Accept: application/hal+json Example response as HAL+JSON: HTTP/ OK Content-Type: application/hal+json "_embedded": "items": [ "description": "[96] p. of music : ill. ; 28 cm.", "edition": null, "id": " ", "publisher": "London : Methuen, 1995.", "_embedded": "BODBL": "website": " "phone": "", "address": "", "lat": " ", "id": "oxpoints: ", "distance": 0, "name": "Bodleian Library", "opening_hours": "", "type_name": [ "Library" ], "lon": " ", "_links": "self": "href": "/places/oxpoints: " "parent": "href": "/places/oxpoints: ", "title": "Bodleian Libraries" 2 Chapter 1. HTTP API

7 Moxie Library API Documentation, Release 0.1 "child": [ "href": "/places/oxpoints: ", "title": "Bodleian - Lower Camera Open Shelves" [...] "href": "/places/oxpoints: ", "title": "English Accessions" ] "type": [ "/university/library" ] "title": "The fairly incomplete & rather badly illustrated Monty Python song book / fore "holdings": "BODBL": [ "materials_specified": null, "shelfmark": "Mus. 5 d.1127" ] "author": null, "copies": 1, "_links": "self": "href": "/library/item: /" "isbns": [ " (pbk)" ], "issns": [] ] "isbn": null, "author": null, "_links": "hl:first": "href": "/library/search?count=35&title=python" "curie": "href": " "name": "hl", "templated": true "self": "href": "/library/search?title=python" "hl:next": "href": "/library/search?count=35&start=35&title=python" "hl:last": 1.1. Library endpoint 3

8 Moxie Library API Documentation, Release 0.1 "href": "/library/search?count=35&start=153&title=python" "title": "python", "size": 188 The response contains a list of results, links to go to first, previous, next and last pages depending on current start and count parameters, and the total count of results. Query Parameters title title to search for author author to search for isbn isbn to search for availability true if search results should be annotated with real-time availability (defaults to false) start first result to display count number of results to display Status Codes 200 results found 400 search query is inconsistent (expect details about the error as plain/text in the body of the response) 500 search service is not available 4 Chapter 1. HTTP API

9 CHAPTER 2 Internal API 2.1 Overview Library services Methods to search libraries documents from defined providers. 5

10 Moxie Library API Documentation, Release Chapter 2. Internal API

11 CHAPTER 3 Indices and tables genindex modindex search 7

12 Moxie Library API Documentation, Release Chapter 3. Indices and tables

13 HTTP Routing Table /library GET /library/item:(string:id), 1 GET /library/search, 2 9