jonathanlloyd/BL-Images-API

Image metadata API for the British Library Open Data Project

BL-Images-API

NODEJS API for loading images from the British Library Open Dataset

##Specification The API can be accessed/manipulated with the following RESTful requests:

###GET

• /images/ID

• returns a JSON representation of an image for a given ID

• Parameters:

  • ID: Image ID

• /images/random

• returns a JSON representation of a random image from the dataset

• Parameters

• /images/ID/machine-tags/TAG

  • returns the confidence value, as generated by machine learning, for a tag on a given image
  • Parameters:
    • ID: Image ID
    • TAG: Name of the tag

• /images/ID/crowd-tags/TAG

  • returns the confidence value, as generated by crowdsourcing, for a tag on a given image
  • Parameters:
    • ID: Image ID
    • TAG: Name of the tag

###PUT

• /images/ID/machine-tags/TAG/VALUE
  • overwrites the confidence value, as generated by machine learning, for a tag on an image where ID is the image id and TAG is the name of the tag
  • Parameters:
    • ID: Image ID
    • TAG: Name of the tag
    • VALUE: Confidence value for the tag
• /images/ID/crowd-tags/TAG/VALUE
  • overwrites the confidence value, as generated by crowdsourcing, for a tag on an image where ID is the image id and TAG is the name of the tag
  • Parameters:
    • ID: Image ID
    • TAG: Name of the tag
    • VALUE: Confidence value for the tag