To get a feel for the information in the Videorooter database, or to just get some random information for testing purposes, you can use this method to get a random work. The method will lookup a random work in the database and return a Location header to redirect the client to the random work.

Request

• :type (string) either video or image (default: both)

Response

Status: 303 See Other ```Location: http://example.endpoint.io/work/3434’’’

For errors responses, see the response status codes documentation.

This is a compatibility call conforming to the http://docs.cmcatalog.apiary.io/. It queries the database for a particular work by its identifier and returns the known metadata about the work. This information will conform to the data package format which is based on the W3C Ontology for media resources.

Response

Sends back information with annotations.

Status: 200 OK { "public" : "true", "description" : "Script logo for athletics at Elon University.", "id" : 6968, "annotations" : [ { "language" : "en", "titleLabel" : "Elon Phoenix wordmark", "propertyName" : "title" }, { "identifierLink" : "https://commons.wikimedia.org/wiki/File:Elon Phoeni x wordmark.png", "propertyName" : "identifier" }, { "propertyName" : "locator", "locatorLink" : "https://upload.wikimedia.org/wikipedia/commons/3/31/El on_Phoenix_wordmark.png" }, { "propertName" : "policy", "typeLink" : "http://www.w3.org/1999/xhtml/vocab#license", "typeLabel" : "license", "statementLabel" : "Public domain" }, { "propertyName" : "collection", "collectionLink" : "http://commons.wikimedia.org" }, { "creatorLabel" : "Elon University Athletics", "propertyName" : "creator" }, { "holderLabel" : "Elon University Athletics", "propertyName" : "copyright" } ], "href" : "http://devc.commonsmachinery.se:8080/works/6968", "media" : [ { "id" : 6968, "href" : "http://devc.commonsmachinery.se:8080/works/6968/media" } : ], "added_at" : "2015-02-21T11:11:12.685Z", "owner" : { "org" : { "href" : "http://example.com", "id" : 1 } } }

For errors responses, see the response status codes documentation.

This is a compatibility call conforming to the http://docs.cmcatalog.apiary.io/. It queries the database for a particular work by its identifier and returns the media (source images) associated with it.

Response

Sends back information with a location annotation giving the link to the source work.

Status: 200 OK { "annotations": [{ "property": { "propertyName": "locator", "locatorLink": "https://example.image.io/image.png" } }], "href": "http://example.endpoint.io/works/3948734/media", "id": 3948734 }

For errors responses, see the response status codes documentation.

This call queries the database for a particular work by its identifier and returns the known metadata about the work. This information is in a simplified W3C Ontology for media resources format and uses similar naming but different style of presenting the information.

Response

Sends back information with annotations.

Status: 200 OK { "description" : "Script logo for athletics at Elon University.", "id" : 6968, "annotations" : { "title" : "Elon Phoenix wordmark", "identifier" : "https://commons.wikimedia.org/wiki/File:Elon Phoenix wordmark.png", "locator" : "https://upload.wikimedia.org/wikipedia/commons/3/31/Elon_Phoenix_wordmark.png", "policy" : "http://creativecommons.org/by-sa/3.0", "collection" : "http://commons.wikimedia.org" "creator" : "Elon University Athletics", } "href" : "http://devc.commonsmachinery.se:8080/videorooter/works/6968", "media" : [ { "id" : 6968, "href" : "http://devc.commonsmachinery.se:8080/videorooter/works/6968/media" } : ] }

For errors responses, see the response status codes documentation.

This call queries the database for a particular work by its identifier and returns the media (source images) associated with it.

Response

Sends back information with a location annotation giving the link to the source work.

Status: 200 OK { "locator": "https://example.image.io/image.png", "href": "http://example.endpoint.io/works/3948734/media", "id": 3948734, "identifiers": [ "http://sample/hash/2/38763q4420834", "http://sample/hash/1/23o34934", ] }

For errors responses, see the response status codes documentation.

This is part of a set of API calls which are specific for the Videorooter project and used internally by its website. It’s possible to use these calls externally too, but the results may vary and change frequently.

This call inquires about the status of a previous search which has been made. It returns either a status code of 202 if the search has not yet been completed, or a list of results.

Response

Sends back a collection of matching works. The reference returned is a URI which can be used to further query the resource for additional information about the work.

Status: 200 OK [ { "href": "http://example.endpoint.io/works/5396e592d7d163613d7321ee" "distance": 2 }, { "href": "http://example.endpoint.io/works/d7321ee5396e592d7d163613" "distance": 8 } ]

For errors responses, see the response status codes documentation.

This is an experimental call to look up a video by its blockhash. The call conforms to the same specification as /lookup/hash, namely the http://docs.cmcatalog.apiary.io/. It allows you to lookup videos based on an experimental https://github.com/commonsmachinery/blockhash-rfc algorithm which is implemented in https://github.com/jonasob/blockhash.

The maximum hash distance is controlled by the server and cannot be increased by the client. It may however be decreased. Currently the maximum hash distance is 40.

Request

• :hash (string) is the calculated hash to lookup
• :distance (number, optional) is the maximum hash distance (10 by default)

Response

Sends back a collection of matching works. The reference returned is a URI which can be used to further query the resource for additional information about the work.

Status: 200 OK [ { "href": "http://example.endpoint.io/works/5396e592d7d163613d7321ee" "distance": 2 }, { "href": "http://example.endpoint.io/works/d7321ee5396e592d7d163613" "distance": 8 } ]

For errors responses, see the response status codes documentation.

This is a dummy call to conform to the http://docs.cmcatalog.apiary.io/. It doesn’t return anything but an empty array regardless of what you give it.

Response

Status: 200 OK []

This call does not return any errors.

This is an experimental call to look up a video by a full text search of title, description and credit. The call is so far using a natural language query, meaning that it interprets all fields as natural language fields and tries to do a best effort matching.

Commonly occuring words like “and”, “or”, “the”, “there”, and so on may be ignored, but more specific words like “tripod” or individual names will be acted upon.

Request

• :q (string) is the search string

Response

Sends back a collection of matching works. The reference returned is a URI which can be used to further query the resource for additional information about the work.

Status: 200 OK [ { "href": "http://example.endpoint.io/works/5396e592d7d163613d7321ee" }, { "href": "http://example.endpoint.io/works/d7321ee5396e592d7d163613" } ]

For errors responses, see the response status codes documentation.

This is a compatibility call conforming to the http://docs.cmcatalog.apiary.io/. It allows you to lookup images based on the https://github.com/commonsmachinery/blockhash-rfc.

The maximum hash distance is controlled by the server and cannot be increased by the client. It may however be decreased. Currently the maximum hash distance is 10.

Request

• :hash (string) is the calculated hash to lookup
• :distance (number, optional) is the maximum hash distance (10 by default)

Response

Sends back a collection of matching works. The reference returned is a URI which can be used to further query the resource for additional information about the work.

Status: 200 OK [ { "href": "http://example.endpoint.io/works/5396e592d7d163613d7321ee" "distance": 2 }, { "href": "http://example.endpoint.io/works/d7321ee5396e592d7d163613" "distance": 8 } ]

For errors responses, see the response status codes documentation.