Help

$ curl -s [-X GET|POST|PUT|HEADER] https://www.oa-deepgreen.de/api/v1/...

POST /validate?api_key=<api_key>
Content-Type: application/json

[Incoming Notification JSON]

POST /notification?api_key=<api_key>
Content-Type: multipart/form-data; boundary=FulltextBoundary

--FulltextBoundary

Content-Disposition: form-data; name="metadata"
Content-Type: application/json

[Incoming Notification JSON]

--FulltextBoundary

Content-Disposition: form-data; name="content"
Content-Type: application/zip

[Package]

--FulltextBoundary--

GET /routed[?<params>]

GET /routed/<repo_id>[?<params>]

GET /notification/<notification_id>

POST /config?api_key=<api_key>
Content-Type: application/json; charset=utf-8

[New (overwriting!) match config settings JSON]

GET /config?api_key=<api_key>

#! /usr/bin/env bash

host_url="https://www.oa-deepgreen.de"

if [ $# -ge 2 ]; then
  api_key=$1
  zip_file=$2
else
  echo "usage: `basename $0` {api-key} {zip-file}"
  exit -1
fi

curl=`which curl`
zipgrep=`which zipgrep`
wc=`which wc`

pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
has_xml=`${zipgrep} "DOCTYPE article" ${zip_file} | ${wc} -l`

if [ ${has_xml} -eq 1 ]; then
  is_jrnl=`${zipgrep} "//NLM//DTD Journal " ${zip_file} | ${wc} -l`
  is_jats=`${zipgrep} "//NLM//DTD JATS " ${zip_file} | ${wc} -l`
  is_rsc=`${zipgrep} "//RSC//DTD RSC " ${zip_file} | ${wc} -l`
  if [ ${is_jrnl} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_jats} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_rsc} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndRSC"
  else
    echo "error: no valid .xml (JATS or RSC) in zip archive found: stop."
    exit -2
  fi
else
  echo "error: no valid (or too many?!) .xml (JATS xor RSC) in zip archive found: stop."
  exit -3
fi

echo "`basename $0`: packaging format in zip archive found:"
echo "`basename $0`: ${pkg_fmt}"

${curl} -i -k -s -XPOST "${host_url}/api/v1/validate?api_key=${api_key}" -F "content=@${zip_file};type=application/zip" -F "metadata=@-;type=application/json" <<EOF
{
  "content" : {
     "packaging_format" : "${pkg_fmt}"
  }
}
EOF

echo

#! /usr/bin/env bash

host_url="https://www.oa-deepgreen.de"

if [ $# -ge 2 ]; then
  api_key=$1
  zip_file=$2
else
  echo "usage: `basename $0` {api-key} {zip-file}"
  exit -1
fi

curl=`which curl`
zipgrep=`which zipgrep`
wc=`which wc`

pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
has_xml=`${zipgrep} "DOCTYPE article" ${zip_file} | ${wc} -l`

if [ ${has_xml} -eq 1 ]; then
  is_jrnl=`${zipgrep} "//NLM//DTD Journal " ${zip_file} | ${wc} -l`
  is_jats=`${zipgrep} "//NLM//DTD JATS " ${zip_file} | ${wc} -l`
  is_rsc=`${zipgrep} "//RSC//DTD RSC " ${zip_file} | ${wc} -l`
  if [ ${is_jrnl} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_jats} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndJATS"
  elif [ ${is_rsc} -eq 1 ]; then
    pkg_fmt="https://datahub.deepgreen.org/FilesAndRSC"
  else
    echo "error: no valid .xml (JATS or RSC) in zip archive found: stop."
    exit -2
  fi
else
  echo "error: no valid (or too many?!) .xml (JATS xor RSC) in zip archive found: stop."
  exit -3
fi

echo "`basename $0`: packaging format in zip archive found:"
echo "`basename $0`: ${pkg_fmt}"

${curl} -i -k -s -XPOST "${host_url}/api/v1/notification?api_key=${api_key}" -F "content=@${zip_file};type=application/zip" -F "metadata=@-;type=application/json" <<EOF
{
    "content" : {
        "packaging_format" : "${pkg_fmt}"
    }
}
EOF

echo

POST /validate?api_key=<api_key>
Content-Type: application/json

[Incoming Notification JSON]

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<comprehensible(!) error message (in english)>"
}

