"

Section Objects

Base Url

https://api.amdigital.co.uk/1.0/[resource_name]/sections

Where [resource_name] is the key of the Adam Matthew collection you are using. For a list of collection keys available click here.

Description

Sections represent the subdivisions of a document. Conceptually within the collections these can be entities such as sections, chapters, articles and issues. Full text data is not returned when requesting sections.

Query String Parameters

Get Operation

documentId

The API identifier assigned to the document the section is from. Using this parameter on its own returns all the sections for the document only.

Data Type: String

Example: https://api.amdigital.co.uk/1.0/globalcommodities/sections?documentId=G362_876_B847_B876

 id

The API identifier assigned to the section. This is a zero-based index relating to the order of the sections within the document. This should be used in conjunction with 'documentId' to retrieve a single section within a particular document.

Data Type: Integer

Values: 0 to 2147483647

Example: https://api.amdigital.co.uk/1.0/globalcommodities/sections?documentId=G362_876_B847_B876&id=0

query

Text to search for. This parameter will be parsed as Contextual Query Language (CQL) to allow for more powerful searching.

Data Type: String

Example: https://api.amdigital.co.uk/1.0/globalcommodities/sections?query=dinosaur%20or%20bird

take

Number of records to return. This defaults to 10 with a maximum value of 200. If you would like to return more records use this in multiple calls in conjunction with skip.

Data Type: Integer

Values: to 200

Default: 10

Example: https://api.amdigital.co.uk/1.0/globalcommodities/images?take=25

skip

The record number to start at from the list of results. A search query returns results in order of relevance. If the results returned from a query do not return what you are looking for you can use this parameter to return records further down the list. The default for this value is 0 with a maximum of the number of records in the collection. If you go over this number no records will be returned.

Data Type: Integer

Values: to 2147483647

Default: 0

Example: https://api.amdigital.co.uk/1.0/globalcommodities/sections?skip=200

Example Response

Note "type": "section" could also be "type": "chapter" or "type": "article" or "type": "issue" depending on the type of the section returned.

{
  "timestamp": "11/12/2015 14:26:38",
  "version": "1.0",
  "totalResults": 1,
  "data": [
    {
      "type": "section",
      "collection": "Mass Observation",
      "index": 4,
      "identifier": "WorktownCollection-Box 17",
      "uri": "http://www.massobservation.amdigital.co.uk/Documents/Images/WorktownCollection-Box 17/301",
      "metadata": {
        "reference": "17-E"
      }
    }
  ]
}