depa.store

Information Required

The only information required to access the cds is a valid depa.tech document ID (such as DE.000112014003467.A5). Accessing the endpoint of a document directly will return a list, in JSON format, of all artifacts we currently hold for that particular document.

Naming Conventions

To allow for uniform access to the various publishing offices that depa.tech supports, a naming convention has been employed for common artifacts. For example, the PDF is always called DOCUMENT.PDF, the XML DOCUMENT.XML, and the individual page files PAGEnnnn. This conforms to the standard DEPAROM naming conventions. A DEPAROM client is not required to use cds.

Artifacts Stored in cds

Currently, depa.tech holds the following artifacts:

• Office XML

  The XML source from the publishing office contained, at minimum, the bibliographic data. For some offices, full text is available. See table below.

• Office PDF

  The PDF file from the publishing office.

• PAGEnnnn files

  Each page as single page TIFF in CCITT format (single bit, black and white) at 300 DPI. Generally rendered from the Office PDF.

• Embedded Images

  Images and drawings in TIFF format. Naming convention depends on publishing office. Used in combination with the XML.

• mtc JSON

  The document XML in JSON format. The artifact name is mtc.json.

• mtc Simple JSON

  A simplified JSON format that complies more closely with DEPAROM. Generally speaking, for most uses the mtc JSON format is more appropriate since it is more. The artifact name is mtc.simple.json.

• mtc Artifacts JSON

  A file in JSON format containing a list of all available artifacts. The file is called artifacts.json. Is similar is usage to what is returned by the List Artifacts endpoint. This file also contains structural information about what document sections are on which pages.

HTTP API

General Error Responses

The HTTP API returns the following error codes, these are listed here. Other responses are listed in the tables further down.

Service Endpoints

JSON Formats

Response from List Artifacts

Example:

1{
2      "container": "DE.000112014003467.A5",
3      "docid": "DE.000112014003467.A5",
4      "artifacts": [
5          "artifacts.json",
6          "DOCUMENT.PDF",
7          "DOCUMENT.XML",
8          "mtc.json",
9          "mtc.simple.json",
10          "mtc_source.json",
11          "PAGE0001"
12      ]
13  }

Request JSON for Bulk Download

Example:

1{
2    "docids": [
3        "EP.000000002678869.A2",
4        "DE.000202011110740.U1"
5    ],
6    "filter": [
7        "*.xml",
8        "*.pdf"
9    ]
10}

MTC Artifacts JSON

Example:

1{
2    "id": "DE.000112014003467.A5",
3    "artifacts": [
4        "DOCUMENT.PDF",
5        "DOCUMENT.XML",
6        "mtc.json",
7        "mtc.simple.json",
8        "mtc_source.json",
9        "PAGE0001",
10        "artifacts.json"
11    ],
12    "sections": [
13        {
14            "section": "Title",
15            "start": 1,
16            "end": 1
17        }
18    ]
19}

Reponse JSON for Check Availability

Example:

1{
2    "docids": [
3        "EP.000000002678869.A2"
4    ]
5}