POST /notification?api_key=<api_key>
Content-Type: multipart/form-data; boundary=FulltextBoundary

--FulltextBoundary

Content-Disposition: form-data; name="metadata"
Content-Type: application/json

[Incoming Notification JSON]

--FulltextBoundary

Content-Disposition: form-data; name="content"
Content-Type: application/zip

[Package]

--FulltextBoundary--

POST /notification?api_key=<api_key>
Content-Type: multipart/form-data; boundary=FulltextBoundary

--FulltextBoundary

Content-Disposition: form-data; name="metadata"
Content-Type: application/json

{
    "content" : {
        "packaging_format" : "https://datahub.deepgreen.org/FilesAndJATS"
    }
}

--FulltextBoundary

Content-Disposition: form-data; name="content"
Content-Type: application/zip

[Package]

--FulltextBoundary--

HTTP 1.1  202 Accepted
Content-Type: application/json
Location: <URL of the api endpoint of the accepted delivery>

{
  "status" : "accepted",
  "id" : "<unique ID of this new notification>",
  "location" : "<URL of the api endpoint of this notification>"
}

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<comprehensible (!) error message (in english)>"
}

GET <http-Adresse/...>?since=<YYYY-MM-DD>
#
# Specification required; determines from when the notifications are listed
#

GET <http-Adresse/...>?pageSize=<number>
#
# Specification optional, preset to 25, maximum 100; determines how many data records are returned at once
#

GET <http-Adresse/...>?page=<number>
#
# Specification optional, defaults to 1; determines which side of the results is returned
#

GET <http-Adresse/...>?api_key=<api_key>
#
# Optional; this information is used to authenticate the request (e.g. for obtaining full texts)
#

{
  "analysis_date": "2016-08-09T14:22:11Z",
  "content": {
    "packaging_format": "string"
  },
  "created_date": "2016-08-09T14:22:11Z",
  "embargo": {
    "duration": 0
  },
  "id": "string",
  "issn_data": "string",
  "links": [
    {
      "format": "string",
      "packaging": "string",
      "type": "string",
      "url": "string"
    }
  ],
  "metadata": {
    "author": [
      {
        "affiliation": "string",
        "firstname": "string",
        "identifier": [
          {
            "id": "string",
            "type": "string"
          }
        ],
        "lastname": "string",
        "name": "string"
      }
    ],
    "date_accepted": "2016-08-09T14:22:11Z",
    "date_submitted": "2016-08-09T14:22:11Z",
    "fpage", "string",
    "identifier": [
      {
        "id": "string",
        "type": "string"
      }
    ],
    "issue", "string",
    "journal", "string",
    "license_ref": {
      "title": "string",
      "type": "string",
      "url": "string",
      "version": "string"
    },
    "lpage", "string",
    "project": [
      {
        "grant_number": "string",
        "identifier": [
          {
            "id": "string",
            "type": "string"
          }
        ],
        "name": "string"
      }
    ],
    "publication_date": "2016-08-09T14:22:11Z",
    "publisher": "string",
    "source": {
      "identifier": [
        {
          "id": "string",
          "type": "string"
        }
      ],
      "name": "string"
    },
    "subject": [
      "string"
    ],
    "title": "string",
    "volume": "string"
  }
}

GET /routed?since=<YYYY-MM-DD>[&<other params>]

HTTP 1.1  200 OK
Content-Type: application/json

{
  "since" : "<Date YYYY-MM-DDThh:mm:ssZ>",
  "page" : "<Page number of results>",
  "pageSize" : "<Number of results per page>",
  "timestamp" : "<Time stamp of query>",
  "total" : "<Number of results at this time>",
  "notifications" : [
     "<Liste der 'Outgoing Notification'-JSON objects>"
  ]
}

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<comprehensible (!) error message (in english)>"
}

GET /routed/<repo_id>?since=<YYYY-MM-DD>[&<other params>]

HTTP 1.1  200 OK
Content-Type: application/json

