Image Collection API Documentation - Version 1

Resources - Allowed Usage (Allowed Usages)

An Allowed Usage describes under what conditions a Photograph can be used based on a particular context and circumstance determined when a Photograph is requested.

The Allowed Usage for an image may change depending on who is accessing the image and what actions they have previously performed (such as licensing a photograph for a particular purpose).

Resource model

Name Property Name Data Type Optional Description
Description - plain description_plain String No A statement summarising how a Photograph can be used, see [1] for details
License terms - link href_license_terms String No A fully qualified URL for the Image Collection license terms
Permitted uses permitted_uses Array - of - String Yes An inclusive list of all permitted uses for a photograph, see [2] for details

[1] This description is suitable for display providing a reference to the License terms is provided (ideally as a hyperlink).

[2] This list is definitive, i.e. if a use is not within this list the use is not permitted. Permitted uses depend on a particular context and circumstance determined when a Photograph is requested.

Example (JSON)

{
    "description_plain": "Available for all Permitted Uses subject to our License Terms",
    "href_license_terms": "http:\/\/www.photo.antarctica.ac.uk\/external\/guest\/tandc_disp",
    "permitted_uses": [
        "Within single Web site only"
    ]
}

Resource methods

None.


This information may be out of date whilst this website is being redeveloped. Until then, if you have any problems using an API documented here, please contact the relevant project maintainer.