{
  "since" : "<Date YYYY-MM-DDThh:mm:ssZ>",
  "page" : "<Page number of results>",
  "pageSize" : "<Number of results per page>",
  "timestamp" : "<timestamp of query>",
  "total" : "<Number of results at this time>",
  "notifications" : [
     "<List of 'Outgoing Notification'-JSON objects>"
  ]
}

HTTP 1.1  400 Bad Request
Content-Type: application/json

{
  "error" : "<comprehensible(!) error message (in english)>"
}

GET /notification/<notification_id>

HTTP 1.1  200 OK
Content-Type: application/json

[Outgoing Notification JSON]

"links" : [
   {
     "type" : "package",
     "format" : "application/zip",
     "url" : "https://www.oa-deepgreen.de/api/v1/notification/123456789/content",
     "packaging" : "https://datahub.deepgreen.org/FilesAndJATS"
   },
   {
     "type" : "package",
     "format" : "application/zip",
     "url" : "https://www.oa-deepgreen.de/api/v1/notification/123456789/content/SimpleZip",
     "packaging" : "http://purl.org/net/sword/package/SimpleZip"
   }
 ]

GET <links url>?api_key=<api_key>

HTTP 1.1  200 OK
Content-Type: application/zip

[(binary) package]

GET /config?api_key=<api_key>

HTTP 1.1  200 OK
Content-Type: application/json

[matching criteria JSON]

POST /config?api_key=<api_key>
Content-Type: application/json; charset=utf-8

[Overwriting new match config settings JSON]

HTTP 1.1  200 OK
Content-Length: 0

{
  "name_variants": [
    "Academia Fridericiana Erlangensis",
    "Academia Friderico Alexandrina Erlangen-Nürnberg",
    "Academia Friderico-Alexandrina",
    "Academia Regia Bavarica Friderico-Alexandrina",
    "Academia Regia Friderico-Alexandrina",
    "Bayerische Friedrich-Alexanders-Universität",
    "F.A.U. Erlangen-Nürnberg",
    "University of Erlangen"
  ],
  "grants": [
    "2491691", "2673762", "6273863"
  ],
  "domains": [
    "fau.de", "uk-erlangen.de", "uni-erlangen.de"
  ],
  "keywords": [
    "research", "bavarian", "erlangen"
  ]
}

$ curl -s https://www.oa-deepgreen.de/oaipmh/...

GET /all[?<params (i.e. oai_verb + params)>]

GET /repo/<repo_id>[?<params (i.e. oai_verb + params)>]

$ curl -k -s https://www.oa-deepgreen.de/oaipmh/all?verb=Identify | xml_pp
<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
  <responseDate>2018-08-17T10:47:33Z</responseDate>
  <request verb="Identify">http://www.oa-deepgreen.de/oaipmh/all</request>
  <Identify>
    <repositoryName>DeepGreen Prototype OAI-PMH Endpoint</repositoryName>
    <baseURL>http://www.oa-deepgreen.de/oaipmh/all</baseURL>
    <protocolVersion>2.0</protocolVersion>
    <adminEmail>***</adminEmail>
    <earliestDatestamp>2018-05-19T08:47:33Z</earliestDatestamp>
    <deletedRecord>transient</deletedRecord>
    <granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
  </Identify>
</OAI-PMH>

GET <hhtp-Adresse/...>?verb=Identify
#
# This OAI verb has no further parameters
#

GET <http-Adresse/...>?verb=[ListIdentifiers|ListRecords]&from=<YYYY-MM-DD>
#
# Specification optional; determines from when the notifications are listed
#

GET <http-Adresse/...>?verb=[ListIdentifiers|ListRecords]&until=<YYYY-MM-DD>
#
# Specification optional, specifies a (maximum) end date until which the notifications are listed
#

GET <http-Adresse/...>?verb=GetRecord?identifier=<oai_id>
#
# Required; specifies the particular record to be fetched for this OAI verb.
#

HTTP 1.1  200 OK
Content-Type: text/xml; charset=utf-8

[XML response to OAI-PMH request;
 either content (e.g. list of records) or error message]

#
#  ListIdentifiers
#
$ curl -k -s "https://www.oa-deepgreen.de/oaipmh/repo/1234567890?verb=ListIdentifiers&metadataPrefix=oai_dc" | xml_pp
<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
  <responseDate>2018-08-20T12:03:31Z</responseDate>
  <request metadataPrefix="oai_dc" verb="ListIdentifiers">http://www.oa-deepgreen.de/oaipmh/repo/1234567890</request>
  <ListIdentifiers>
    <header xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
      <identifier>oai:www.oa-deepgreen.de/notification:*****</identifier>
      <datestamp>2018-08-03T07:56:26Z</datestamp>
    </header>
    <header xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
      <identifier>oai:www.oa-deepgreen.de/notification:*****</identifier>
      <datestamp>2018-07-04T12:41:44Z</datestamp>
    </header>
    <header xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
      <identifier>oai:www.oa-deepgreen.de/notification:*****</identifier>
      <datestamp>2018-06-18T13:39:04Z</datestamp>
    </header>
  </ListIdentifiers>
</OAI-PMH>

#
#  ListRecords
#
$ curl -k -s "https://www.oa-deepgreen.de/oaipmh/repo/1234567890?verb=ListRecords&metadataPrefix=oai_dc" | xml_pp
<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
  <responseDate>2018-08-20T12:24:10Z</responseDate>
  <request metadataPrefix="oai_dc" verb="ListRecords">http://www.oa-deepgreen.de/oaipmh/repo/1234567890</request>
  <ListRecords>
    <record>
      <header xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
        <identifier>oai:www.oa-deepgreen.de/notification:*****</identifier>
        <datestamp>2018-08-10T08:29:00Z</datestamp>
      </header>
      <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
        <oai_dc:dc xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
          <dc:title>Healthcare IT Utilization and Penetration among Physicians: Novel IT Solutions in Healthcare – Use and Acceptance in Hospitals</dc:title>
          <dc:publisher>S. Karger AG</dc:publisher>
          <dc:identifier>issn:0014-312X</dc:identifier>
          <dc:identifier>issn:1421-9921</dc:identifier>
          <dc:identifier>doi:10.1159/000490241</dc:identifier>
          <dc:creator>Ferdinand Vogt</dc:creator>
          <dc:creator>Fritz Seidl</dc:creator>
          <dc:creator>Giuseppe Santarpino</dc:creator>
          <dc:creator>Martijn van Griensven</dc:creator>
          <dc:creator>Martin Emmert</dc:creator>
          <dc:creator>Guenther Edenharter</dc:creator>
          <dc:creator>Dominik Pförringer</dc:creator>
          <dc:contributor>eDepartment of Anaesthesiology, Klinikum rechts der Isar, Technical University of Munich, Munich, Germany</dc:contributor>
          <dc:contributor>bDepartment of Trauma Surgery, Klinikum rechts der Isar, Technical University of Munich, Munich, Germany</dc:contributor>
          <dc:contributor>bDepartment of Trauma Surgery, Klinikum rechts der Isar, Technical University of Munich, Munich, Germany; cDepartment of Experimental Trauma Surgery, Klinikum rechts der Isar, Technical University of Munich, Munich, Germany</dc:contributor>
          <dc:contributor>aDepartment of Cardiac Surgery, Klinikum Nürnberg, Paracelsus Medical University, Nuremberg, Germany</dc:contributor>
          <dc:contributor>cDepartment of Experimental Trauma Surgery, Klinikum rechts der Isar, Technical University of Munich, Munich, Germany</dc:contributor>
          <dc:contributor>dInstitute of Management (IFM), School of Business and Economics, Friedrich Alexander University Erlangen-Nuremberg, Nuremberg, Germany</dc:contributor>
          <dc:date>2018-07-26T00:00:00Z</dc:date>
          <dc:rights>Alliance License DFG</dc:rights>
          <dc:subject>Original Paper</dc:subject>
          <dc:subject>Health monitoring</dc:subject>
          <dc:subject>Information technology</dc:subject>
          <dc:subject>Physicians</dc:subject>
          <dc:subject>Demand</dc:subject>
          <dc:subject>Outlook</dc:subject>
          <dc:subject>Expectations</dc:subject>
          <dc:subject>Data storage</dc:subject>
          <dc:subject>Healthcare IT</dc:subject>
        </oai_dc:dc>
      </metadata>
    </record>
    <record>
      <header xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
        <identifier>oai:www.oa-deepgreen.de/notification:*****</identifier>
        <datestamp>2018-08-10T08:34:06Z</datestamp>
      </header>
      <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
        <oai_dc:dc xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
          <dc:title>Gastrointestinal Stromal Tumors: Clinical Symptoms, Location, Metastasis Formation, and Associated Malignancies in a Single Center Retrospective Study</dc:title>
          <dc:publisher>S. Karger AG</dc:publisher>
          <dc:identifier>issn:0257-2753</dc:identifier>
          <dc:identifier>issn:1421-9875</dc:identifier>
          <dc:identifier>doi:10.1159/000489556</dc:identifier>
          <dc:creator>Ali Aghdassi</dc:creator>
          <dc:creator>Agnes Christoph</dc:creator>
          <dc:creator>Frank Dombrowski</dc:creator>
          <dc:creator>Paula Döring</dc:creator>
          <dc:creator>Christoph Barth</dc:creator>
          <dc:creator>Jan Christoph</dc:creator>
          <dc:creator>Markus M. Lerch</dc:creator>
          <dc:creator>Peter Simon</dc:creator>
          <dc:contributor>aDepartment of Medicine A, University Medicine Greifswald, Greifswald, Germany</dc:contributor>
          <dc:contributor>dChair of Medical Informatics, Friedrich-Alexander-University Erlangen-Nürnberg, Erlangen, Germany</dc:contributor>
          <dc:contributor>cGastroenterologische Praxis, Kempten, Germany</dc:contributor>
          <dc:contributor>bInstitute of Pathology, University Medicine Greifswald, Greifswald, Germany</dc:contributor>
          <dc:date>2018-06-05T00:00:00Z</dc:date>
          <dc:rights>Alliance License DFG</dc:rights>
          <dc:subject>Stomach and Duodenum: Original Paper</dc:subject>
          <dc:subject>Gastrointestinal stromal tumor</dc:subject>
          <dc:subject>Gastrointestinal oncology</dc:subject>
          <dc:subject>Gastrointestinal symptoms</dc:subject>
          <dc:subject>Gastrointestinal tract</dc:subject>
          <dc:subject>Metastasis</dc:subject>
          <dc:subject>Recurrence</dc:subject>
        </oai_dc:dc>
      </metadata>
    </record>
  </ListRecords>
</OAI-PMH>

Code	Description
204 No Content	Data package ok!
400 Bad Request	HTTP 1.1 400 Bad Request Content-Type: application/json { "error" : "<comprehensible(!) error message (in english)>" }
401 Unauthorised	e.g. invalid `api_key`, wrong user type

Field identifier	Describtion
analysis_date	Time of delivery analysis
content.packaging_format	Format of the associated binary package (usually .zip)
created_date	Time when the notification was created
embargo.duration	Embargo period (stated in months)
id	Persistent System ID for this notification
links.format	MIME type of the source
links.packaging	Package format of the source
links.type	Keyword for the type of source (e.g. package)
links.url	URL for the source (publisher- or system-side)
metadata.author.affiliation	Affiliation information, retrieved from the metadata
metadata.author.firstname	First name of an author
metadata.author.lastname	Surname of an author
metadata.author.name	Composite name of an author/originator
metadata.date_accepted	Date when the publication was accepted
metadata.date_submitted	Date when the publication was submitted
metadata.fpage	First page number of the publication
metadata.identifier.id	ID for the publication (e.g. DOI)
metadata.identifier.type	ID type (e.g. “doi”; however, no vocabulary)
metadata.issue	Issue count (journal issue)
metadata.journal	Name of the journal of the publication (journal title)
metadata.license_ref.title	Name of a licence (free text)
metadata.license_ref.type	Licence type (free text)
metadata.license_ref.url	URL leading to further licence information
metadata.license_ref.version	Version of a licence
metadata.lpage	Last page number of the publication
metadata.project.grant_number	Funding abbreviation, if indicated in the metadata
metadata.project.identifier.id	ID of a grant (e.g. Ringold)
metadata.project.identifier.type	ID type in relation to the funding ID
metadata.project.name	Name of a sponsor / a funding institution
metadata.publication_date	Publication date
metadata.publisher	Publisher name or publishing house
metadata.source.identifier.id	ID of the publication source (e.g. ISSN)
metadata.source.identifier.type	ID type of the publication source
metadata.source.name	Name of the publication source (journal title)
metadata.subject	Keyword
metadata.title	Publication title
metadata.volume	Volume Count (Journal Volume)

Code	Description
200 OK	HTTP 1.1 200 OK Content-Type: application/json [Outgoing Notification JSON]
404 Not Found	e.g. `notification_id` does not exist, or the notification could not (yet) be delivered and you are not the author (i.e. publisher) of the notification (authenticated via `api_key`)

Code	Description
200 OK	HTTP 1.1 200 OK Content-Type: application/zip [(binary) package]
401 Unauthorised	e.g. invalid `api_key`, wrong user type or the corresponding notification has not (yet) been delivered
404 Not Found	There is no content at the given URL or the URL simply does not exist.

Code	Description
200 OK	HTTP 1.1 200 OK Content-Type: application/json [matching criteria JSON]
401 Unauthorised	e.g. invalid `api_key`
404 Not Found	There is no content under the specified URL or the URL simply does not exist `GET /config/`)

Help

FAQ

Documentation

Forum

Screencasts

FAQ

Expectations, effort and costs

Legal and licenses

Registration

DeepGreen account information

Affiliation file

Technical

Documentation

Guides

Technical documentation

Available interfaces for publishers

SFTP

Verfügbare Schnittstellen für Repositorien

Web API (native)

Deliver article data to DeepGreen¶

Return values for `validation` (here the example: Deliver metadata only)¶

Return values for `notification` (Example: Delivering metadata including full text(s))¶

Receive article data from DeepGreen ¶

Full JSON schema for `Outgoing Notification` (sorted alphabetically by the keys)¶

List of all successfully delivered articles¶

List of articles delivered to an institution¶

Query of a specific article¶

Retrieval of the binary data of a notification¶

Query and update `match-config`-Ssettings for repositories¶

Update the `matching` criteria of a repository account¶

Metadata received from DeepGreen

Examples for the use of the OAI-PMH interface

Concordance NISO JATS to METSMODS

The repository account

The affiliation file

Example of an affiliation file

Forum

Screencasts

NISO JATS (tag)	METSMODS (xpath)	Allocation in METSMODS (example)
n/a	//mods/typeOfResource	text
n/a	//mods/genre	journal article
<article>	//mods/language/languageTerm	EN
<article-title>	//mods/titleInfo/title	A Short Discussion on…

//mods/relatedItem/[@type=”host”]/…
NISO JATS (tag)	METSMODS (xpath)	Allocation in METSMODS (example)
<journal-title>	titleInfo/title	Acta numerica
<journal-id>	identifier[@type=”publisher-id”]	Act. Num.
<issn>	identifier[@type=”eIssn”]	1234-234X
<issn>	identifier[@type=”pIssn”]	5432-9634
<volume>	part/detail[@type=”volume”]/number	7
<issue>	part/detail[@type=”issue”]/number	10
<fpage>	part/extent[@unit=”pages”]/start	521
<lpage>	part/extent[@unit=”pages”]/end	534

//mods/relatedItem/[@type=”host”]/…
NISO JATS (tag)	METSMODS (xpath)	Allocation in METSMODS (example)
<surname>	namePart[@type=”family”]	Hoppenstadt
<given-names>	namePart[@type=”given”]	Dickie M.
<contrib>	role/roleTerm[@type=”text”]	author
<contrib-id>	nameIdentifier[@type=”orcid”]	1111-1010-1111-0101
<aff>	affiliation	Zuse Institut Berlin

NISO JATS (tag)	METSMODS (xpath)	Allocation in METSMODS (example)
<abstract>	///mods/abstract	In this paper we will …
<kwd>	//mods/subject/topic	viscoelasticity