crossref-swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Crossref Unified Resource API",
    "version": "0.1",
    "description": "## Preamble\n\nThe Crossref REST API is one of [a variety of tools and APIs](https://www.crossref.org/services/metadata-retrieval/) that allow anybody to search and reuse our members' metadata in sophisticated ways.\n\nIf you read nothing else, please at least look at the [API TIPs](https://crossref.org/documentation/retrieve-metadata/rest-api/tips-for-using-the-crossref-rest-api/) document and the \"Etiquette\" section of this document. It will save you (and us) much heartburn.\n\n## Meta\n\n### Frequency of indexing\n\nRecords typically appear in the REST API within 20 minutes of their having been successfully deposited with Crossref.\n\nSummary information (e.g. counts, etc.) are processed in batch every 24 hours.\n\n### Learning about performance or availability problems\n\nWe record and report service issues on our [status page](http://status.crossref.org).\n\nYou might want to check this to see if we are already aware of a problem before you report it.\n\nWe also post notice of any ongoing performance problems with our services on our twitter feeds at [CrossrefOrg](https://twitter.com/CrossrefOrg) and [CrossrefSupport](https://twitter.com/@CrossrefSupport).\n\n### Reporting performance or availability problems\n\nReport performance/availability at our [support site](https://www.crossref.org/contact/).\n\n### Reporting bugs, requesting features\n\nPlease report bugs with the API or the documentation on our [issue tracker](https://gitlab.com/crossref/issues).\n\n### Documentation License\n\n<a rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"><img alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by/4.0/88x31.png\" /></a><br />This work is licensed under a <a rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\">Creative Commons Attribution 4.0 International License</a>.\n\n### Metadata License\n\nCrossref asserts no claims of ownership to individual items of bibliographic metadata and associated Digital Object Identifiers (DOIs) acquired through the use of the Crossref Free Services. Individual items of bibliographic metadata and associated DOIs may be cached and incorporated into the user's content and systems.\n\n### Privacy\n\nWe also have a [privacy policy](https://www.crossref.org/privacy/).\n\n### Libraries\n\nYou might be able to get to a quick start with this API if you instead use one of the several libraries that have been written for the Crossref REST API. For example: \n\n- [crossref-commons](https://gitlab.com/crossref/crossref_commons_py) (Python, developed by Crossref)\n- [habanero](https://github.com/sckott/habanero) (Python)\n- [serrano](https://github.com/sckott/serrano) (Ruby)\n- [rcrossref](https://github.com/ropensci/rcrossref) (R)\n- [crossrefapi](https://github.com/fabiobatalha/crossrefapi) (Python)\n- [crossref-rs](https://github.com/MattsSe/crossref-rs) (rust)\n- [pitaya](https://github.com/naustica/Pitaya) (Julia)\n- [Crossref API Typescript client](https://www.npmjs.com/package/@jamesgopsill/crossref-client) (Typescript)\n\nThe above libraries are not necessarily maintained nor endorsed by Crossref. If you know of another library you would like to see listed here, please let us know by contacting us at [support@crossref.org](mailto:support@crossref.org).\n\n### Etiquette\n\nWe want to provide a public, open, and free API for all. And we don't want to unnecessarily burden developers (or ourselves) with cumbersome API tokens or registration processes in order to use the public REST API. For that to work, we ask that you be polite and try not to do anything that will take the public REST API down or otherwise make it unusable for others. Specifically, we encourage the following polite behaviour:\n\n- Cache data so you don't request the same data over and over again.\n- Actively monitor API response times. If they start to go up, back-off for a while. For example, add pauses between requests and/or reduce the number of parallel requests.\n- Specify a `User-Agent` header that properly identifies your script or tool and that provides a means of contacting you via email using \"mailto:\". For example: `GroovyBib/1.1 (https://example.org/GroovyBib/; mailto:GroovyBib@example.org) BasedOnFunkyLib/1.4`. This way we can contact you if we see a problem.\n- report problems and/or ask questions on our [issue tracker](https://gitlab.com/crossref/issues).\n\nAlas, not all people are polite. And for this reason we reserve the right to impose rate limits and/or to block clients that are disrupting the public service.\n\n### Good manners = more reliable service\n\nBut we prefer carrots to sticks. As of September 18th 2017 any API queries that **use HTTPS and have appropriate contact information** will be directed to a special pool of API machines that are reserved for polite users.\n\nWhy are we doing this? Well- we don't want to force users to have to register with us. But this means that if some user of the public server writes a buggy script or ignores timeouts and errors- they can really bring the API service to its knees. What's more, it is very hard for us to identify these problem users because they tend to work off multiple parallel machines and use generic User-Agent headers. They are effectively anonymous. We're starting to have to spend a lot of time dealing with these problems and the degraded performance of the public API is affecting all the polite users as well.\n\nSo... we are keeping the public service as is. It will probably continue to fluctuate widely in performance. But now, if a client connects to the API using HTTPS and provides contact information either in their User-Agent header or as a parameter on their queries, then we will send them to a separate pool of machines. We expect to be able to better control the performance of these machines because, if a script starts causing problems, we can contact the people responsible for the script to ask them to fix it. Or, in extremis, we can block it.\n\nHow does it work? Simple. You can do one of two things to get directed to the \"polite pool\":\n\n1) Include a \"mailto\" parameter in your query. For example: `https://api.crossref.org/works?filter=has-full-text:true&mailto=GroovyBib@example.org`\n2) Include a \"mailto:\" in your User-Agent header. For example: `GroovyBib/1.1 (https://example.org/GroovyBib/; mailto:GroovyBib@example.org) BasedOnFunkyLib/1.4`.\n\nNote that this only works if you query the API using HTTPS. You really should be doing that anyway (wags finger).\n\n#### Frequently anticipated questions\n\n**Q:** Will you spam me with marketing [bumf](https://en.oxforddictionaries.com/definition/bumf) once you have our contact info?\n\n**A:** No. We will only use it to contact you about problems with your scripts.\n\n\n**Q:** Is this a secret plot to kill public access to your API?\n\n**A:** No. It is an attempt to keep the public API reliable.\n\n\n**Q:** What if I provide fake or incorrect contact info?\n\n**A:** That is not very polite. If there is a problem and you don't respond, we'll block you.\n\n\n**Q:** Does the contact info have to be a real name?\n\n**A:** No. As long as somebody actually receives and pays attention to email at the address, it can be pseudo-anonymous, or whatever.\n\n\n**Q:** How can I make sure that I am using the right pool?\n\n**A:** Every API response contains an `x-api-pool` HTTP header indicating the pool that was used to generate the response.\n\n#### Rate limits\n\nFrom time to time Crossref needs to impose rate limits to ensure that the free API is usable by all. Any rate limits that are in effect will be advertised in the `X-Rate-Limit-Limit` and `X-Rate-Limit-Interval` HTTP headers.\n\nFor ease-of-parsing, the `X-Rate-Limit-Interval` will always be expressed in seconds. So, for example the following tells you that you should expect to be able to perform 50 requests a second:\n\n```\nX-Rate-Limit-Limit: 50\nX-Rate-Limit-Interval: 1s\n```\n\nNote that if we wanted to adjust the measurement window, we could specify:\n\n```\nX-Rate-Limit-Limit: 3000\nX-Rate-Limit-Interval: 60s\n```\n\n#### Blocking\n\nThis is always our last resort, and you can generally avoid it if you include contact information in the `User-Agent` header or `mailto` parameter as described above.\n\nBut seriously... this is a bummer. We really want you to use the API. If you are polite about it, you shouldn't have any problems.\n\n### Use for production services\n\nWhat if you want to use our API for a production service that cannot depend on the performance uncertainties of the free and open public API? What if you don't want to be affected by impolite people who do not follow the API Etiquette guidelines? Well, if you’re interested in using these tools or APIs for production services, we [have a service-level offering](https://www.crossref.org/services/metadata-retrieval/metadata-plus/) called \"Plus\". This service provides you with access to all supported APIs and metadata, but with extra service and support guarantees.\n\n#### Authorization token for Plus service\n\nWhen you sign up for the Plus service, you will be issued an API token that you should put in the `Authorization` header of all your rest API requests. This token will ensure that said requests get directed to a pool of machines that are reserved for \"Plus\" SLA users. For example, with [curl](https://curl.haxx.se/):\n\n```\ncurl -X GET \\\n  https://api.crossref.org/works \\\n  -H 'Crossref-Plus-API-Token: Bearer yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vY3Jvc3NyZWYub3JnLyIsImF1ZXYZImVuaGFuY2VkY21zIiwianRpIjoiN0M5ODlFNTItMTFEQS00QkY3LUJCRUUtODFCMUM3QzE0OTZEIn0.NYe3-O066sce9R1fjMzNEvP88VqSEaYdBY622FDiG8Uq' \\\n  -H 'User-Agent: GroovyBib/1.1 (https://example.org/GroovyBib/; mailto:GroovyBib@example.org) BasedOnFunkyLib/1.4'\n```\n\nNote that you can still be \"polite\" and identify yourself as well. And, of course, replace the fake token above with the real token.\n\n## API overview\n\nThe API is generally RESTFUL and returns results in JSON.\n\nThe API supports HTTP and HTTPS. Examples here are provided using HTTPS.\n\nYou should always url-encode DOIs and parameter values when using the API. DOIs are notorious for including characters that break URLs (e.g. semicolons, hashes, slashes, ampersands, question marks, etc.).\n\nNote url-encoding applies to cursors as well since they too are likely to include characters that will break URLs (e.g. `+` symbol)\n\nNote that, for the sake of clarity, the examples in this document do *not* url-encode DOIs or parameter values.\n\nThe API will only work for Crossref DOIs. You can test the registration agency for a DOI using the following route:\n\n`https://api.crossref.org/works/{doi}/agency`\n\nTesting the following Crossref DOI:\n\n`10.1037/0003-066X.59.1.29`\n\nUsing the URL:\n\n`https://api.crossref.org/works/10.1037/0003-066X.59.1.29/agency`\n\nWill return the following result:\n\n    {\n      status: \"ok\",\n      message-type: \"work-agency\",\n      message-version: \"1.0.0\",\n      message: {\n        DOI: \"10.1037/0003-066x.59.1.29\",\n        agency: {\n          id: \"crossref\",\n          label: \"Crossref\"\n        }\n      }\n    }\n\nIf you use any of the API calls listed below with a non-Crossref DOI, you will get a `404` HTTP status response. Typical agency IDs include `crossref`, `datacite`, `medra` and also `public` for test DOIs.\n\n## Result types\n\nAll results are returned in JSON. There are three general types of results:\n\n- Singletons\n- Headers-only\n- Lists\n\nThe mime-type for API results is `application/vnd.crossref-api-message+json`\n\n### Singletons\n\nSingletons are single results. Retrieving metadata for a specific identifier (e.g. DOI, ISSN, funder identifier) typically returns a singleton result.\n\n### Headers only\n\nYou can use HTTP HEAD requests to quickly determine \"existence\" of a singleton. The advantage of this technique is that it is very fast because it does not return any metadata- it only returns headers and an HTTP status code (200=exists, 404=does not exist).\n\nTo determine if member ID `98` exists:\n\n`curl --head \"http://api.crossref.org/members/98\"`\n\nTo determine if a journal with ISSN `1549-7712` exists:\n\n`curl --head \"http://api.crossref.org/journals/1549-7712\"`\n\n### Lists\n\nLists results can contain multiple entries. Searching or filtering typically returns a list result. A list has two parts:\n\n- Summary, which include the following information:\n\n    - status (e.g. \"ok\", error)\n    - message-type (e.g. \"work-list\" )\n    - message-version (e.g. 1.0.0 )\n\n- Items, which will contain the items matching the query or filter.\n\nNote that the \"message-type\" returned will differ from the mime-type:\n\n- funder (singleton)\n- prefix (singleton)\n- member (singleton)\n- work (singleton)\n- work-list (list)\n- funder-list (list)\n- prefix-list (list)\n- member-list (list)\n\nNormally, an API list result will return both the summary and the items. If you want to just retrieve the summary, you can do so by specifying that the number of rows returned should be zero.\n\n#### Sort order\n\nIf the API call includes a query, then the sort order will be by the relevance score. If no query is included, then the sort order will be by DOI update date.\n\nThe API allows also for custom sorting. See the documentation for each endpoint to find the list of elements that you can sort by.\n\n#### Pagination\n\nLarge result sets can be traversed one of two ways: offsets or deep paging with cursor. Offsets are available on all `list` endpoints. Offsets are easier to use, but can be slow for larger sets, and the total number of results available through offsets is limited. Deep paging is available on selected endpoints, has better performance for large data sets, and there is no limit on total number of available results.\n\nSee the documentation for each endpoint for available paging options.\n",
    "contact": {
      "name": "Crossref",
      "email": "support@crossref.org",
      "url": "https://crossref.org"
    }
  },
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "tags": [
    {
      "name": "Funders",
      "description": "Endpoints that expose funder related data"
    },
    {
      "name": "Journals",
      "description": "Endpoints that expose journal related data"
    },
    {
      "name": "Works",
      "description": "Endpoints that expose works related data"
    },
    {
      "name": "Prefixes",
      "description": "Endpoints that expose prefix related data"
    },
    {
      "name": "Members",
      "description": "Endpoints that expose member related data"
    },
    {
      "name": "Types",
      "description": "Endpoints that expose type related data"
    },
    {
      "name": "Licenses",
      "description": "Endpoints that expose license related data"
    },
    {
      "name": "Deposits",
      "description": "Endpoints that expose deposit related data. *Note* **These endpoints will be deprecated in the near future.**"
    }
  ],
  "paths": {
    "/members/{id}/works": {
      "get": {
        "description": "Returns list of works associated with a Crossref member (deposited by a Crossref member) with {id}.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined with the general `query` parameter and each other. Each query parameter is ANDed with the others:\n\n##\n```\n/works?query.title=room+at+the+bottom&query.author=richard+feynman\n```\n\n##\n\nThis endpoint supports the following field queries:\n\n##\n\n+ `query.affiliation` - query contributor affiliations\n+ `query.author` - query author given and family names\n+ `query.bibliographic` - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years\n+ `query.chair` - query chair given and family names\n+ `query.container-title` - query container title aka. publication name\n+ `query.contributor` - query author, editor, chair and translator given and family names\n+ `query.degree` - query degree\n+ `query.description` - query description\n+ `query.editor` - query editor given and family names\n+ `query.event-acronym` - query acronym of the event\n+ `query.event-location` - query location of the event\n+ `query.event-name` - query name of the event\n+ `query.event-sponsor` - query sponsor of the event\n+ `query.event-theme` - query theme of the event\n+ `query.funder-name` - query name of the funder\n+ `query.publisher-location` - query location of the publisher\n+ `query.publisher-name` - query publisher name\n+ `query.standards-body-acronym` - query acronym of the standards body\n+ `query.standards-body-name` - query standards body name\n+ `query.title` - query title\n+ `query.translator` - query translator given and family names\n## Sort\n\nResults can be sorted by applying the `sort` and `order` parameters. `sort` sets the field by which results will be sorted. `order` sets the result ordering, either `asc` or `desc` (default is `desc`).\n\nAn example that sorts results in order of publication, beginning with the least recent:\n\n##\n\n```\n/works?query=josiah+carberry&sort=published&order=asc\n```\n\n##\n\nThis endpoint supports sorting by the following elements:\n\n##\n\n+ `created` - sort by created date\n+ `deposited` - sort by time of most recent deposit\n+ `indexed` - sort by time of most recent index\n+ `is-referenced-by-count` - sort by number of times this DOI is referenced by other Crossref DOIs\n+ `issued` - sort by issued date (earliest known publication date)\n+ `published` - sort by publication date\n+ `published-online` - sort by online publication date\n+ `published-print` - sort by print publication date\n+ `references-count` - sort by number of references included in the references section of the document identified by this DOI\n+ `relevance` - sort by relevance score\n+ `score` - sort by relevance score\n+ `updated` - sort by date of most recent change to metadata, currently the same as deposited\n## Facets\n\nFacet counts can be retrieved by enabling faceting. Facets are enabled by providing facet field names along with a maximum number of returned term values. The larger the number of returned values, the longer the query will take. Some facet fields can accept a `*` as their maximum, which indicates that all values should be returned.\n\n##\n\nFor example, to get facet counts for all work types:\n\n##\n```\n/works?facet=type-name:*\n```\n\n##\n\nThis endpoint supports the following facets:\n\n##\n\n+ `affiliation` - author affiliation\n+ `archive` - archive location\n+ `assertion` - custom Crossmark assertion name\n+ `assertion-group` - custom Crossmark assertion group name\n+ `category-name` - category name of work\n+ `container-title` - [max value 100], work container title, such as journal title, or book title\n+ `funder-doi` - funder DOI\n+ `funder-name` - funder literal name as deposited alongside DOI\n+ `issn` - [max value 100], journal ISSN (any - print, electronic, link)\n+ `journal-issue` - journal issue number\n+ `journal-volume` - journal volume\n+ `license` - license URI of work\n+ `link-application` - intended application of the full text link\n+ `orcid` - [max value 100], contributor ORCID\n+ `published` - earliest year of publication\n+ `publisher-name` - publisher name of work\n+ `relation-type` - relation type described by work or described by another work with work as object\n+ `ror-id` - institution ROR ID\n+ `source` - source of the DOI\n+ `type-name` - work type name, such as journal-article or book-chapter\n+ `update-type` - significant update type\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nFor example:\n\n##\n```\n/works?filter=type:dataset\n```\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `is-update:true`\n- `from-pub-date:2014-03-03`\n- `funder:10.13039/100000001`\n- `funder:10.13039/100000050`\n\nwould locate documents that are updates, were published on or after 3rd March 2014 and were funded by either the National Science Foundation (`10.13039/100000001`) or the National Heart, Lung, and Blood Institute (`10.13039/100000050`). These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/works?filter=is-update:true,from-pub-date:2014-03-03,funder:10.13039/100000001,funder:10.13039/100000050\n```\n\n### Dot filters\n\nA filter with a dot in its name is special. The dot signifies that the filter will be applied to some other record type that is related to primary resource record type. For example, with work queries, one can filter on works that have an award, where the same award has a particular award number and award-giving funding agency:\n\n##\n```\n/works?filter=award.number:CBET-0756451,award.funder:10.13039/100000001\n```\n##\n\nHere we filter on works that have an award by the National Science Foundation that also has the award number `CBET-0756451`.\n\n### Note on dates\n\nThe dates in filters should always be of the form YYYY-MM-DD, YYYY-MM or YYYY. The date filters are inclusive. For example:\n\n* `from-pub-date:2018-09-18` filters works published on or after 18th September 2018\n* `from-created-date:2016-02-29,until-created-date:2016-02-29` filters works first deposited on 29th February 2016\n* `until-created-date:2010-06` filters works first deposited in or before June 2010\n* `from-update-date:2017,until-update-date:2017` filters works with metadata updated in 2017\n\nAlso note that date information in Crossref metadata can often be incomplete. So, for example, a publisher may only include the year and month of publication for a journal article. For a monograph they might just include the year. In these cases the API selects the earliest possible date given the information provided. So, for instance, if the publisher only provided 2013-02 as the published date, then the date would be treated as 2013-02-01. Similarly, if the publisher only provided the year 2013 as the date, it would be treated at 2013-01-01.\n\n### Note on owner prefixes\n\nThe prefix of a Crossref DOI does **NOT** indicate who currently owns the DOI. It only reflects who originally registered the DOI. Crossref metadata has an **prefix** element that records the current owner of the Crossref DOI in question.\n\n##\n\nCrossref also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used.\n\n### Notes on incremental metadata updates\n\nWhen using time filters to retrieve periodic, incremental metadata updates, the `from-index-date` filter should be used over `from-update-date`, `from-deposit-date`, `from-created-date` and `from-pub-date`. The timestamp that `from-index-date` filters on is guaranteed to be updated every time there is a change to metadata requiring a reindex.\n\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `alternative-id` - metadata for records with the given alternative ID, which may be a publisher-specific ID, or any other identifier a publisher may have provided\n+ `archive` - metadata where value of archive partner equals given archive name\n+ `article-number` - metadata for records with a given article number\n+ `assertion` - metadata for records with a given named assertion\n+ `assertion-group` - metadata for records with an assertion in a given group\n+ `award`\n  + `award.funder` - metadata for records with award funder equal to given funder, optionally combine with `award.number`\n  + `award.number` - metadata for records with award number equal to given number, optionally combine with `award.funder`\n+ `category-name` - metadata for records with category label equal to given name, category labels come from the list published by Scopus\n+ `citation-id`\n+ `clinical-trial-number` - metadata for records with given clinical trial number\n+ `container-title` - metadata with a publication title that exactly equals given title\n+ `content-domain` - metadata where the publisher records a given domain name as the location Crossmark content will appear\n+ `doi` - metadata describing given DOI\n+ `from-accepted-date` - [date], metadata where accepted date is since given date (inclusive)\n+ `from-approved-date` - [date], metadata where approved date is since given date (inclusive)\n+ `from-awarded-date` - [date], metadata where award date is since given date (inclusive)\n+ `from-created-date` - [date], metadata first deposited since given date (inclusive)\n+ `from-deposit-date` - [date], metadata last (re)deposited since given date (inclusive)\n+ `from-event-end-date` - [date], metadata where event end date is since given date (inclusive)\n+ `from-event-start-date` - [date], metadata where event start date is since given date  (inclusive)\n+ `from-index-date` - [date], metadata indexed since given date (inclusive)\n+ `from-issued-date` - [date], metadata where issued date is since given date  (inclusive)\n+ `from-online-pub-date` - [date], metadata where online published date is since given date (inclusive)\n+ `from-posted-date` - [date], metadata where posted date is since given date (inclusive)\n+ `from-print-pub-date` - [date], metadata where print published date is since given date (inclusive)\n+ `from-pub-date` - [date], metadata where published date is since given date (inclusive)\n+ `from-update-date` - [date], metadata updated since given date (inclusive), currently the same as `from-deposit-date`\n+ `full-text`\n  + `full-text.type` - metadata where `resource` element's `content_type` attribute equals given version mime type (e.g. application/pdf)\n  + `full-text.application` - [text-mining, similarity-checking or unspecified], metadata where `resource` link has given application\n  + `full-text.version` - metadata where `resource` element's `content_version` attribute equals given version\n+ `funder` - metadata which include given funder id in FundRef data\n+ `funder-doi-asserted-by` - metadata where funder DOI was asserted by given body\n+ `group-title` - metadata with given group title\n+ `gte-award-amount` - metadata where award is greater than or equals given number\n+ `has-abstract` - [0 or 1], metadata for records with/without an abstract\n+ `has-affiliation` - [0 or 1], metadata for records with/without affiliation information\n+ `has-archive` - [0 or 1], metadata which includes/does not include name of archive partner\n+ `has-assertion` - [0 or 1], metadata for records with/without assertions\n+ `has-authenticated-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID\n+ `has-award` - [0 or 1], metadata for records with/without award\n+ `has-clinical-trial-number` - [0 or 1], metadata for records with/without a clinical trial number\n+ `has-content-domain` - [0 or 1], metadata where the publisher records/does not record a domain name location for Crossmark content\n+ `has-description`\n+ `has-domain-restriction` - [0 or 1], metadata where the publisher restricts/does not restrict Crossmark usage to content domains\n+ `has-event` - [0 or 1], metadata for records with/without event\n+ `has-full-text` - [0 or 1], metadata that includes/does not include any full text `resource` elements\n+ `has-funder` - [0 or 1], metadata which includes/does not include one or more funder entry\n+ `has-funder-doi` - [0 or 1], metadata for records with/without funder DOI\n+ `has-license` - [0 or 1], metadata that includes/does not include any `license_ref` elements\n+ `has-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs\n+ `has-references` - [0 or 1], metadata for works that have/don't have a list of references\n+ `has-relation` - [0 or 1], metadata for records that either assert/do not assert or are/are not the object of a relation\n+ `has-ror-id` - [0 or 1], metadata for records with/without ROR ID\n+ `has-update` - [0 or 1], metadata for records with/without update information\n+ `has-update-policy` - [0 or 1], metadata for records that include/do not include a link to an editorial update policy\n+ `is-update` - [0 or 1], metadata for records that represent/do not represent editorial updates\n+ `isbn` - metadata with given ISBN\n+ `issn` - metadata with given ISSN, format is xxxx-xxxx\n+ `license`\n  + `license.url` - metadata where `license_ref` value equals given url\n  + `license.version` - metadata where the `license_ref`'s `applies_to` attribute equals given version\n  + `license.delay` - metadata where difference between publication date and the `license_ref`'s `start_date` attribute is <= than given delay (in days)\n+ `lte-award-amount` - metadata where award is less than or equals given number\n+ `member` - metadata belonging to a given Crossref member\n+ `orcid` - metadata where there is a contributor with given ORCID\n+ `prefix` - metadata belonging to a given DOI owner prefix (e.g. 10.1016)\n+ `relation`\n  + `relation.type` - metadata for records with a relation with the given type from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)\n  + `relation.object-type` - metadata for records with a relation, where the object type matches given type from the Crossref relations schema (e.g. doi, issn)\n  + `relation.object` - metadata for records with a relation, where the object identifier matches given identifier\n+ `ror-id` - metadata with given ROR ID\n+ `type` - metadata records whose type equals given type, type must be an ID value from the list of types returned by the /types resource\n+ `type-name` - metadata for records with type name equal to given name\n+ `until-accepted-date` - [date], metadata where accepted date is before given date (inclusive)\n+ `until-approved-date` - [date], metadata where approved date is before given date (inclusive)\n+ `until-awarded-date` - [date], metadata where award date is before given date (inclusive)\n+ `until-created-date` - [date], metadata first deposited before given date (inclusive)\n+ `until-deposit-date` - [date], metadata last (re)deposited before given date (inclusive)\n+ `until-event-end-date` - [date], metadata where event end date is before given date (inclusive)\n+ `until-event-start-date` - [date], metadata where event start date is before given date  (inclusive)\n+ `until-index-date` - [date], metadata indexed before given date (inclusive)\n+ `until-issued-date` - [date], metadata where issued date is before given date  (inclusive)\n+ `until-online-pub-date` - [date], metadata where online published date is before given date (inclusive)\n+ `until-posted-date` - [date], metadata where posted date is before given date (inclusive)\n+ `until-print-pub-date` - [date], metadata where print published date is before given date (inclusive)\n+ `until-pub-date` - [date], metadata where published date is before given date (inclusive)\n+ `until-update-date` - [date], metadata updated before given date (inclusive), currently the same as `until-deposit-date`\n+ `update-type` - metadata with given update type\n+ `updates` - metadata for records that represent editorial updates to given DOI\n## Elements\n\nCrossref metadata records can be quite large. Sometimes you just want a few elements from the schema. You can \\\"select\\\" a subset of elements to return using the `select` parameter. This can make your API calls much more efficient. For example:\n\n##\n```\n/works?select=DOI,prefix,title\n```\n\n##\n\nThis endpoint supports selecting the following elements.\n\n##\n\n+ `DOI`\n+ `ISBN`\n+ `ISSN`\n+ `URL`\n+ `abstract`\n+ `accepted`\n+ `alternative-id`\n+ `approved`\n+ `archive`\n+ `article-number`\n+ `assertion`\n+ `author`\n+ `chair`\n+ `clinical-trial-number`\n+ `container-title`\n+ `content-created`\n+ `content-domain`\n+ `created`\n+ `degree`\n+ `deposited`\n+ `editor`\n+ `event`\n+ `funder`\n+ `group-title`\n+ `indexed`\n+ `is-referenced-by-count`\n+ `issn-type`\n+ `issue`\n+ `issued`\n+ `license`\n+ `link`\n+ `member`\n+ `original-title`\n+ `page`\n+ `posted`\n+ `prefix`\n+ `published`\n+ `published-online`\n+ `published-print`\n+ `publisher`\n+ `publisher-location`\n+ `reference`\n+ `references-count`\n+ `relation`\n+ `score`\n+ `short-container-title`\n+ `short-title`\n+ `standards-body`\n+ `subject`\n+ `subtitle`\n+ `title`\n+ `translator`\n+ `type`\n+ `update-policy`\n+ `update-to`\n+ `updated-by`\n+ `volume`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n\n## Sample\n\nBeing able to select random results is useful for both testing and sampling. You can use the `sample` parameter to retrieve random results. So, for example, the following selects 10 random works:\n\n##\n```\n/works?sample=10\n```\n##\n\nNote that when you use the `sample` parameter, the `rows` and `offset` parameters are ignored.\n\n\n## Parameter combinations\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` can be used with offsets. Sampling cannot be combined with offsets.\n\n##\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` may also be used with deep paging cursors. `rows` may also be specified.\n\n##\n\n`offset` and `sample` cannot be used in combination with cursors.\n\n##\n",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Crossref member ID",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "order",
            "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc",
            "required": false,
            "pattern": "(asc|desc)",
            "type": "string"
          },
          {
            "in": "query",
            "name": "facet",
            "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "sample",
            "description": "Exposes the ability to return `N` randomly sampled items",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Exposes the ability to sort results by a certain field, e.g. `score`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "select",
            "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`",
            "required": false,
            "pattern": "^\\w+(,\\w+)*$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorksMessage"
            },
            "description": "A list of works"
          }
        },
        "tags": [
          "Members"
        ]
      }
    },
    "/journals": {
      "get": {
        "description": "Return a list of journals in the Crossref database.\n## Queries\n\nFree form search queries can be made, for example, journals that include `pharmacy` and `health`:\n\n##\n\n```\n/journals?query=pharmacy+health\n```\n\n\n## Pagination with offsets\n\nOffsets can be used to iterate over the results. For this route, the maximum number of available results is 80,000, which in this case allows to retrieve all the indexed items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/JournalsMessage"
            },
            "description": "A list of journals"
          }
        },
        "tags": [
          "Journals"
        ]
      }
    },
    "/members/{id}": {
      "get": {
        "description": "Returns metadata for a Crossref member, as an example use id 324",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/MemberMessage"
            },
            "description": "The prefix data identified by {id}."
          },
          "404": {
            "description": "The prefix data identified by {id} does not exist."
          }
        },
        "tags": [
          "Members"
        ]
      }
    },
    "/prefixes/{prefix}/works": {
      "get": {
        "description": "Returns list of works associated with specified {prefix}.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined with the general `query` parameter and each other. Each query parameter is ANDed with the others:\n\n##\n```\n/works?query.title=room+at+the+bottom&query.author=richard+feynman\n```\n\n##\n\nThis endpoint supports the following field queries:\n\n##\n\n+ `query.affiliation` - query contributor affiliations\n+ `query.author` - query author given and family names\n+ `query.bibliographic` - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years\n+ `query.chair` - query chair given and family names\n+ `query.container-title` - query container title aka. publication name\n+ `query.contributor` - query author, editor, chair and translator given and family names\n+ `query.degree` - query degree\n+ `query.description` - query description\n+ `query.editor` - query editor given and family names\n+ `query.event-acronym` - query acronym of the event\n+ `query.event-location` - query location of the event\n+ `query.event-name` - query name of the event\n+ `query.event-sponsor` - query sponsor of the event\n+ `query.event-theme` - query theme of the event\n+ `query.funder-name` - query name of the funder\n+ `query.publisher-location` - query location of the publisher\n+ `query.publisher-name` - query publisher name\n+ `query.standards-body-acronym` - query acronym of the standards body\n+ `query.standards-body-name` - query standards body name\n+ `query.title` - query title\n+ `query.translator` - query translator given and family names\n## Sort\n\nResults can be sorted by applying the `sort` and `order` parameters. `sort` sets the field by which results will be sorted. `order` sets the result ordering, either `asc` or `desc` (default is `desc`).\n\nAn example that sorts results in order of publication, beginning with the least recent:\n\n##\n\n```\n/works?query=josiah+carberry&sort=published&order=asc\n```\n\n##\n\nThis endpoint supports sorting by the following elements:\n\n##\n\n+ `created` - sort by created date\n+ `deposited` - sort by time of most recent deposit\n+ `indexed` - sort by time of most recent index\n+ `is-referenced-by-count` - sort by number of times this DOI is referenced by other Crossref DOIs\n+ `issued` - sort by issued date (earliest known publication date)\n+ `published` - sort by publication date\n+ `published-online` - sort by online publication date\n+ `published-print` - sort by print publication date\n+ `references-count` - sort by number of references included in the references section of the document identified by this DOI\n+ `relevance` - sort by relevance score\n+ `score` - sort by relevance score\n+ `updated` - sort by date of most recent change to metadata, currently the same as deposited\n## Facets\n\nFacet counts can be retrieved by enabling faceting. Facets are enabled by providing facet field names along with a maximum number of returned term values. The larger the number of returned values, the longer the query will take. Some facet fields can accept a `*` as their maximum, which indicates that all values should be returned.\n\n##\n\nFor example, to get facet counts for all work types:\n\n##\n```\n/works?facet=type-name:*\n```\n\n##\n\nThis endpoint supports the following facets:\n\n##\n\n+ `affiliation` - author affiliation\n+ `archive` - archive location\n+ `assertion` - custom Crossmark assertion name\n+ `assertion-group` - custom Crossmark assertion group name\n+ `category-name` - category name of work\n+ `container-title` - [max value 100], work container title, such as journal title, or book title\n+ `funder-doi` - funder DOI\n+ `funder-name` - funder literal name as deposited alongside DOI\n+ `issn` - [max value 100], journal ISSN (any - print, electronic, link)\n+ `journal-issue` - journal issue number\n+ `journal-volume` - journal volume\n+ `license` - license URI of work\n+ `link-application` - intended application of the full text link\n+ `orcid` - [max value 100], contributor ORCID\n+ `published` - earliest year of publication\n+ `publisher-name` - publisher name of work\n+ `relation-type` - relation type described by work or described by another work with work as object\n+ `ror-id` - institution ROR ID\n+ `source` - source of the DOI\n+ `type-name` - work type name, such as journal-article or book-chapter\n+ `update-type` - significant update type\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nFor example:\n\n##\n```\n/works?filter=type:dataset\n```\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `is-update:true`\n- `from-pub-date:2014-03-03`\n- `funder:10.13039/100000001`\n- `funder:10.13039/100000050`\n\nwould locate documents that are updates, were published on or after 3rd March 2014 and were funded by either the National Science Foundation (`10.13039/100000001`) or the National Heart, Lung, and Blood Institute (`10.13039/100000050`). These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/works?filter=is-update:true,from-pub-date:2014-03-03,funder:10.13039/100000001,funder:10.13039/100000050\n```\n\n### Dot filters\n\nA filter with a dot in its name is special. The dot signifies that the filter will be applied to some other record type that is related to primary resource record type. For example, with work queries, one can filter on works that have an award, where the same award has a particular award number and award-giving funding agency:\n\n##\n```\n/works?filter=award.number:CBET-0756451,award.funder:10.13039/100000001\n```\n##\n\nHere we filter on works that have an award by the National Science Foundation that also has the award number `CBET-0756451`.\n\n### Note on dates\n\nThe dates in filters should always be of the form YYYY-MM-DD, YYYY-MM or YYYY. The date filters are inclusive. For example:\n\n* `from-pub-date:2018-09-18` filters works published on or after 18th September 2018\n* `from-created-date:2016-02-29,until-created-date:2016-02-29` filters works first deposited on 29th February 2016\n* `until-created-date:2010-06` filters works first deposited in or before June 2010\n* `from-update-date:2017,until-update-date:2017` filters works with metadata updated in 2017\n\nAlso note that date information in Crossref metadata can often be incomplete. So, for example, a publisher may only include the year and month of publication for a journal article. For a monograph they might just include the year. In these cases the API selects the earliest possible date given the information provided. So, for instance, if the publisher only provided 2013-02 as the published date, then the date would be treated as 2013-02-01. Similarly, if the publisher only provided the year 2013 as the date, it would be treated at 2013-01-01.\n\n### Note on owner prefixes\n\nThe prefix of a Crossref DOI does **NOT** indicate who currently owns the DOI. It only reflects who originally registered the DOI. Crossref metadata has an **prefix** element that records the current owner of the Crossref DOI in question.\n\n##\n\nCrossref also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used.\n\n### Notes on incremental metadata updates\n\nWhen using time filters to retrieve periodic, incremental metadata updates, the `from-index-date` filter should be used over `from-update-date`, `from-deposit-date`, `from-created-date` and `from-pub-date`. The timestamp that `from-index-date` filters on is guaranteed to be updated every time there is a change to metadata requiring a reindex.\n\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `alternative-id` - metadata for records with the given alternative ID, which may be a publisher-specific ID, or any other identifier a publisher may have provided\n+ `archive` - metadata where value of archive partner equals given archive name\n+ `article-number` - metadata for records with a given article number\n+ `assertion` - metadata for records with a given named assertion\n+ `assertion-group` - metadata for records with an assertion in a given group\n+ `award`\n  + `award.funder` - metadata for records with award funder equal to given funder, optionally combine with `award.number`\n  + `award.number` - metadata for records with award number equal to given number, optionally combine with `award.funder`\n+ `category-name` - metadata for records with category label equal to given name, category labels come from the list published by Scopus\n+ `citation-id`\n+ `clinical-trial-number` - metadata for records with given clinical trial number\n+ `container-title` - metadata with a publication title that exactly equals given title\n+ `content-domain` - metadata where the publisher records a given domain name as the location Crossmark content will appear\n+ `doi` - metadata describing given DOI\n+ `from-accepted-date` - [date], metadata where accepted date is since given date (inclusive)\n+ `from-approved-date` - [date], metadata where approved date is since given date (inclusive)\n+ `from-awarded-date` - [date], metadata where award date is since given date (inclusive)\n+ `from-created-date` - [date], metadata first deposited since given date (inclusive)\n+ `from-deposit-date` - [date], metadata last (re)deposited since given date (inclusive)\n+ `from-event-end-date` - [date], metadata where event end date is since given date (inclusive)\n+ `from-event-start-date` - [date], metadata where event start date is since given date  (inclusive)\n+ `from-index-date` - [date], metadata indexed since given date (inclusive)\n+ `from-issued-date` - [date], metadata where issued date is since given date  (inclusive)\n+ `from-online-pub-date` - [date], metadata where online published date is since given date (inclusive)\n+ `from-posted-date` - [date], metadata where posted date is since given date (inclusive)\n+ `from-print-pub-date` - [date], metadata where print published date is since given date (inclusive)\n+ `from-pub-date` - [date], metadata where published date is since given date (inclusive)\n+ `from-update-date` - [date], metadata updated since given date (inclusive), currently the same as `from-deposit-date`\n+ `full-text`\n  + `full-text.type` - metadata where `resource` element's `content_type` attribute equals given version mime type (e.g. application/pdf)\n  + `full-text.application` - [text-mining, similarity-checking or unspecified], metadata where `resource` link has given application\n  + `full-text.version` - metadata where `resource` element's `content_version` attribute equals given version\n+ `funder` - metadata which include given funder id in FundRef data\n+ `funder-doi-asserted-by` - metadata where funder DOI was asserted by given body\n+ `group-title` - metadata with given group title\n+ `gte-award-amount` - metadata where award is greater than or equals given number\n+ `has-abstract` - [0 or 1], metadata for records with/without an abstract\n+ `has-affiliation` - [0 or 1], metadata for records with/without affiliation information\n+ `has-archive` - [0 or 1], metadata which includes/does not include name of archive partner\n+ `has-assertion` - [0 or 1], metadata for records with/without assertions\n+ `has-authenticated-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID\n+ `has-award` - [0 or 1], metadata for records with/without award\n+ `has-clinical-trial-number` - [0 or 1], metadata for records with/without a clinical trial number\n+ `has-content-domain` - [0 or 1], metadata where the publisher records/does not record a domain name location for Crossmark content\n+ `has-description`\n+ `has-domain-restriction` - [0 or 1], metadata where the publisher restricts/does not restrict Crossmark usage to content domains\n+ `has-event` - [0 or 1], metadata for records with/without event\n+ `has-full-text` - [0 or 1], metadata that includes/does not include any full text `resource` elements\n+ `has-funder` - [0 or 1], metadata which includes/does not include one or more funder entry\n+ `has-funder-doi` - [0 or 1], metadata for records with/without funder DOI\n+ `has-license` - [0 or 1], metadata that includes/does not include any `license_ref` elements\n+ `has-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs\n+ `has-references` - [0 or 1], metadata for works that have/don't have a list of references\n+ `has-relation` - [0 or 1], metadata for records that either assert/do not assert or are/are not the object of a relation\n+ `has-ror-id` - [0 or 1], metadata for records with/without ROR ID\n+ `has-update` - [0 or 1], metadata for records with/without update information\n+ `has-update-policy` - [0 or 1], metadata for records that include/do not include a link to an editorial update policy\n+ `is-update` - [0 or 1], metadata for records that represent/do not represent editorial updates\n+ `isbn` - metadata with given ISBN\n+ `issn` - metadata with given ISSN, format is xxxx-xxxx\n+ `license`\n  + `license.url` - metadata where `license_ref` value equals given url\n  + `license.version` - metadata where the `license_ref`'s `applies_to` attribute equals given version\n  + `license.delay` - metadata where difference between publication date and the `license_ref`'s `start_date` attribute is <= than given delay (in days)\n+ `lte-award-amount` - metadata where award is less than or equals given number\n+ `member` - metadata belonging to a given Crossref member\n+ `orcid` - metadata where there is a contributor with given ORCID\n+ `prefix` - metadata belonging to a given DOI owner prefix (e.g. 10.1016)\n+ `relation`\n  + `relation.type` - metadata for records with a relation with the given type from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)\n  + `relation.object-type` - metadata for records with a relation, where the object type matches given type from the Crossref relations schema (e.g. doi, issn)\n  + `relation.object` - metadata for records with a relation, where the object identifier matches given identifier\n+ `ror-id` - metadata with given ROR ID\n+ `type` - metadata records whose type equals given type, type must be an ID value from the list of types returned by the /types resource\n+ `type-name` - metadata for records with type name equal to given name\n+ `until-accepted-date` - [date], metadata where accepted date is before given date (inclusive)\n+ `until-approved-date` - [date], metadata where approved date is before given date (inclusive)\n+ `until-awarded-date` - [date], metadata where award date is before given date (inclusive)\n+ `until-created-date` - [date], metadata first deposited before given date (inclusive)\n+ `until-deposit-date` - [date], metadata last (re)deposited before given date (inclusive)\n+ `until-event-end-date` - [date], metadata where event end date is before given date (inclusive)\n+ `until-event-start-date` - [date], metadata where event start date is before given date  (inclusive)\n+ `until-index-date` - [date], metadata indexed before given date (inclusive)\n+ `until-issued-date` - [date], metadata where issued date is before given date  (inclusive)\n+ `until-online-pub-date` - [date], metadata where online published date is before given date (inclusive)\n+ `until-posted-date` - [date], metadata where posted date is before given date (inclusive)\n+ `until-print-pub-date` - [date], metadata where print published date is before given date (inclusive)\n+ `until-pub-date` - [date], metadata where published date is before given date (inclusive)\n+ `until-update-date` - [date], metadata updated before given date (inclusive), currently the same as `until-deposit-date`\n+ `update-type` - metadata with given update type\n+ `updates` - metadata for records that represent editorial updates to given DOI\n## Elements\n\nCrossref metadata records can be quite large. Sometimes you just want a few elements from the schema. You can \\\"select\\\" a subset of elements to return using the `select` parameter. This can make your API calls much more efficient. For example:\n\n##\n```\n/works?select=DOI,prefix,title\n```\n\n##\n\nThis endpoint supports selecting the following elements.\n\n##\n\n+ `DOI`\n+ `ISBN`\n+ `ISSN`\n+ `URL`\n+ `abstract`\n+ `accepted`\n+ `alternative-id`\n+ `approved`\n+ `archive`\n+ `article-number`\n+ `assertion`\n+ `author`\n+ `chair`\n+ `clinical-trial-number`\n+ `container-title`\n+ `content-created`\n+ `content-domain`\n+ `created`\n+ `degree`\n+ `deposited`\n+ `editor`\n+ `event`\n+ `funder`\n+ `group-title`\n+ `indexed`\n+ `is-referenced-by-count`\n+ `issn-type`\n+ `issue`\n+ `issued`\n+ `license`\n+ `link`\n+ `member`\n+ `original-title`\n+ `page`\n+ `posted`\n+ `prefix`\n+ `published`\n+ `published-online`\n+ `published-print`\n+ `publisher`\n+ `publisher-location`\n+ `reference`\n+ `references-count`\n+ `relation`\n+ `score`\n+ `short-container-title`\n+ `short-title`\n+ `standards-body`\n+ `subject`\n+ `subtitle`\n+ `title`\n+ `translator`\n+ `type`\n+ `update-policy`\n+ `update-to`\n+ `updated-by`\n+ `volume`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n\n## Sample\n\nBeing able to select random results is useful for both testing and sampling. You can use the `sample` parameter to retrieve random results. So, for example, the following selects 10 random works:\n\n##\n```\n/works?sample=10\n```\n##\n\nNote that when you use the `sample` parameter, the `rows` and `offset` parameters are ignored.\n\n\n## Parameter combinations\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` can be used with offsets. Sampling cannot be combined with offsets.\n\n##\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` may also be used with deep paging cursors. `rows` may also be specified.\n\n##\n\n`offset` and `sample` cannot be used in combination with cursors.\n\n##\n",
        "parameters": [
          {
            "in": "path",
            "name": "prefix",
            "description": "",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "order",
            "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc",
            "required": false,
            "pattern": "(asc|desc)",
            "type": "string"
          },
          {
            "in": "query",
            "name": "facet",
            "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "sample",
            "description": "Exposes the ability to return `N` randomly sampled items",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Exposes the ability to sort results by a certain field, e.g. `score`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "select",
            "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`",
            "required": false,
            "pattern": "^\\w+(,\\w+)*$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorksMessage"
            },
            "description": "A list of works"
          }
        },
        "tags": [
          "Prefixes"
        ]
      }
    },
    "/funders/{id}/works": {
      "get": {
        "description": "Returns list of works associated with the specified {id}.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined with the general `query` parameter and each other. Each query parameter is ANDed with the others:\n\n##\n```\n/works?query.title=room+at+the+bottom&query.author=richard+feynman\n```\n\n##\n\nThis endpoint supports the following field queries:\n\n##\n\n+ `query.affiliation` - query contributor affiliations\n+ `query.author` - query author given and family names\n+ `query.bibliographic` - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years\n+ `query.chair` - query chair given and family names\n+ `query.container-title` - query container title aka. publication name\n+ `query.contributor` - query author, editor, chair and translator given and family names\n+ `query.degree` - query degree\n+ `query.description` - query description\n+ `query.editor` - query editor given and family names\n+ `query.event-acronym` - query acronym of the event\n+ `query.event-location` - query location of the event\n+ `query.event-name` - query name of the event\n+ `query.event-sponsor` - query sponsor of the event\n+ `query.event-theme` - query theme of the event\n+ `query.funder-name` - query name of the funder\n+ `query.publisher-location` - query location of the publisher\n+ `query.publisher-name` - query publisher name\n+ `query.standards-body-acronym` - query acronym of the standards body\n+ `query.standards-body-name` - query standards body name\n+ `query.title` - query title\n+ `query.translator` - query translator given and family names\n## Sort\n\nResults can be sorted by applying the `sort` and `order` parameters. `sort` sets the field by which results will be sorted. `order` sets the result ordering, either `asc` or `desc` (default is `desc`).\n\nAn example that sorts results in order of publication, beginning with the least recent:\n\n##\n\n```\n/works?query=josiah+carberry&sort=published&order=asc\n```\n\n##\n\nThis endpoint supports sorting by the following elements:\n\n##\n\n+ `created` - sort by created date\n+ `deposited` - sort by time of most recent deposit\n+ `indexed` - sort by time of most recent index\n+ `is-referenced-by-count` - sort by number of times this DOI is referenced by other Crossref DOIs\n+ `issued` - sort by issued date (earliest known publication date)\n+ `published` - sort by publication date\n+ `published-online` - sort by online publication date\n+ `published-print` - sort by print publication date\n+ `references-count` - sort by number of references included in the references section of the document identified by this DOI\n+ `relevance` - sort by relevance score\n+ `score` - sort by relevance score\n+ `updated` - sort by date of most recent change to metadata, currently the same as deposited\n## Facets\n\nFacet counts can be retrieved by enabling faceting. Facets are enabled by providing facet field names along with a maximum number of returned term values. The larger the number of returned values, the longer the query will take. Some facet fields can accept a `*` as their maximum, which indicates that all values should be returned.\n\n##\n\nFor example, to get facet counts for all work types:\n\n##\n```\n/works?facet=type-name:*\n```\n\n##\n\nThis endpoint supports the following facets:\n\n##\n\n+ `affiliation` - author affiliation\n+ `archive` - archive location\n+ `assertion` - custom Crossmark assertion name\n+ `assertion-group` - custom Crossmark assertion group name\n+ `category-name` - category name of work\n+ `container-title` - [max value 100], work container title, such as journal title, or book title\n+ `funder-doi` - funder DOI\n+ `funder-name` - funder literal name as deposited alongside DOI\n+ `issn` - [max value 100], journal ISSN (any - print, electronic, link)\n+ `journal-issue` - journal issue number\n+ `journal-volume` - journal volume\n+ `license` - license URI of work\n+ `link-application` - intended application of the full text link\n+ `orcid` - [max value 100], contributor ORCID\n+ `published` - earliest year of publication\n+ `publisher-name` - publisher name of work\n+ `relation-type` - relation type described by work or described by another work with work as object\n+ `ror-id` - institution ROR ID\n+ `source` - source of the DOI\n+ `type-name` - work type name, such as journal-article or book-chapter\n+ `update-type` - significant update type\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nFor example:\n\n##\n```\n/works?filter=type:dataset\n```\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `is-update:true`\n- `from-pub-date:2014-03-03`\n- `funder:10.13039/100000001`\n- `funder:10.13039/100000050`\n\nwould locate documents that are updates, were published on or after 3rd March 2014 and were funded by either the National Science Foundation (`10.13039/100000001`) or the National Heart, Lung, and Blood Institute (`10.13039/100000050`). These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/works?filter=is-update:true,from-pub-date:2014-03-03,funder:10.13039/100000001,funder:10.13039/100000050\n```\n\n### Dot filters\n\nA filter with a dot in its name is special. The dot signifies that the filter will be applied to some other record type that is related to primary resource record type. For example, with work queries, one can filter on works that have an award, where the same award has a particular award number and award-giving funding agency:\n\n##\n```\n/works?filter=award.number:CBET-0756451,award.funder:10.13039/100000001\n```\n##\n\nHere we filter on works that have an award by the National Science Foundation that also has the award number `CBET-0756451`.\n\n### Note on dates\n\nThe dates in filters should always be of the form YYYY-MM-DD, YYYY-MM or YYYY. The date filters are inclusive. For example:\n\n* `from-pub-date:2018-09-18` filters works published on or after 18th September 2018\n* `from-created-date:2016-02-29,until-created-date:2016-02-29` filters works first deposited on 29th February 2016\n* `until-created-date:2010-06` filters works first deposited in or before June 2010\n* `from-update-date:2017,until-update-date:2017` filters works with metadata updated in 2017\n\nAlso note that date information in Crossref metadata can often be incomplete. So, for example, a publisher may only include the year and month of publication for a journal article. For a monograph they might just include the year. In these cases the API selects the earliest possible date given the information provided. So, for instance, if the publisher only provided 2013-02 as the published date, then the date would be treated as 2013-02-01. Similarly, if the publisher only provided the year 2013 as the date, it would be treated at 2013-01-01.\n\n### Note on owner prefixes\n\nThe prefix of a Crossref DOI does **NOT** indicate who currently owns the DOI. It only reflects who originally registered the DOI. Crossref metadata has an **prefix** element that records the current owner of the Crossref DOI in question.\n\n##\n\nCrossref also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used.\n\n### Notes on incremental metadata updates\n\nWhen using time filters to retrieve periodic, incremental metadata updates, the `from-index-date` filter should be used over `from-update-date`, `from-deposit-date`, `from-created-date` and `from-pub-date`. The timestamp that `from-index-date` filters on is guaranteed to be updated every time there is a change to metadata requiring a reindex.\n\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `alternative-id` - metadata for records with the given alternative ID, which may be a publisher-specific ID, or any other identifier a publisher may have provided\n+ `archive` - metadata where value of archive partner equals given archive name\n+ `article-number` - metadata for records with a given article number\n+ `assertion` - metadata for records with a given named assertion\n+ `assertion-group` - metadata for records with an assertion in a given group\n+ `award`\n  + `award.funder` - metadata for records with award funder equal to given funder, optionally combine with `award.number`\n  + `award.number` - metadata for records with award number equal to given number, optionally combine with `award.funder`\n+ `category-name` - metadata for records with category label equal to given name, category labels come from the list published by Scopus\n+ `citation-id`\n+ `clinical-trial-number` - metadata for records with given clinical trial number\n+ `container-title` - metadata with a publication title that exactly equals given title\n+ `content-domain` - metadata where the publisher records a given domain name as the location Crossmark content will appear\n+ `doi` - metadata describing given DOI\n+ `from-accepted-date` - [date], metadata where accepted date is since given date (inclusive)\n+ `from-approved-date` - [date], metadata where approved date is since given date (inclusive)\n+ `from-awarded-date` - [date], metadata where award date is since given date (inclusive)\n+ `from-created-date` - [date], metadata first deposited since given date (inclusive)\n+ `from-deposit-date` - [date], metadata last (re)deposited since given date (inclusive)\n+ `from-event-end-date` - [date], metadata where event end date is since given date (inclusive)\n+ `from-event-start-date` - [date], metadata where event start date is since given date  (inclusive)\n+ `from-index-date` - [date], metadata indexed since given date (inclusive)\n+ `from-issued-date` - [date], metadata where issued date is since given date  (inclusive)\n+ `from-online-pub-date` - [date], metadata where online published date is since given date (inclusive)\n+ `from-posted-date` - [date], metadata where posted date is since given date (inclusive)\n+ `from-print-pub-date` - [date], metadata where print published date is since given date (inclusive)\n+ `from-pub-date` - [date], metadata where published date is since given date (inclusive)\n+ `from-update-date` - [date], metadata updated since given date (inclusive), currently the same as `from-deposit-date`\n+ `full-text`\n  + `full-text.type` - metadata where `resource` element's `content_type` attribute equals given version mime type (e.g. application/pdf)\n  + `full-text.application` - [text-mining, similarity-checking or unspecified], metadata where `resource` link has given application\n  + `full-text.version` - metadata where `resource` element's `content_version` attribute equals given version\n+ `funder` - metadata which include given funder id in FundRef data\n+ `funder-doi-asserted-by` - metadata where funder DOI was asserted by given body\n+ `group-title` - metadata with given group title\n+ `gte-award-amount` - metadata where award is greater than or equals given number\n+ `has-abstract` - [0 or 1], metadata for records with/without an abstract\n+ `has-affiliation` - [0 or 1], metadata for records with/without affiliation information\n+ `has-archive` - [0 or 1], metadata which includes/does not include name of archive partner\n+ `has-assertion` - [0 or 1], metadata for records with/without assertions\n+ `has-authenticated-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID\n+ `has-award` - [0 or 1], metadata for records with/without award\n+ `has-clinical-trial-number` - [0 or 1], metadata for records with/without a clinical trial number\n+ `has-content-domain` - [0 or 1], metadata where the publisher records/does not record a domain name location for Crossmark content\n+ `has-description`\n+ `has-domain-restriction` - [0 or 1], metadata where the publisher restricts/does not restrict Crossmark usage to content domains\n+ `has-event` - [0 or 1], metadata for records with/without event\n+ `has-full-text` - [0 or 1], metadata that includes/does not include any full text `resource` elements\n+ `has-funder` - [0 or 1], metadata which includes/does not include one or more funder entry\n+ `has-funder-doi` - [0 or 1], metadata for records with/without funder DOI\n+ `has-license` - [0 or 1], metadata that includes/does not include any `license_ref` elements\n+ `has-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs\n+ `has-references` - [0 or 1], metadata for works that have/don't have a list of references\n+ `has-relation` - [0 or 1], metadata for records that either assert/do not assert or are/are not the object of a relation\n+ `has-ror-id` - [0 or 1], metadata for records with/without ROR ID\n+ `has-update` - [0 or 1], metadata for records with/without update information\n+ `has-update-policy` - [0 or 1], metadata for records that include/do not include a link to an editorial update policy\n+ `is-update` - [0 or 1], metadata for records that represent/do not represent editorial updates\n+ `isbn` - metadata with given ISBN\n+ `issn` - metadata with given ISSN, format is xxxx-xxxx\n+ `license`\n  + `license.url` - metadata where `license_ref` value equals given url\n  + `license.version` - metadata where the `license_ref`'s `applies_to` attribute equals given version\n  + `license.delay` - metadata where difference between publication date and the `license_ref`'s `start_date` attribute is <= than given delay (in days)\n+ `lte-award-amount` - metadata where award is less than or equals given number\n+ `member` - metadata belonging to a given Crossref member\n+ `orcid` - metadata where there is a contributor with given ORCID\n+ `prefix` - metadata belonging to a given DOI owner prefix (e.g. 10.1016)\n+ `relation`\n  + `relation.type` - metadata for records with a relation with the given type from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)\n  + `relation.object-type` - metadata for records with a relation, where the object type matches given type from the Crossref relations schema (e.g. doi, issn)\n  + `relation.object` - metadata for records with a relation, where the object identifier matches given identifier\n+ `ror-id` - metadata with given ROR ID\n+ `type` - metadata records whose type equals given type, type must be an ID value from the list of types returned by the /types resource\n+ `type-name` - metadata for records with type name equal to given name\n+ `until-accepted-date` - [date], metadata where accepted date is before given date (inclusive)\n+ `until-approved-date` - [date], metadata where approved date is before given date (inclusive)\n+ `until-awarded-date` - [date], metadata where award date is before given date (inclusive)\n+ `until-created-date` - [date], metadata first deposited before given date (inclusive)\n+ `until-deposit-date` - [date], metadata last (re)deposited before given date (inclusive)\n+ `until-event-end-date` - [date], metadata where event end date is before given date (inclusive)\n+ `until-event-start-date` - [date], metadata where event start date is before given date  (inclusive)\n+ `until-index-date` - [date], metadata indexed before given date (inclusive)\n+ `until-issued-date` - [date], metadata where issued date is before given date  (inclusive)\n+ `until-online-pub-date` - [date], metadata where online published date is before given date (inclusive)\n+ `until-posted-date` - [date], metadata where posted date is before given date (inclusive)\n+ `until-print-pub-date` - [date], metadata where print published date is before given date (inclusive)\n+ `until-pub-date` - [date], metadata where published date is before given date (inclusive)\n+ `until-update-date` - [date], metadata updated before given date (inclusive), currently the same as `until-deposit-date`\n+ `update-type` - metadata with given update type\n+ `updates` - metadata for records that represent editorial updates to given DOI\n## Elements\n\nCrossref metadata records can be quite large. Sometimes you just want a few elements from the schema. You can \\\"select\\\" a subset of elements to return using the `select` parameter. This can make your API calls much more efficient. For example:\n\n##\n```\n/works?select=DOI,prefix,title\n```\n\n##\n\nThis endpoint supports selecting the following elements.\n\n##\n\n+ `DOI`\n+ `ISBN`\n+ `ISSN`\n+ `URL`\n+ `abstract`\n+ `accepted`\n+ `alternative-id`\n+ `approved`\n+ `archive`\n+ `article-number`\n+ `assertion`\n+ `author`\n+ `chair`\n+ `clinical-trial-number`\n+ `container-title`\n+ `content-created`\n+ `content-domain`\n+ `created`\n+ `degree`\n+ `deposited`\n+ `editor`\n+ `event`\n+ `funder`\n+ `group-title`\n+ `indexed`\n+ `is-referenced-by-count`\n+ `issn-type`\n+ `issue`\n+ `issued`\n+ `license`\n+ `link`\n+ `member`\n+ `original-title`\n+ `page`\n+ `posted`\n+ `prefix`\n+ `published`\n+ `published-online`\n+ `published-print`\n+ `publisher`\n+ `publisher-location`\n+ `reference`\n+ `references-count`\n+ `relation`\n+ `score`\n+ `short-container-title`\n+ `short-title`\n+ `standards-body`\n+ `subject`\n+ `subtitle`\n+ `title`\n+ `translator`\n+ `type`\n+ `update-policy`\n+ `update-to`\n+ `updated-by`\n+ `volume`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n\n## Sample\n\nBeing able to select random results is useful for both testing and sampling. You can use the `sample` parameter to retrieve random results. So, for example, the following selects 10 random works:\n\n##\n```\n/works?sample=10\n```\n##\n\nNote that when you use the `sample` parameter, the `rows` and `offset` parameters are ignored.\n\n\n## Parameter combinations\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` can be used with offsets. Sampling cannot be combined with offsets.\n\n##\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` may also be used with deep paging cursors. `rows` may also be specified.\n\n##\n\n`offset` and `sample` cannot be used in combination with cursors.\n\n##\n",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the funder",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "order",
            "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc",
            "required": false,
            "pattern": "(asc|desc)",
            "type": "string"
          },
          {
            "in": "query",
            "name": "facet",
            "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "sample",
            "description": "Exposes the ability to return `N` randomly sampled items",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Exposes the ability to sort results by a certain field, e.g. `score`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "select",
            "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`",
            "required": false,
            "pattern": "^\\w+(,\\w+)*$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorksMessage"
            },
            "description": "A list of works"
          }
        },
        "tags": [
          "Funders"
        ]
      }
    },
    "/journals/{issn}": {
      "get": {
        "description": "Returns information about a journal with the given ISSN, as an example use ISSN 03064530",
        "parameters": [
          {
            "in": "path",
            "name": "issn",
            "description": "The ISSN identifier associated with the journal",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/JournalMessage"
            },
            "description": "The journal identified by {issn}."
          },
          "404": {
            "description": "The journal identified by {issn} does not exist."
          }
        },
        "tags": [
          "Journals"
        ]
      }
    },
    "/types/{id}": {
      "get": {
        "description": "Returns information about a metadata work type, as an example use `monograph`",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/TypeMessage"
            },
            "description": "The type identified by {id}."
          },
          "404": {
            "description": "The type identified by {id} does not exist."
          }
        },
        "tags": [
          "Types"
        ]
      }
    },
    "/deposits/{id}": {
      "get": {
        "description": "Returns information about a deposit.",
        "security": [
          "basicAuth"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/DepositMessage"
            },
            "description": "The deposit identified by {id}."
          },
          "404": {
            "description": "The deposit identified by {id} does not exist."
          }
        },
        "tags": [
          "Deposits"
        ]
      }
    },
    "/licenses": {
      "get": {
        "description": "Returns a list of licenses.\n## Querying\n\nThis endpoint accepts `query` parameter, which allows for free text querying. The result contains aggregated licenses from the works that match given query.\n\n##\n\nFor example, this request:\n\n##\n\n```\n/licenses?query=richard+feynman\n```\n\n##\n\nwill first select works matching `richard+feynman`, and aggregate their licenses.\n\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n",
        "parameters": [
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/LicensesMessage"
            },
            "description": "A list of licenses"
          }
        },
        "tags": [
          "Licenses"
        ]
      }
    },
    "/types": {
      "get": {
        "description": "Returns a list of valid work types.\n## Pagination with offsets\n\nOffsets can be used to iterate over the results. For this route, the maximum number of available results is 80,000, which in this case allows to retrieve all the indexed items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n",
        "parameters": [
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/TypesMessage"
            },
            "description": "A collection of types"
          }
        },
        "tags": [
          "Types"
        ]
      }
    },
    "/works/{doi}": {
      "get": {
        "description": "Returns metadata for the specified Crossref DOI, as an example use DOI 10.5555/12345678",
        "parameters": [
          {
            "in": "path",
            "name": "doi",
            "description": "The DOI identifier associated with the work",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorkMessage"
            },
            "description": "The work identified by {doi}."
          },
          "404": {
            "description": "The work identified by {doi} does not exist."
          }
        },
        "tags": [
          "Works"
        ]
      }
    },
    "/types/{id}/works": {
      "get": {
        "description": "returns list of works of type {id}.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined with the general `query` parameter and each other. Each query parameter is ANDed with the others:\n\n##\n```\n/works?query.title=room+at+the+bottom&query.author=richard+feynman\n```\n\n##\n\nThis endpoint supports the following field queries:\n\n##\n\n+ `query.affiliation` - query contributor affiliations\n+ `query.author` - query author given and family names\n+ `query.bibliographic` - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years\n+ `query.chair` - query chair given and family names\n+ `query.container-title` - query container title aka. publication name\n+ `query.contributor` - query author, editor, chair and translator given and family names\n+ `query.degree` - query degree\n+ `query.description` - query description\n+ `query.editor` - query editor given and family names\n+ `query.event-acronym` - query acronym of the event\n+ `query.event-location` - query location of the event\n+ `query.event-name` - query name of the event\n+ `query.event-sponsor` - query sponsor of the event\n+ `query.event-theme` - query theme of the event\n+ `query.funder-name` - query name of the funder\n+ `query.publisher-location` - query location of the publisher\n+ `query.publisher-name` - query publisher name\n+ `query.standards-body-acronym` - query acronym of the standards body\n+ `query.standards-body-name` - query standards body name\n+ `query.title` - query title\n+ `query.translator` - query translator given and family names\n## Sort\n\nResults can be sorted by applying the `sort` and `order` parameters. `sort` sets the field by which results will be sorted. `order` sets the result ordering, either `asc` or `desc` (default is `desc`).\n\nAn example that sorts results in order of publication, beginning with the least recent:\n\n##\n\n```\n/works?query=josiah+carberry&sort=published&order=asc\n```\n\n##\n\nThis endpoint supports sorting by the following elements:\n\n##\n\n+ `created` - sort by created date\n+ `deposited` - sort by time of most recent deposit\n+ `indexed` - sort by time of most recent index\n+ `is-referenced-by-count` - sort by number of times this DOI is referenced by other Crossref DOIs\n+ `issued` - sort by issued date (earliest known publication date)\n+ `published` - sort by publication date\n+ `published-online` - sort by online publication date\n+ `published-print` - sort by print publication date\n+ `references-count` - sort by number of references included in the references section of the document identified by this DOI\n+ `relevance` - sort by relevance score\n+ `score` - sort by relevance score\n+ `updated` - sort by date of most recent change to metadata, currently the same as deposited\n## Facets\n\nFacet counts can be retrieved by enabling faceting. Facets are enabled by providing facet field names along with a maximum number of returned term values. The larger the number of returned values, the longer the query will take. Some facet fields can accept a `*` as their maximum, which indicates that all values should be returned.\n\n##\n\nFor example, to get facet counts for all work types:\n\n##\n```\n/works?facet=type-name:*\n```\n\n##\n\nThis endpoint supports the following facets:\n\n##\n\n+ `affiliation` - author affiliation\n+ `archive` - archive location\n+ `assertion` - custom Crossmark assertion name\n+ `assertion-group` - custom Crossmark assertion group name\n+ `category-name` - category name of work\n+ `container-title` - [max value 100], work container title, such as journal title, or book title\n+ `funder-doi` - funder DOI\n+ `funder-name` - funder literal name as deposited alongside DOI\n+ `issn` - [max value 100], journal ISSN (any - print, electronic, link)\n+ `journal-issue` - journal issue number\n+ `journal-volume` - journal volume\n+ `license` - license URI of work\n+ `link-application` - intended application of the full text link\n+ `orcid` - [max value 100], contributor ORCID\n+ `published` - earliest year of publication\n+ `publisher-name` - publisher name of work\n+ `relation-type` - relation type described by work or described by another work with work as object\n+ `ror-id` - institution ROR ID\n+ `source` - source of the DOI\n+ `type-name` - work type name, such as journal-article or book-chapter\n+ `update-type` - significant update type\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nFor example:\n\n##\n```\n/works?filter=type:dataset\n```\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `is-update:true`\n- `from-pub-date:2014-03-03`\n- `funder:10.13039/100000001`\n- `funder:10.13039/100000050`\n\nwould locate documents that are updates, were published on or after 3rd March 2014 and were funded by either the National Science Foundation (`10.13039/100000001`) or the National Heart, Lung, and Blood Institute (`10.13039/100000050`). These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/works?filter=is-update:true,from-pub-date:2014-03-03,funder:10.13039/100000001,funder:10.13039/100000050\n```\n\n### Dot filters\n\nA filter with a dot in its name is special. The dot signifies that the filter will be applied to some other record type that is related to primary resource record type. For example, with work queries, one can filter on works that have an award, where the same award has a particular award number and award-giving funding agency:\n\n##\n```\n/works?filter=award.number:CBET-0756451,award.funder:10.13039/100000001\n```\n##\n\nHere we filter on works that have an award by the National Science Foundation that also has the award number `CBET-0756451`.\n\n### Note on dates\n\nThe dates in filters should always be of the form YYYY-MM-DD, YYYY-MM or YYYY. The date filters are inclusive. For example:\n\n* `from-pub-date:2018-09-18` filters works published on or after 18th September 2018\n* `from-created-date:2016-02-29,until-created-date:2016-02-29` filters works first deposited on 29th February 2016\n* `until-created-date:2010-06` filters works first deposited in or before June 2010\n* `from-update-date:2017,until-update-date:2017` filters works with metadata updated in 2017\n\nAlso note that date information in Crossref metadata can often be incomplete. So, for example, a publisher may only include the year and month of publication for a journal article. For a monograph they might just include the year. In these cases the API selects the earliest possible date given the information provided. So, for instance, if the publisher only provided 2013-02 as the published date, then the date would be treated as 2013-02-01. Similarly, if the publisher only provided the year 2013 as the date, it would be treated at 2013-01-01.\n\n### Note on owner prefixes\n\nThe prefix of a Crossref DOI does **NOT** indicate who currently owns the DOI. It only reflects who originally registered the DOI. Crossref metadata has an **prefix** element that records the current owner of the Crossref DOI in question.\n\n##\n\nCrossref also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used.\n\n### Notes on incremental metadata updates\n\nWhen using time filters to retrieve periodic, incremental metadata updates, the `from-index-date` filter should be used over `from-update-date`, `from-deposit-date`, `from-created-date` and `from-pub-date`. The timestamp that `from-index-date` filters on is guaranteed to be updated every time there is a change to metadata requiring a reindex.\n\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `alternative-id` - metadata for records with the given alternative ID, which may be a publisher-specific ID, or any other identifier a publisher may have provided\n+ `archive` - metadata where value of archive partner equals given archive name\n+ `article-number` - metadata for records with a given article number\n+ `assertion` - metadata for records with a given named assertion\n+ `assertion-group` - metadata for records with an assertion in a given group\n+ `award`\n  + `award.funder` - metadata for records with award funder equal to given funder, optionally combine with `award.number`\n  + `award.number` - metadata for records with award number equal to given number, optionally combine with `award.funder`\n+ `category-name` - metadata for records with category label equal to given name, category labels come from the list published by Scopus\n+ `citation-id`\n+ `clinical-trial-number` - metadata for records with given clinical trial number\n+ `container-title` - metadata with a publication title that exactly equals given title\n+ `content-domain` - metadata where the publisher records a given domain name as the location Crossmark content will appear\n+ `doi` - metadata describing given DOI\n+ `from-accepted-date` - [date], metadata where accepted date is since given date (inclusive)\n+ `from-approved-date` - [date], metadata where approved date is since given date (inclusive)\n+ `from-awarded-date` - [date], metadata where award date is since given date (inclusive)\n+ `from-created-date` - [date], metadata first deposited since given date (inclusive)\n+ `from-deposit-date` - [date], metadata last (re)deposited since given date (inclusive)\n+ `from-event-end-date` - [date], metadata where event end date is since given date (inclusive)\n+ `from-event-start-date` - [date], metadata where event start date is since given date  (inclusive)\n+ `from-index-date` - [date], metadata indexed since given date (inclusive)\n+ `from-issued-date` - [date], metadata where issued date is since given date  (inclusive)\n+ `from-online-pub-date` - [date], metadata where online published date is since given date (inclusive)\n+ `from-posted-date` - [date], metadata where posted date is since given date (inclusive)\n+ `from-print-pub-date` - [date], metadata where print published date is since given date (inclusive)\n+ `from-pub-date` - [date], metadata where published date is since given date (inclusive)\n+ `from-update-date` - [date], metadata updated since given date (inclusive), currently the same as `from-deposit-date`\n+ `full-text`\n  + `full-text.type` - metadata where `resource` element's `content_type` attribute equals given version mime type (e.g. application/pdf)\n  + `full-text.application` - [text-mining, similarity-checking or unspecified], metadata where `resource` link has given application\n  + `full-text.version` - metadata where `resource` element's `content_version` attribute equals given version\n+ `funder` - metadata which include given funder id in FundRef data\n+ `funder-doi-asserted-by` - metadata where funder DOI was asserted by given body\n+ `group-title` - metadata with given group title\n+ `gte-award-amount` - metadata where award is greater than or equals given number\n+ `has-abstract` - [0 or 1], metadata for records with/without an abstract\n+ `has-affiliation` - [0 or 1], metadata for records with/without affiliation information\n+ `has-archive` - [0 or 1], metadata which includes/does not include name of archive partner\n+ `has-assertion` - [0 or 1], metadata for records with/without assertions\n+ `has-authenticated-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID\n+ `has-award` - [0 or 1], metadata for records with/without award\n+ `has-clinical-trial-number` - [0 or 1], metadata for records with/without a clinical trial number\n+ `has-content-domain` - [0 or 1], metadata where the publisher records/does not record a domain name location for Crossmark content\n+ `has-description`\n+ `has-domain-restriction` - [0 or 1], metadata where the publisher restricts/does not restrict Crossmark usage to content domains\n+ `has-event` - [0 or 1], metadata for records with/without event\n+ `has-full-text` - [0 or 1], metadata that includes/does not include any full text `resource` elements\n+ `has-funder` - [0 or 1], metadata which includes/does not include one or more funder entry\n+ `has-funder-doi` - [0 or 1], metadata for records with/without funder DOI\n+ `has-license` - [0 or 1], metadata that includes/does not include any `license_ref` elements\n+ `has-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs\n+ `has-references` - [0 or 1], metadata for works that have/don't have a list of references\n+ `has-relation` - [0 or 1], metadata for records that either assert/do not assert or are/are not the object of a relation\n+ `has-ror-id` - [0 or 1], metadata for records with/without ROR ID\n+ `has-update` - [0 or 1], metadata for records with/without update information\n+ `has-update-policy` - [0 or 1], metadata for records that include/do not include a link to an editorial update policy\n+ `is-update` - [0 or 1], metadata for records that represent/do not represent editorial updates\n+ `isbn` - metadata with given ISBN\n+ `issn` - metadata with given ISSN, format is xxxx-xxxx\n+ `license`\n  + `license.url` - metadata where `license_ref` value equals given url\n  + `license.version` - metadata where the `license_ref`'s `applies_to` attribute equals given version\n  + `license.delay` - metadata where difference between publication date and the `license_ref`'s `start_date` attribute is <= than given delay (in days)\n+ `lte-award-amount` - metadata where award is less than or equals given number\n+ `member` - metadata belonging to a given Crossref member\n+ `orcid` - metadata where there is a contributor with given ORCID\n+ `prefix` - metadata belonging to a given DOI owner prefix (e.g. 10.1016)\n+ `relation`\n  + `relation.type` - metadata for records with a relation with the given type from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)\n  + `relation.object-type` - metadata for records with a relation, where the object type matches given type from the Crossref relations schema (e.g. doi, issn)\n  + `relation.object` - metadata for records with a relation, where the object identifier matches given identifier\n+ `ror-id` - metadata with given ROR ID\n+ `type` - metadata records whose type equals given type, type must be an ID value from the list of types returned by the /types resource\n+ `type-name` - metadata for records with type name equal to given name\n+ `until-accepted-date` - [date], metadata where accepted date is before given date (inclusive)\n+ `until-approved-date` - [date], metadata where approved date is before given date (inclusive)\n+ `until-awarded-date` - [date], metadata where award date is before given date (inclusive)\n+ `until-created-date` - [date], metadata first deposited before given date (inclusive)\n+ `until-deposit-date` - [date], metadata last (re)deposited before given date (inclusive)\n+ `until-event-end-date` - [date], metadata where event end date is before given date (inclusive)\n+ `until-event-start-date` - [date], metadata where event start date is before given date  (inclusive)\n+ `until-index-date` - [date], metadata indexed before given date (inclusive)\n+ `until-issued-date` - [date], metadata where issued date is before given date  (inclusive)\n+ `until-online-pub-date` - [date], metadata where online published date is before given date (inclusive)\n+ `until-posted-date` - [date], metadata where posted date is before given date (inclusive)\n+ `until-print-pub-date` - [date], metadata where print published date is before given date (inclusive)\n+ `until-pub-date` - [date], metadata where published date is before given date (inclusive)\n+ `until-update-date` - [date], metadata updated before given date (inclusive), currently the same as `until-deposit-date`\n+ `update-type` - metadata with given update type\n+ `updates` - metadata for records that represent editorial updates to given DOI\n## Elements\n\nCrossref metadata records can be quite large. Sometimes you just want a few elements from the schema. You can \\\"select\\\" a subset of elements to return using the `select` parameter. This can make your API calls much more efficient. For example:\n\n##\n```\n/works?select=DOI,prefix,title\n```\n\n##\n\nThis endpoint supports selecting the following elements.\n\n##\n\n+ `DOI`\n+ `ISBN`\n+ `ISSN`\n+ `URL`\n+ `abstract`\n+ `accepted`\n+ `alternative-id`\n+ `approved`\n+ `archive`\n+ `article-number`\n+ `assertion`\n+ `author`\n+ `chair`\n+ `clinical-trial-number`\n+ `container-title`\n+ `content-created`\n+ `content-domain`\n+ `created`\n+ `degree`\n+ `deposited`\n+ `editor`\n+ `event`\n+ `funder`\n+ `group-title`\n+ `indexed`\n+ `is-referenced-by-count`\n+ `issn-type`\n+ `issue`\n+ `issued`\n+ `license`\n+ `link`\n+ `member`\n+ `original-title`\n+ `page`\n+ `posted`\n+ `prefix`\n+ `published`\n+ `published-online`\n+ `published-print`\n+ `publisher`\n+ `publisher-location`\n+ `reference`\n+ `references-count`\n+ `relation`\n+ `score`\n+ `short-container-title`\n+ `short-title`\n+ `standards-body`\n+ `subject`\n+ `subtitle`\n+ `title`\n+ `translator`\n+ `type`\n+ `update-policy`\n+ `update-to`\n+ `updated-by`\n+ `volume`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n\n## Sample\n\nBeing able to select random results is useful for both testing and sampling. You can use the `sample` parameter to retrieve random results. So, for example, the following selects 10 random works:\n\n##\n```\n/works?sample=10\n```\n##\n\nNote that when you use the `sample` parameter, the `rows` and `offset` parameters are ignored.\n\n\n## Parameter combinations\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` can be used with offsets. Sampling cannot be combined with offsets.\n\n##\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` may also be used with deep paging cursors. `rows` may also be specified.\n\n##\n\n`offset` and `sample` cannot be used in combination with cursors.\n\n##\n",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "order",
            "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc",
            "required": false,
            "pattern": "(asc|desc)",
            "type": "string"
          },
          {
            "in": "query",
            "name": "facet",
            "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "sample",
            "description": "Exposes the ability to return `N` randomly sampled items",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Exposes the ability to sort results by a certain field, e.g. `score`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "select",
            "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`",
            "required": false,
            "pattern": "^\\w+(,\\w+)*$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorksMessage"
            },
            "description": "A list of works"
          }
        },
        "tags": [
          "Types"
        ]
      }
    },
    "/works": {
      "get": {
        "description": "Returns a list of all works (journal articles, conference proceedings, books, components, etc), 20 per page.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined with the general `query` parameter and each other. Each query parameter is ANDed with the others:\n\n##\n```\n/works?query.title=room+at+the+bottom&query.author=richard+feynman\n```\n\n##\n\nThis endpoint supports the following field queries:\n\n##\n\n+ `query.affiliation` - query contributor affiliations\n+ `query.author` - query author given and family names\n+ `query.bibliographic` - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years\n+ `query.chair` - query chair given and family names\n+ `query.container-title` - query container title aka. publication name\n+ `query.contributor` - query author, editor, chair and translator given and family names\n+ `query.degree` - query degree\n+ `query.description` - query description\n+ `query.editor` - query editor given and family names\n+ `query.event-acronym` - query acronym of the event\n+ `query.event-location` - query location of the event\n+ `query.event-name` - query name of the event\n+ `query.event-sponsor` - query sponsor of the event\n+ `query.event-theme` - query theme of the event\n+ `query.funder-name` - query name of the funder\n+ `query.publisher-location` - query location of the publisher\n+ `query.publisher-name` - query publisher name\n+ `query.standards-body-acronym` - query acronym of the standards body\n+ `query.standards-body-name` - query standards body name\n+ `query.title` - query title\n+ `query.translator` - query translator given and family names\n## Sort\n\nResults can be sorted by applying the `sort` and `order` parameters. `sort` sets the field by which results will be sorted. `order` sets the result ordering, either `asc` or `desc` (default is `desc`).\n\nAn example that sorts results in order of publication, beginning with the least recent:\n\n##\n\n```\n/works?query=josiah+carberry&sort=published&order=asc\n```\n\n##\n\nThis endpoint supports sorting by the following elements:\n\n##\n\n+ `created` - sort by created date\n+ `deposited` - sort by time of most recent deposit\n+ `indexed` - sort by time of most recent index\n+ `is-referenced-by-count` - sort by number of times this DOI is referenced by other Crossref DOIs\n+ `issued` - sort by issued date (earliest known publication date)\n+ `published` - sort by publication date\n+ `published-online` - sort by online publication date\n+ `published-print` - sort by print publication date\n+ `references-count` - sort by number of references included in the references section of the document identified by this DOI\n+ `relevance` - sort by relevance score\n+ `score` - sort by relevance score\n+ `updated` - sort by date of most recent change to metadata, currently the same as deposited\n## Facets\n\nFacet counts can be retrieved by enabling faceting. Facets are enabled by providing facet field names along with a maximum number of returned term values. The larger the number of returned values, the longer the query will take. Some facet fields can accept a `*` as their maximum, which indicates that all values should be returned.\n\n##\n\nFor example, to get facet counts for all work types:\n\n##\n```\n/works?facet=type-name:*\n```\n\n##\n\nThis endpoint supports the following facets:\n\n##\n\n+ `affiliation` - author affiliation\n+ `archive` - archive location\n+ `assertion` - custom Crossmark assertion name\n+ `assertion-group` - custom Crossmark assertion group name\n+ `category-name` - category name of work\n+ `container-title` - [max value 100], work container title, such as journal title, or book title\n+ `funder-doi` - funder DOI\n+ `funder-name` - funder literal name as deposited alongside DOI\n+ `issn` - [max value 100], journal ISSN (any - print, electronic, link)\n+ `journal-issue` - journal issue number\n+ `journal-volume` - journal volume\n+ `license` - license URI of work\n+ `link-application` - intended application of the full text link\n+ `orcid` - [max value 100], contributor ORCID\n+ `published` - earliest year of publication\n+ `publisher-name` - publisher name of work\n+ `relation-type` - relation type described by work or described by another work with work as object\n+ `ror-id` - institution ROR ID\n+ `source` - source of the DOI\n+ `type-name` - work type name, such as journal-article or book-chapter\n+ `update-type` - significant update type\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nFor example:\n\n##\n```\n/works?filter=type:dataset\n```\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `is-update:true`\n- `from-pub-date:2014-03-03`\n- `funder:10.13039/100000001`\n- `funder:10.13039/100000050`\n\nwould locate documents that are updates, were published on or after 3rd March 2014 and were funded by either the National Science Foundation (`10.13039/100000001`) or the National Heart, Lung, and Blood Institute (`10.13039/100000050`). These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/works?filter=is-update:true,from-pub-date:2014-03-03,funder:10.13039/100000001,funder:10.13039/100000050\n```\n\n### Dot filters\n\nA filter with a dot in its name is special. The dot signifies that the filter will be applied to some other record type that is related to primary resource record type. For example, with work queries, one can filter on works that have an award, where the same award has a particular award number and award-giving funding agency:\n\n##\n```\n/works?filter=award.number:CBET-0756451,award.funder:10.13039/100000001\n```\n##\n\nHere we filter on works that have an award by the National Science Foundation that also has the award number `CBET-0756451`.\n\n### Note on dates\n\nThe dates in filters should always be of the form YYYY-MM-DD, YYYY-MM or YYYY. The date filters are inclusive. For example:\n\n* `from-pub-date:2018-09-18` filters works published on or after 18th September 2018\n* `from-created-date:2016-02-29,until-created-date:2016-02-29` filters works first deposited on 29th February 2016\n* `until-created-date:2010-06` filters works first deposited in or before June 2010\n* `from-update-date:2017,until-update-date:2017` filters works with metadata updated in 2017\n\nAlso note that date information in Crossref metadata can often be incomplete. So, for example, a publisher may only include the year and month of publication for a journal article. For a monograph they might just include the year. In these cases the API selects the earliest possible date given the information provided. So, for instance, if the publisher only provided 2013-02 as the published date, then the date would be treated as 2013-02-01. Similarly, if the publisher only provided the year 2013 as the date, it would be treated at 2013-01-01.\n\n### Note on owner prefixes\n\nThe prefix of a Crossref DOI does **NOT** indicate who currently owns the DOI. It only reflects who originally registered the DOI. Crossref metadata has an **prefix** element that records the current owner of the Crossref DOI in question.\n\n##\n\nCrossref also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used.\n\n### Notes on incremental metadata updates\n\nWhen using time filters to retrieve periodic, incremental metadata updates, the `from-index-date` filter should be used over `from-update-date`, `from-deposit-date`, `from-created-date` and `from-pub-date`. The timestamp that `from-index-date` filters on is guaranteed to be updated every time there is a change to metadata requiring a reindex.\n\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `alternative-id` - metadata for records with the given alternative ID, which may be a publisher-specific ID, or any other identifier a publisher may have provided\n+ `archive` - metadata where value of archive partner equals given archive name\n+ `article-number` - metadata for records with a given article number\n+ `assertion` - metadata for records with a given named assertion\n+ `assertion-group` - metadata for records with an assertion in a given group\n+ `award`\n  + `award.funder` - metadata for records with award funder equal to given funder, optionally combine with `award.number`\n  + `award.number` - metadata for records with award number equal to given number, optionally combine with `award.funder`\n+ `category-name` - metadata for records with category label equal to given name, category labels come from the list published by Scopus\n+ `citation-id`\n+ `clinical-trial-number` - metadata for records with given clinical trial number\n+ `container-title` - metadata with a publication title that exactly equals given title\n+ `content-domain` - metadata where the publisher records a given domain name as the location Crossmark content will appear\n+ `doi` - metadata describing given DOI\n+ `from-accepted-date` - [date], metadata where accepted date is since given date (inclusive)\n+ `from-approved-date` - [date], metadata where approved date is since given date (inclusive)\n+ `from-awarded-date` - [date], metadata where award date is since given date (inclusive)\n+ `from-created-date` - [date], metadata first deposited since given date (inclusive)\n+ `from-deposit-date` - [date], metadata last (re)deposited since given date (inclusive)\n+ `from-event-end-date` - [date], metadata where event end date is since given date (inclusive)\n+ `from-event-start-date` - [date], metadata where event start date is since given date  (inclusive)\n+ `from-index-date` - [date], metadata indexed since given date (inclusive)\n+ `from-issued-date` - [date], metadata where issued date is since given date  (inclusive)\n+ `from-online-pub-date` - [date], metadata where online published date is since given date (inclusive)\n+ `from-posted-date` - [date], metadata where posted date is since given date (inclusive)\n+ `from-print-pub-date` - [date], metadata where print published date is since given date (inclusive)\n+ `from-pub-date` - [date], metadata where published date is since given date (inclusive)\n+ `from-update-date` - [date], metadata updated since given date (inclusive), currently the same as `from-deposit-date`\n+ `full-text`\n  + `full-text.type` - metadata where `resource` element's `content_type` attribute equals given version mime type (e.g. application/pdf)\n  + `full-text.application` - [text-mining, similarity-checking or unspecified], metadata where `resource` link has given application\n  + `full-text.version` - metadata where `resource` element's `content_version` attribute equals given version\n+ `funder` - metadata which include given funder id in FundRef data\n+ `funder-doi-asserted-by` - metadata where funder DOI was asserted by given body\n+ `group-title` - metadata with given group title\n+ `gte-award-amount` - metadata where award is greater than or equals given number\n+ `has-abstract` - [0 or 1], metadata for records with/without an abstract\n+ `has-affiliation` - [0 or 1], metadata for records with/without affiliation information\n+ `has-archive` - [0 or 1], metadata which includes/does not include name of archive partner\n+ `has-assertion` - [0 or 1], metadata for records with/without assertions\n+ `has-authenticated-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID\n+ `has-award` - [0 or 1], metadata for records with/without award\n+ `has-clinical-trial-number` - [0 or 1], metadata for records with/without a clinical trial number\n+ `has-content-domain` - [0 or 1], metadata where the publisher records/does not record a domain name location for Crossmark content\n+ `has-description`\n+ `has-domain-restriction` - [0 or 1], metadata where the publisher restricts/does not restrict Crossmark usage to content domains\n+ `has-event` - [0 or 1], metadata for records with/without event\n+ `has-full-text` - [0 or 1], metadata that includes/does not include any full text `resource` elements\n+ `has-funder` - [0 or 1], metadata which includes/does not include one or more funder entry\n+ `has-funder-doi` - [0 or 1], metadata for records with/without funder DOI\n+ `has-license` - [0 or 1], metadata that includes/does not include any `license_ref` elements\n+ `has-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs\n+ `has-references` - [0 or 1], metadata for works that have/don't have a list of references\n+ `has-relation` - [0 or 1], metadata for records that either assert/do not assert or are/are not the object of a relation\n+ `has-ror-id` - [0 or 1], metadata for records with/without ROR ID\n+ `has-update` - [0 or 1], metadata for records with/without update information\n+ `has-update-policy` - [0 or 1], metadata for records that include/do not include a link to an editorial update policy\n+ `is-update` - [0 or 1], metadata for records that represent/do not represent editorial updates\n+ `isbn` - metadata with given ISBN\n+ `issn` - metadata with given ISSN, format is xxxx-xxxx\n+ `license`\n  + `license.url` - metadata where `license_ref` value equals given url\n  + `license.version` - metadata where the `license_ref`'s `applies_to` attribute equals given version\n  + `license.delay` - metadata where difference between publication date and the `license_ref`'s `start_date` attribute is <= than given delay (in days)\n+ `lte-award-amount` - metadata where award is less than or equals given number\n+ `member` - metadata belonging to a given Crossref member\n+ `orcid` - metadata where there is a contributor with given ORCID\n+ `prefix` - metadata belonging to a given DOI owner prefix (e.g. 10.1016)\n+ `relation`\n  + `relation.type` - metadata for records with a relation with the given type from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)\n  + `relation.object-type` - metadata for records with a relation, where the object type matches given type from the Crossref relations schema (e.g. doi, issn)\n  + `relation.object` - metadata for records with a relation, where the object identifier matches given identifier\n+ `ror-id` - metadata with given ROR ID\n+ `type` - metadata records whose type equals given type, type must be an ID value from the list of types returned by the /types resource\n+ `type-name` - metadata for records with type name equal to given name\n+ `until-accepted-date` - [date], metadata where accepted date is before given date (inclusive)\n+ `until-approved-date` - [date], metadata where approved date is before given date (inclusive)\n+ `until-awarded-date` - [date], metadata where award date is before given date (inclusive)\n+ `until-created-date` - [date], metadata first deposited before given date (inclusive)\n+ `until-deposit-date` - [date], metadata last (re)deposited before given date (inclusive)\n+ `until-event-end-date` - [date], metadata where event end date is before given date (inclusive)\n+ `until-event-start-date` - [date], metadata where event start date is before given date  (inclusive)\n+ `until-index-date` - [date], metadata indexed before given date (inclusive)\n+ `until-issued-date` - [date], metadata where issued date is before given date  (inclusive)\n+ `until-online-pub-date` - [date], metadata where online published date is before given date (inclusive)\n+ `until-posted-date` - [date], metadata where posted date is before given date (inclusive)\n+ `until-print-pub-date` - [date], metadata where print published date is before given date (inclusive)\n+ `until-pub-date` - [date], metadata where published date is before given date (inclusive)\n+ `until-update-date` - [date], metadata updated before given date (inclusive), currently the same as `until-deposit-date`\n+ `update-type` - metadata with given update type\n+ `updates` - metadata for records that represent editorial updates to given DOI\n## Elements\n\nCrossref metadata records can be quite large. Sometimes you just want a few elements from the schema. You can \\\"select\\\" a subset of elements to return using the `select` parameter. This can make your API calls much more efficient. For example:\n\n##\n```\n/works?select=DOI,prefix,title\n```\n\n##\n\nThis endpoint supports selecting the following elements.\n\n##\n\n+ `DOI`\n+ `ISBN`\n+ `ISSN`\n+ `URL`\n+ `abstract`\n+ `accepted`\n+ `alternative-id`\n+ `approved`\n+ `archive`\n+ `article-number`\n+ `assertion`\n+ `author`\n+ `chair`\n+ `clinical-trial-number`\n+ `container-title`\n+ `content-created`\n+ `content-domain`\n+ `created`\n+ `degree`\n+ `deposited`\n+ `editor`\n+ `event`\n+ `funder`\n+ `group-title`\n+ `indexed`\n+ `is-referenced-by-count`\n+ `issn-type`\n+ `issue`\n+ `issued`\n+ `license`\n+ `link`\n+ `member`\n+ `original-title`\n+ `page`\n+ `posted`\n+ `prefix`\n+ `published`\n+ `published-online`\n+ `published-print`\n+ `publisher`\n+ `publisher-location`\n+ `reference`\n+ `references-count`\n+ `relation`\n+ `score`\n+ `short-container-title`\n+ `short-title`\n+ `standards-body`\n+ `subject`\n+ `subtitle`\n+ `title`\n+ `translator`\n+ `type`\n+ `update-policy`\n+ `update-to`\n+ `updated-by`\n+ `volume`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n\n## Sample\n\nBeing able to select random results is useful for both testing and sampling. You can use the `sample` parameter to retrieve random results. So, for example, the following selects 10 random works:\n\n##\n```\n/works?sample=10\n```\n##\n\nNote that when you use the `sample` parameter, the `rows` and `offset` parameters are ignored.\n\n\n## Parameter combinations\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` can be used with offsets. Sampling cannot be combined with offsets.\n\n##\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` may also be used with deep paging cursors. `rows` may also be specified.\n\n##\n\n`offset` and `sample` cannot be used in combination with cursors.\n\n##\n",
        "parameters": [
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "order",
            "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc",
            "required": false,
            "pattern": "(asc|desc)",
            "type": "string"
          },
          {
            "in": "query",
            "name": "facet",
            "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "sample",
            "description": "Exposes the ability to return `N` randomly sampled items",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Exposes the ability to sort results by a certain field, e.g. `score`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "select",
            "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`",
            "required": false,
            "pattern": "^\\w+(,\\w+)*$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorksMessage"
            },
            "description": "A list of works"
          }
        },
        "tags": [
          "Works"
        ]
      }
    },
    "/deposits": {
      "get": {
        "description": "Returns a list of deposits.\n## Filters\n\nFilters allow you to select deposits based on specific criteria. All filter results are lists.\n\n##\n\nExamples:\n\n##\n```\n/deposits?filter=from-submission-time:2020-06-01\n```\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `doi`\n+ `from-submission-time`\n+ `owner`\n+ `status`\n+ `test`\n+ `type`\n+ `until-submission-time`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n",
        "security": [
          "basicAuth"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/DepositsMessage"
            },
            "description": "A list of deposits"
          }
        },
        "tags": [
          "Deposits"
        ]
      },
      "post": {
        "description": "Deposit new content.",
        "security": [
          "basicAuth"
        ],
        "consumes": [
          "application/vnd.crossref.deposit+xml"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "test",
            "description": "Is the deposit for test purposes?",
            "required": false,
            "type": "boolean"
          },
          {
            "in": "body",
            "name": "data",
            "description": "",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/DepositMessage"
            },
            "description": "The newly created deposit."
          }
        },
        "tags": [
          "Deposits"
        ]
      }
    },
    "/works/{doi}/agency": {
      "get": {
        "description": "Gets the agency associated with a specific work by its DOI, as an example use DOI 10.5555/12345678",
        "parameters": [
          {
            "in": "path",
            "name": "doi",
            "description": "The DOI identifier associated with the work",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/AgencyMessage"
            },
            "description": "The agency associated with work identified by {doi}."
          },
          "404": {
            "description": "The work identified by {doi} does not exist."
          }
        },
        "tags": [
          "Works"
        ]
      }
    },
    "/members": {
      "get": {
        "description": "Returns a list of all Crossref members (mostly publishers).\n## Queries\n\nFree form search queries can be made, for example, funders that include `association` and `library`:\n\n##\n\n```\n/members?query=association+library\n```\n\n\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nExample:\n\n##\n```\n/members?filter=current-doi-count:0\n```\n##\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `current-doi-count:0`\n- `backfile-doi-count:0`\n- `prefix:10.1296`\n- `prefix:10.2481`\n\nwould locate members with no current DOIs and no backfile DOIs and with prefix 10.1296 or 10.2481. These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/members?filter=current-doi-count:0,backfile-doi-count:0,prefix:10.1296,prefix:10.2481\n```\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `backfile-doi-count` - members with given count of DOIs for material published more than two years ago\n+ `current-doi-count` - members with given count of DOIs for material published within last two years\n+ `prefix` - members with given prefix\n## Pagination with offsets\n\nOffsets can be used to iterate over the results. For this route, the maximum number of available results is 80,000, which in this case allows to retrieve all the indexed items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n",
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/MembersMessage"
            },
            "description": "A collection of members"
          }
        },
        "tags": [
          "Members"
        ]
      }
    },
    "/journals/{issn}/works": {
      "get": {
        "description": "Returns a list of works in the journal identified by {issn}.\n## Queries\n\nFree form search queries can be made, for example, works that include `renear` or `ontologies` (or both):\n\n##\n\n```\n/works?query=renear+ontologies\n```\n\n\n## Field Queries\nField queries allow for queries that match only particular fields of metadata. For example, this query matches records that contain the tokens `richard` or `feynman` (or both) in any author field:\n\n##\n\n```\n/works?query.author=richard+feynman\n```\n\n##\n\nField queries can be combined with the general `query` parameter and each other. Each query parameter is ANDed with the others:\n\n##\n```\n/works?query.title=room+at+the+bottom&query.author=richard+feynman\n```\n\n##\n\nThis endpoint supports the following field queries:\n\n##\n\n+ `query.affiliation` - query contributor affiliations\n+ `query.author` - query author given and family names\n+ `query.bibliographic` - query bibliographic information, useful for citation look up, includes titles, authors, ISSNs and publication years\n+ `query.chair` - query chair given and family names\n+ `query.container-title` - query container title aka. publication name\n+ `query.contributor` - query author, editor, chair and translator given and family names\n+ `query.degree` - query degree\n+ `query.description` - query description\n+ `query.editor` - query editor given and family names\n+ `query.event-acronym` - query acronym of the event\n+ `query.event-location` - query location of the event\n+ `query.event-name` - query name of the event\n+ `query.event-sponsor` - query sponsor of the event\n+ `query.event-theme` - query theme of the event\n+ `query.funder-name` - query name of the funder\n+ `query.publisher-location` - query location of the publisher\n+ `query.publisher-name` - query publisher name\n+ `query.standards-body-acronym` - query acronym of the standards body\n+ `query.standards-body-name` - query standards body name\n+ `query.title` - query title\n+ `query.translator` - query translator given and family names\n## Sort\n\nResults can be sorted by applying the `sort` and `order` parameters. `sort` sets the field by which results will be sorted. `order` sets the result ordering, either `asc` or `desc` (default is `desc`).\n\nAn example that sorts results in order of publication, beginning with the least recent:\n\n##\n\n```\n/works?query=josiah+carberry&sort=published&order=asc\n```\n\n##\n\nThis endpoint supports sorting by the following elements:\n\n##\n\n+ `created` - sort by created date\n+ `deposited` - sort by time of most recent deposit\n+ `indexed` - sort by time of most recent index\n+ `is-referenced-by-count` - sort by number of times this DOI is referenced by other Crossref DOIs\n+ `issued` - sort by issued date (earliest known publication date)\n+ `published` - sort by publication date\n+ `published-online` - sort by online publication date\n+ `published-print` - sort by print publication date\n+ `references-count` - sort by number of references included in the references section of the document identified by this DOI\n+ `relevance` - sort by relevance score\n+ `score` - sort by relevance score\n+ `updated` - sort by date of most recent change to metadata, currently the same as deposited\n## Facets\n\nFacet counts can be retrieved by enabling faceting. Facets are enabled by providing facet field names along with a maximum number of returned term values. The larger the number of returned values, the longer the query will take. Some facet fields can accept a `*` as their maximum, which indicates that all values should be returned.\n\n##\n\nFor example, to get facet counts for all work types:\n\n##\n```\n/works?facet=type-name:*\n```\n\n##\n\nThis endpoint supports the following facets:\n\n##\n\n+ `affiliation` - author affiliation\n+ `archive` - archive location\n+ `assertion` - custom Crossmark assertion name\n+ `assertion-group` - custom Crossmark assertion group name\n+ `category-name` - category name of work\n+ `container-title` - [max value 100], work container title, such as journal title, or book title\n+ `funder-doi` - funder DOI\n+ `funder-name` - funder literal name as deposited alongside DOI\n+ `issn` - [max value 100], journal ISSN (any - print, electronic, link)\n+ `journal-issue` - journal issue number\n+ `journal-volume` - journal volume\n+ `license` - license URI of work\n+ `link-application` - intended application of the full text link\n+ `orcid` - [max value 100], contributor ORCID\n+ `published` - earliest year of publication\n+ `publisher-name` - publisher name of work\n+ `relation-type` - relation type described by work or described by another work with work as object\n+ `ror-id` - institution ROR ID\n+ `source` - source of the DOI\n+ `type-name` - work type name, such as journal-article or book-chapter\n+ `update-type` - significant update type\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nFor example:\n\n##\n```\n/works?filter=type:dataset\n```\n\n### Multiple filters\n\nMultiple filters can be specified in a single query. In such a case, different filters will be applied with AND semantics, while specifying the same filter multiple times will result in OR semantics - that is, specifying the filters:\n\n- `is-update:true`\n- `from-pub-date:2014-03-03`\n- `funder:10.13039/100000001`\n- `funder:10.13039/100000050`\n\nwould locate documents that are updates, were published on or after 3rd March 2014 and were funded by either the National Science Foundation (`10.13039/100000001`) or the National Heart, Lung, and Blood Institute (`10.13039/100000050`). These filters would be specified by joining each filter together with a comma:\n\n##\n```\n/works?filter=is-update:true,from-pub-date:2014-03-03,funder:10.13039/100000001,funder:10.13039/100000050\n```\n\n### Dot filters\n\nA filter with a dot in its name is special. The dot signifies that the filter will be applied to some other record type that is related to primary resource record type. For example, with work queries, one can filter on works that have an award, where the same award has a particular award number and award-giving funding agency:\n\n##\n```\n/works?filter=award.number:CBET-0756451,award.funder:10.13039/100000001\n```\n##\n\nHere we filter on works that have an award by the National Science Foundation that also has the award number `CBET-0756451`.\n\n### Note on dates\n\nThe dates in filters should always be of the form YYYY-MM-DD, YYYY-MM or YYYY. The date filters are inclusive. For example:\n\n* `from-pub-date:2018-09-18` filters works published on or after 18th September 2018\n* `from-created-date:2016-02-29,until-created-date:2016-02-29` filters works first deposited on 29th February 2016\n* `until-created-date:2010-06` filters works first deposited in or before June 2010\n* `from-update-date:2017,until-update-date:2017` filters works with metadata updated in 2017\n\nAlso note that date information in Crossref metadata can often be incomplete. So, for example, a publisher may only include the year and month of publication for a journal article. For a monograph they might just include the year. In these cases the API selects the earliest possible date given the information provided. So, for instance, if the publisher only provided 2013-02 as the published date, then the date would be treated as 2013-02-01. Similarly, if the publisher only provided the year 2013 as the date, it would be treated at 2013-01-01.\n\n### Note on owner prefixes\n\nThe prefix of a Crossref DOI does **NOT** indicate who currently owns the DOI. It only reflects who originally registered the DOI. Crossref metadata has an **prefix** element that records the current owner of the Crossref DOI in question.\n\n##\n\nCrossref also has member IDs for depositing organisations. A single member may control multiple owner prefixes, which in turn may control a number of DOIs. When looking at works published by a certain organisaton, member IDs and the member routes should be used.\n\n### Notes on incremental metadata updates\n\nWhen using time filters to retrieve periodic, incremental metadata updates, the `from-index-date` filter should be used over `from-update-date`, `from-deposit-date`, `from-created-date` and `from-pub-date`. The timestamp that `from-index-date` filters on is guaranteed to be updated every time there is a change to metadata requiring a reindex.\n\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `alternative-id` - metadata for records with the given alternative ID, which may be a publisher-specific ID, or any other identifier a publisher may have provided\n+ `archive` - metadata where value of archive partner equals given archive name\n+ `article-number` - metadata for records with a given article number\n+ `assertion` - metadata for records with a given named assertion\n+ `assertion-group` - metadata for records with an assertion in a given group\n+ `award`\n  + `award.funder` - metadata for records with award funder equal to given funder, optionally combine with `award.number`\n  + `award.number` - metadata for records with award number equal to given number, optionally combine with `award.funder`\n+ `category-name` - metadata for records with category label equal to given name, category labels come from the list published by Scopus\n+ `citation-id`\n+ `clinical-trial-number` - metadata for records with given clinical trial number\n+ `container-title` - metadata with a publication title that exactly equals given title\n+ `content-domain` - metadata where the publisher records a given domain name as the location Crossmark content will appear\n+ `doi` - metadata describing given DOI\n+ `from-accepted-date` - [date], metadata where accepted date is since given date (inclusive)\n+ `from-approved-date` - [date], metadata where approved date is since given date (inclusive)\n+ `from-awarded-date` - [date], metadata where award date is since given date (inclusive)\n+ `from-created-date` - [date], metadata first deposited since given date (inclusive)\n+ `from-deposit-date` - [date], metadata last (re)deposited since given date (inclusive)\n+ `from-event-end-date` - [date], metadata where event end date is since given date (inclusive)\n+ `from-event-start-date` - [date], metadata where event start date is since given date  (inclusive)\n+ `from-index-date` - [date], metadata indexed since given date (inclusive)\n+ `from-issued-date` - [date], metadata where issued date is since given date  (inclusive)\n+ `from-online-pub-date` - [date], metadata where online published date is since given date (inclusive)\n+ `from-posted-date` - [date], metadata where posted date is since given date (inclusive)\n+ `from-print-pub-date` - [date], metadata where print published date is since given date (inclusive)\n+ `from-pub-date` - [date], metadata where published date is since given date (inclusive)\n+ `from-update-date` - [date], metadata updated since given date (inclusive), currently the same as `from-deposit-date`\n+ `full-text`\n  + `full-text.type` - metadata where `resource` element's `content_type` attribute equals given version mime type (e.g. application/pdf)\n  + `full-text.application` - [text-mining, similarity-checking or unspecified], metadata where `resource` link has given application\n  + `full-text.version` - metadata where `resource` element's `content_version` attribute equals given version\n+ `funder` - metadata which include given funder id in FundRef data\n+ `funder-doi-asserted-by` - metadata where funder DOI was asserted by given body\n+ `group-title` - metadata with given group title\n+ `gte-award-amount` - metadata where award is greater than or equals given number\n+ `has-abstract` - [0 or 1], metadata for records with/without an abstract\n+ `has-affiliation` - [0 or 1], metadata for records with/without affiliation information\n+ `has-archive` - [0 or 1], metadata which includes/does not include name of archive partner\n+ `has-assertion` - [0 or 1], metadata for records with/without assertions\n+ `has-authenticated-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID\n+ `has-award` - [0 or 1], metadata for records with/without award\n+ `has-clinical-trial-number` - [0 or 1], metadata for records with/without a clinical trial number\n+ `has-content-domain` - [0 or 1], metadata where the publisher records/does not record a domain name location for Crossmark content\n+ `has-description`\n+ `has-domain-restriction` - [0 or 1], metadata where the publisher restricts/does not restrict Crossmark usage to content domains\n+ `has-event` - [0 or 1], metadata for records with/without event\n+ `has-full-text` - [0 or 1], metadata that includes/does not include any full text `resource` elements\n+ `has-funder` - [0 or 1], metadata which includes/does not include one or more funder entry\n+ `has-funder-doi` - [0 or 1], metadata for records with/without funder DOI\n+ `has-license` - [0 or 1], metadata that includes/does not include any `license_ref` elements\n+ `has-orcid` - [0 or 1], metadata which includes/does not include one or more ORCIDs\n+ `has-references` - [0 or 1], metadata for works that have/don't have a list of references\n+ `has-relation` - [0 or 1], metadata for records that either assert/do not assert or are/are not the object of a relation\n+ `has-ror-id` - [0 or 1], metadata for records with/without ROR ID\n+ `has-update` - [0 or 1], metadata for records with/without update information\n+ `has-update-policy` - [0 or 1], metadata for records that include/do not include a link to an editorial update policy\n+ `is-update` - [0 or 1], metadata for records that represent/do not represent editorial updates\n+ `isbn` - metadata with given ISBN\n+ `issn` - metadata with given ISSN, format is xxxx-xxxx\n+ `license`\n  + `license.url` - metadata where `license_ref` value equals given url\n  + `license.version` - metadata where the `license_ref`'s `applies_to` attribute equals given version\n  + `license.delay` - metadata where difference between publication date and the `license_ref`'s `start_date` attribute is <= than given delay (in days)\n+ `lte-award-amount` - metadata where award is less than or equals given number\n+ `member` - metadata belonging to a given Crossref member\n+ `orcid` - metadata where there is a contributor with given ORCID\n+ `prefix` - metadata belonging to a given DOI owner prefix (e.g. 10.1016)\n+ `relation`\n  + `relation.type` - metadata for records with a relation with the given type from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)\n  + `relation.object-type` - metadata for records with a relation, where the object type matches given type from the Crossref relations schema (e.g. doi, issn)\n  + `relation.object` - metadata for records with a relation, where the object identifier matches given identifier\n+ `ror-id` - metadata with given ROR ID\n+ `type` - metadata records whose type equals given type, type must be an ID value from the list of types returned by the /types resource\n+ `type-name` - metadata for records with type name equal to given name\n+ `until-accepted-date` - [date], metadata where accepted date is before given date (inclusive)\n+ `until-approved-date` - [date], metadata where approved date is before given date (inclusive)\n+ `until-awarded-date` - [date], metadata where award date is before given date (inclusive)\n+ `until-created-date` - [date], metadata first deposited before given date (inclusive)\n+ `until-deposit-date` - [date], metadata last (re)deposited before given date (inclusive)\n+ `until-event-end-date` - [date], metadata where event end date is before given date (inclusive)\n+ `until-event-start-date` - [date], metadata where event start date is before given date  (inclusive)\n+ `until-index-date` - [date], metadata indexed before given date (inclusive)\n+ `until-issued-date` - [date], metadata where issued date is before given date  (inclusive)\n+ `until-online-pub-date` - [date], metadata where online published date is before given date (inclusive)\n+ `until-posted-date` - [date], metadata where posted date is before given date (inclusive)\n+ `until-print-pub-date` - [date], metadata where print published date is before given date (inclusive)\n+ `until-pub-date` - [date], metadata where published date is before given date (inclusive)\n+ `until-update-date` - [date], metadata updated before given date (inclusive), currently the same as `until-deposit-date`\n+ `update-type` - metadata with given update type\n+ `updates` - metadata for records that represent editorial updates to given DOI\n## Elements\n\nCrossref metadata records can be quite large. Sometimes you just want a few elements from the schema. You can \\\"select\\\" a subset of elements to return using the `select` parameter. This can make your API calls much more efficient. For example:\n\n##\n```\n/works?select=DOI,prefix,title\n```\n\n##\n\nThis endpoint supports selecting the following elements.\n\n##\n\n+ `DOI`\n+ `ISBN`\n+ `ISSN`\n+ `URL`\n+ `abstract`\n+ `accepted`\n+ `alternative-id`\n+ `approved`\n+ `archive`\n+ `article-number`\n+ `assertion`\n+ `author`\n+ `chair`\n+ `clinical-trial-number`\n+ `container-title`\n+ `content-created`\n+ `content-domain`\n+ `created`\n+ `degree`\n+ `deposited`\n+ `editor`\n+ `event`\n+ `funder`\n+ `group-title`\n+ `indexed`\n+ `is-referenced-by-count`\n+ `issn-type`\n+ `issue`\n+ `issued`\n+ `license`\n+ `link`\n+ `member`\n+ `original-title`\n+ `page`\n+ `posted`\n+ `prefix`\n+ `published`\n+ `published-online`\n+ `published-print`\n+ `publisher`\n+ `publisher-location`\n+ `reference`\n+ `references-count`\n+ `relation`\n+ `score`\n+ `short-container-title`\n+ `short-title`\n+ `standards-body`\n+ `subject`\n+ `subtitle`\n+ `title`\n+ `translator`\n+ `type`\n+ `update-policy`\n+ `update-to`\n+ `updated-by`\n+ `volume`\n## Pagination with offsets\n\nOffsets are an easy way to iterate over results sets up to 10,000 items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n\n## Sample\n\nBeing able to select random results is useful for both testing and sampling. You can use the `sample` parameter to retrieve random results. So, for example, the following selects 10 random works:\n\n##\n```\n/works?sample=10\n```\n##\n\nNote that when you use the `sample` parameter, the `rows` and `offset` parameters are ignored.\n\n\n## Parameter combinations\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` can be used with offsets. Sampling cannot be combined with offsets.\n\n##\n\nAny combination of `query`, `query.*`, `filter`, `facet`, `select` and `sort` may also be used with deep paging cursors. `rows` may also be specified.\n\n##\n\n`offset` and `sample` cannot be used in combination with cursors.\n\n##\n",
        "parameters": [
          {
            "in": "path",
            "name": "issn",
            "description": "The ISSN identifier associated with the journal",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "order",
            "description": "Combined with sort can be used to specify the order of results, e.g. asc or desc",
            "required": false,
            "pattern": "(asc|desc)",
            "type": "string"
          },
          {
            "in": "query",
            "name": "facet",
            "description": "Exposes the ability to retrieve counts for pre-defined facets e.g. `type-name:*` returns counts of all works by type",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "sample",
            "description": "Exposes the ability to return `N` randomly sampled items",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "sort",
            "description": "Exposes the ability to sort results by a certain field, e.g. `score`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "select",
            "description": "Exposes the ability to select certain fields, supports a comma separated list of fields, e.g. `DOI,volume`",
            "required": false,
            "pattern": "^\\w+(,\\w+)*$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to filter by certain fields, supports a comma separated list of lucene filters, e.g. `content-domain:psychoceramics.labs.crossref.org`",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/WorksMessage"
            },
            "description": "A list of works"
          }
        },
        "tags": [
          "Journals"
        ]
      }
    },
    "/funders/{id}": {
      "get": {
        "description": "Returns metadata for specified funder **and** its suborganizations, as an example use id 501100006004",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "The id of the funder",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/FunderMessage"
            },
            "description": "The funder identified by {id}."
          },
          "404": {
            "description": "The funder identified by {id} does not exist."
          }
        },
        "tags": [
          "Funders"
        ]
      }
    },
    "/funders": {
      "get": {
        "description": "Returns a list of all funders in the [Funder Registry](https://gitlab.com/crossref/open_funder_registry).\n## Queries\n\nFree form search queries can be made, for example, funders that include `research` and `foundation`:\n\n##\n\n```\n/funders?query=research+foundation\n```\n\n\n## Filters\n\nFilters allow you to select items based on specific criteria. All filter results are lists.\n\n##\n\nExample:\n\n##\n```\n/funders?filter=location:Spain\n```\n##\n\nThis endpoint supports the following filters:\n\n##\n\n+ `location` - funders located in given country\n## Pagination with offsets\n\nOffsets can be used to iterate over the results. For this route, the maximum number of available results is 80,000, which in this case allows to retrieve all the indexed items. This limit applies to the sum of values of parameters `offset` + `rows`.\n\n##\n\nThe number of items returned in a single response is controlled by `rows` parameter (default is 20, and maximum is 1,000). To limit results to 5, for example, you could do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5\n```\n\n##\n\n`offset` parameter can be used to retrieve items starting from a specific index of the result list. For example, to select the second set of 5 results (i.e. results 6 through 10), you would do the following:\n\n##\n\n```\n/works?query=allen+renear&rows=5&offset=5\n```\n\n##\n\n## Deep paging\n\nDeep paging using cursors can be used to iterate over large result sets, without any limits on their size.\n\n##\n\nTo use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`, for example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=*\n```\n\n##\n\nA `next-cursor` field will be provided in the JSON response. To get the next page of results, pass the value of `next-cursor` as the cursor parameter (remember to URL-encode). For example:\n\n##\n\n```\n/members/311/works?filter=type:journal-article&cursor=<value of next-cursor parameter>\n```\n\n##\n\nClients should check the number of returned items. If the number of returned items is equal to the number of expected rows then the end of the result set has been reached. Using next-cursor beyond this point will result in responses with an empty items list.\n\n##\n",
        "parameters": [
          {
            "in": "query",
            "name": "filter",
            "description": "Exposes the ability to search funders by location using a Lucene based syntax",
            "required": false,
            "pattern": "location:.*",
            "type": "string"
          },
          {
            "in": "query",
            "name": "cursor",
            "description": "Exposes the ability to deep page through large result sets, where offset would cause performance problems",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "query",
            "description": "Exposes the ability to free text query certain fields",
            "required": false,
            "type": "string"
          },
          {
            "in": "query",
            "name": "rows",
            "description": "The number of rows per page",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "in": "query",
            "name": "mailto",
            "description": "The email address to identify yourself and be in the \"polite pool\"",
            "required": false,
            "pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9-]+\\.[A-Za-z]{2,6}$",
            "type": "string"
          },
          {
            "in": "query",
            "name": "offset",
            "description": "The number of rows to skip before returning",
            "required": false,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/FundersMessage"
            },
            "description": "A list of funders."
          }
        },
        "tags": [
          "Funders"
        ]
      }
    },
    "/prefixes/{prefix}": {
      "get": {
        "description": "Returns metadata for the DOI owner prefix, as an example use prefix 10.1016",
        "parameters": [
          {
            "in": "path",
            "name": "prefix",
            "description": "",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/PrefixMessage"
            },
            "description": "The prefix data identified by {prefix}."
          },
          "404": {
            "description": "The prefix data identified by {prefix} does not exist."
          }
        },
        "tags": [
          "Prefixes"
        ]
      }
    }
  },
  "definitions": {
    "Affiliation": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "name"
      ]
    },
    "Agency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "label": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id",
        "label"
      ]
    },
    "AgencyMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "work-agency"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/DoiAgency"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Author": {
      "type": "object",
      "properties": {
        "ORCID": {
          "type": "string"
        },
        "suffix": {
          "type": "string"
        },
        "given": {
          "type": "string"
        },
        "family": {
          "type": "string"
        },
        "affiliation": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Affiliation"
          }
        },
        "name": {
          "type": "string"
        },
        "authenticated-orcid": {
          "type": "boolean"
        },
        "prefix": {
          "type": "string"
        },
        "sequence": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "family",
        "affiliation",
        "sequence"
      ]
    },
    "Coverage": {
      "type": "object",
      "properties": {
        "last-status-check-time": {
          "type": "integer",
          "format": "int64"
        },
        "affiliations": {
          "type": "number",
          "format": "double"
        },
        "abstracts": {
          "type": "number",
          "format": "double"
        },
        "orcids": {
          "type": "number",
          "format": "double"
        },
        "licenses": {
          "type": "number",
          "format": "double"
        },
        "references": {
          "type": "number",
          "format": "double"
        },
        "funders": {
          "type": "number",
          "format": "double"
        },
        "similarity-checking": {
          "type": "number",
          "format": "double"
        },
        "award-numbers": {
          "type": "number",
          "format": "double"
        },
        "ror-ids": {
          "type": "number",
          "format": "double"
        },
        "update-policies": {
          "type": "number",
          "format": "double"
        },
        "resource-links": {
          "type": "number",
          "format": "double"
        },
        "descriptions": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false,
      "required": [
        "last-status-check-time",
        "affiliations",
        "abstracts",
        "orcids",
        "licenses",
        "references",
        "funders",
        "similarity-checking",
        "award-numbers",
        "ror-ids",
        "update-policies",
        "resource-links",
        "descriptions"
      ]
    },
    "CoverageFull": {
      "type": "object",
      "properties": {
        "affiliations-current": {
          "type": "number",
          "format": "double"
        },
        "similarity-checking-current": {
          "type": "number",
          "format": "double"
        },
        "descriptions-current": {
          "type": "number",
          "format": "double"
        },
        "ror-ids-current": {
          "type": "number",
          "format": "double"
        },
        "references-backfie": {
          "type": "number",
          "format": "double"
        },
        "funders-backfile": {
          "type": "number",
          "format": "double"
        },
        "licenses-backfile": {
          "type": "number",
          "format": "double"
        },
        "funders-current": {
          "type": "number",
          "format": "double"
        },
        "affiliations-backfile": {
          "type": "number",
          "format": "double"
        },
        "resource-links-backfile": {
          "type": "number",
          "format": "double"
        },
        "orcids-backfile": {
          "type": "number",
          "format": "double"
        },
        "update-policies-current": {
          "type": "number",
          "format": "double"
        },
        "ror-ids-backfile": {
          "type": "number",
          "format": "double"
        },
        "orcids-current": {
          "type": "number",
          "format": "double"
        },
        "similarity-checking-backfile": {
          "type": "number",
          "format": "double"
        },
        "descriptions-backfile": {
          "type": "number",
          "format": "double"
        },
        "award-numbers-backfile": {
          "type": "number",
          "format": "double"
        },
        "update-policies-backfile": {
          "type": "number",
          "format": "double"
        },
        "licenses-current": {
          "type": "number",
          "format": "double"
        },
        "award-numbers-current": {
          "type": "number",
          "format": "double"
        },
        "abstracts-backfile": {
          "type": "number",
          "format": "double"
        },
        "resource-links-current": {
          "type": "number",
          "format": "double"
        },
        "abstracts-current": {
          "type": "number",
          "format": "double"
        },
        "references-current": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false,
      "required": [
        "affiliations-current",
        "similarity-checking-current",
        "descriptions-current",
        "ror-ids-current",
        "references-backfie",
        "funders-backfile",
        "licenses-backfile",
        "funders-current",
        "affiliations-backfile",
        "resource-links-backfile",
        "orcids-backfile",
        "update-policies-current",
        "ror-ids-backfile",
        "orcids-current",
        "similarity-checking-backfile",
        "descriptions-backfile",
        "award-numbers-backfile",
        "update-policies-backfile",
        "licenses-current",
        "award-numbers-current",
        "abstracts-backfile",
        "resource-links-current",
        "abstracts-current",
        "references-current"
      ]
    },
    "Date": {
      "type": "object",
      "properties": {
        "date-parts": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        },
        "date-time": {
          "type": "string",
          "format": "date-time"
        },
        "timestamp": {
          "type": "integer",
          "format": "int64"
        }
      },
      "additionalProperties": false,
      "required": [
        "date-parts",
        "date-time",
        "timestamp"
      ]
    },
    "DateParts": {
      "type": "object",
      "properties": {
        "date-parts": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "date-parts"
      ]
    },
    "Deposit": {
      "type": "object",
      "properties": {
        "matched-citation-count": {
          "type": "integer",
          "format": "int64"
        },
        "filename": {
          "type": "string"
        },
        "submitted-at": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "length": {
          "type": "integer",
          "format": "int64"
        },
        "pingback-url": {
          "type": "string"
        },
        "citation-count": {
          "type": "integer",
          "format": "int64"
        },
        "test": {
          "type": "boolean"
        },
        "owner": {
          "type": "string"
        },
        "batch-id": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "matched-citation-count",
        "filename",
        "submitted-at",
        "status",
        "length",
        "pingback-url",
        "citation-count",
        "test",
        "owner",
        "batch-id"
      ]
    },
    "DepositMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "deposit"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Deposit"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Deposits": {
      "type": "object",
      "properties": {
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Deposit"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "total-results",
        "items"
      ]
    },
    "DepositsMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "deposit-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Deposits"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "DoiAgency": {
      "type": "object",
      "properties": {
        "DOI": {
          "description": "The DOI identifier associated with the work",
          "type": "string"
        },
        "agency": {
          "$ref": "#/definitions/Agency"
        }
      },
      "additionalProperties": false,
      "required": [
        "DOI",
        "agency"
      ]
    },
    "DoiCounts": {
      "type": "object",
      "properties": {
        "total-dois": {
          "type": "integer",
          "format": "int64"
        },
        "current-dois": {
          "type": "integer",
          "format": "int64"
        },
        "backfile-dois": {
          "type": "integer",
          "format": "int64"
        }
      },
      "additionalProperties": false,
      "required": [
        "total-dois",
        "current-dois",
        "backfile-dois"
      ]
    },
    "Flags": {
      "type": "object",
      "properties": {
        "deposits-abstracts-current": {
          "type": "boolean"
        },
        "deposits-orcids-current": {
          "type": "boolean"
        },
        "deposits": {
          "type": "boolean"
        },
        "deposits-affiliations-backfile": {
          "type": "boolean"
        },
        "deposits-update-policies-backfile": {
          "type": "boolean"
        },
        "deposits-award-numbers-current": {
          "type": "boolean"
        },
        "deposits-resource-links-current": {
          "type": "boolean"
        },
        "deposits-ror-ids-current": {
          "type": "boolean"
        },
        "deposits-articles": {
          "type": "boolean"
        },
        "deposits-affiliations-current": {
          "type": "boolean"
        },
        "deposits-funders-current": {
          "type": "boolean"
        },
        "deposits-references-backfile": {
          "type": "boolean"
        },
        "deposits-ror-ids-backfile": {
          "type": "boolean"
        },
        "deposits-abstracts-backfile": {
          "type": "boolean"
        },
        "deposits-licenses-backfile": {
          "type": "boolean"
        },
        "deposits-award-numbers-backfile": {
          "type": "boolean"
        },
        "deposits-descriptions-current": {
          "type": "boolean"
        },
        "deposits-references-current": {
          "type": "boolean"
        },
        "deposits-resource-links-backfile": {
          "type": "boolean"
        },
        "deposits-descriptions-backfile": {
          "type": "boolean"
        },
        "deposits-orcids-backfile": {
          "type": "boolean"
        },
        "deposits-funders-backfile": {
          "type": "boolean"
        },
        "deposits-update-policies-current": {
          "type": "boolean"
        },
        "deposits-licenses-current": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "required": [
        "deposits-abstracts-current",
        "deposits-orcids-current",
        "deposits",
        "deposits-affiliations-backfile",
        "deposits-update-policies-backfile",
        "deposits-award-numbers-current",
        "deposits-resource-links-current",
        "deposits-ror-ids-current",
        "deposits-articles",
        "deposits-affiliations-current",
        "deposits-funders-current",
        "deposits-references-backfile",
        "deposits-ror-ids-backfile",
        "deposits-abstracts-backfile",
        "deposits-licenses-backfile",
        "deposits-award-numbers-backfile",
        "deposits-descriptions-current",
        "deposits-references-current",
        "deposits-resource-links-backfile",
        "deposits-descriptions-backfile",
        "deposits-orcids-backfile",
        "deposits-funders-backfile",
        "deposits-update-policies-current",
        "deposits-licenses-current"
      ]
    },
    "Funder": {
      "type": "object",
      "properties": {
        "id": {
          "description": "The id of the funder",
          "type": "string"
        },
        "location": {
          "description": "The geographic location of the funder",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "alt-names": {
          "description": "Other names this funder may be identified with",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "uri": {
          "type": "string"
        },
        "replaces": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "replaced-by": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "tokens": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "id",
        "location",
        "name",
        "alt-names",
        "uri",
        "replaces",
        "replaced-by",
        "tokens"
      ]
    },
    "FunderFull": {
      "type": "object",
      "properties": {
        "hierarchy-names": {
          "$ref": "#/definitions/FunderMessageMessageHierarchyNames"
        },
        "replaced-by": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "work-count": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string"
        },
        "descendants": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "descendant-work-count": {
          "type": "integer",
          "format": "int64"
        },
        "id": {
          "description": "The id of the funder",
          "type": "string"
        },
        "tokens": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "replaces": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "uri": {
          "type": "string"
        },
        "hierarchy": {
          "$ref": "#/definitions/FunderHierarchy"
        },
        "alt-names": {
          "description": "Other names this funder may be identified with",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "location": {
          "description": "The geographic location of the funder",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "hierarchy-names",
        "replaced-by",
        "work-count",
        "name",
        "descendants",
        "descendant-work-count",
        "id",
        "tokens",
        "replaces",
        "uri",
        "hierarchy",
        "alt-names",
        "location"
      ]
    },
    "FunderHierarchy": {
      "type": "object",
      "properties": {
        "more": {
          "type": "boolean"
        }
      },
      "additionalProperties": {
        "$ref": "#/definitions/FunderMessageMessageHierarchyJava.lang.string39106"
      }
    },
    "FunderMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "funder"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/FunderFull"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "FunderMessageMessageHierarchyJava.lang.string39106": {
      "type": "object",
      "additionalProperties": false
    },
    "FunderMessageMessageHierarchyNames": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "Funders": {
      "type": "object",
      "properties": {
        "items-per-page": {
          "type": "integer",
          "format": "int64"
        },
        "query": {
          "$ref": "#/definitions/Query"
        },
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Funder"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "items-per-page",
        "query",
        "total-results",
        "items"
      ]
    },
    "FundersMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "funder-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Funders"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Journal": {
      "type": "object",
      "properties": {
        "last-status-check-time": {
          "type": "integer",
          "format": "int64"
        },
        "counts": {
          "$ref": "#/definitions/DoiCounts"
        },
        "breakdowns": {
          "$ref": "#/definitions/JournalsMessageMessageItemsBreakdowns"
        },
        "publisher": {
          "description": "The publisher of the journal",
          "type": "string"
        },
        "coverage": {
          "$ref": "#/definitions/CoverageFull"
        },
        "title": {
          "description": "The title of the journal",
          "type": "string"
        },
        "subjects": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "coverage-type": {
          "$ref": "#/definitions/JournalsMessageMessageItemsCoverageType"
        },
        "flags": {
          "$ref": "#/definitions/Flags"
        },
        "ISSN": {
          "description": "The ISSN identifier associated with the journal",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "issn-type": {
          "$ref": "#/definitions/JournalIssnType"
        }
      },
      "additionalProperties": false,
      "required": [
        "last-status-check-time",
        "counts",
        "breakdowns",
        "publisher",
        "coverage",
        "title",
        "subjects",
        "coverage-type",
        "flags",
        "ISSN",
        "issn-type"
      ]
    },
    "JournalIssnType": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "value",
        "type"
      ]
    },
    "JournalMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "journal"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Journal"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "JournalMessageMessageBreakdowns": {
      "type": "object",
      "properties": {
        "dois-by-issued-year": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "dois-by-issued-year"
      ]
    },
    "JournalMessageMessageCoverageType": {
      "type": "object",
      "properties": {
        "all": {
          "$ref": "#/definitions/Coverage"
        },
        "current": {
          "$ref": "#/definitions/Coverage"
        },
        "backfile": {
          "$ref": "#/definitions/Coverage"
        }
      },
      "additionalProperties": false,
      "required": [
        "all",
        "current",
        "backfile"
      ]
    },
    "Journals": {
      "type": "object",
      "properties": {
        "items-per-page": {
          "type": "integer",
          "format": "int64"
        },
        "query": {
          "$ref": "#/definitions/Query"
        },
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Journal"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "items-per-page",
        "query",
        "total-results",
        "items"
      ]
    },
    "JournalsMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "journal-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Journals"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "JournalsMessageMessageItemsBreakdowns": {
      "type": "object",
      "properties": {
        "dois-by-issued-year": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "dois-by-issued-year"
      ]
    },
    "JournalsMessageMessageItemsCoverageType": {
      "type": "object",
      "properties": {
        "all": {
          "$ref": "#/definitions/Coverage"
        },
        "current": {
          "$ref": "#/definitions/Coverage"
        },
        "backfile": {
          "$ref": "#/definitions/Coverage"
        }
      },
      "additionalProperties": false,
      "required": [
        "all",
        "current",
        "backfile"
      ]
    },
    "License": {
      "type": "object",
      "properties": {
        "URL": {
          "type": "string"
        },
        "work-count": {
          "type": "integer",
          "format": "int64"
        }
      },
      "additionalProperties": false,
      "required": [
        "URL",
        "work-count"
      ]
    },
    "Licenses": {
      "type": "object",
      "properties": {
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/License"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "total-results",
        "items"
      ]
    },
    "LicensesMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "license-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Licenses"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Member": {
      "type": "object",
      "properties": {
        "last-status-check-time": {
          "type": "integer",
          "format": "int64"
        },
        "primary-name": {
          "type": "string"
        },
        "counts": {
          "$ref": "#/definitions/DoiCounts"
        },
        "breakdowns": {
          "$ref": "#/definitions/MembersMessageMessageItemsBreakdowns"
        },
        "prefixes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "coverage": {
          "$ref": "#/definitions/CoverageFull"
        },
        "prefix": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MemberPrefix"
          }
        },
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "tokens": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "counts-type": {
          "$ref": "#/definitions/MembersMessageMessageItemsCountsType"
        },
        "coverage-type": {
          "$ref": "#/definitions/MembersMessageMessageItemsCoverageType"
        },
        "flags": {
          "$ref": "#/definitions/Flags"
        },
        "location": {
          "type": "string"
        },
        "names": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "last-status-check-time",
        "primary-name",
        "counts",
        "breakdowns",
        "prefixes",
        "coverage",
        "prefix",
        "id",
        "tokens",
        "counts-type",
        "coverage-type",
        "flags",
        "location",
        "names"
      ]
    },
    "MemberMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "member"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Member"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "MemberMessageMessageBreakdowns": {
      "type": "object",
      "properties": {
        "dois-by-issued-year": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "dois-by-issued-year"
      ]
    },
    "MemberMessageMessageCountsType": {
      "type": "object",
      "properties": {
        "all": {
          "$ref": "#/definitions/MemberMessageMessageCountsTypeAll"
        },
        "current": {
          "$ref": "#/definitions/MemberMessageMessageCountsTypeCurrent"
        },
        "backfile": {
          "$ref": "#/definitions/MemberMessageMessageCountsTypeBackfile"
        }
      },
      "additionalProperties": false,
      "required": [
        "all",
        "current",
        "backfile"
      ]
    },
    "MemberMessageMessageCountsTypeAll": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "MemberMessageMessageCountsTypeBackfile": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "MemberMessageMessageCountsTypeCurrent": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "MemberMessageMessageCoverageType": {
      "type": "object",
      "properties": {
        "all": {
          "$ref": "#/definitions/MemberMessageMessageCoverageTypeAll"
        },
        "current": {
          "$ref": "#/definitions/MemberMessageMessageCoverageTypeCurrent"
        },
        "backfile": {
          "$ref": "#/definitions/MemberMessageMessageCoverageTypeBackfile"
        }
      },
      "additionalProperties": false,
      "required": [
        "all",
        "current",
        "backfile"
      ]
    },
    "MemberMessageMessageCoverageTypeAll": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Coverage"
      }
    },
    "MemberMessageMessageCoverageTypeBackfile": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Coverage"
      }
    },
    "MemberMessageMessageCoverageTypeCurrent": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Coverage"
      }
    },
    "MemberPrefix": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "value"
      ]
    },
    "Members": {
      "type": "object",
      "properties": {
        "items-per-page": {
          "type": "integer",
          "format": "int64"
        },
        "query": {
          "$ref": "#/definitions/Query"
        },
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Member"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "items-per-page",
        "query",
        "total-results",
        "items"
      ]
    },
    "MembersMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "member-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Members"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "MembersMessageMessageItemsBreakdowns": {
      "type": "object",
      "properties": {
        "dois-by-issued-year": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "dois-by-issued-year"
      ]
    },
    "MembersMessageMessageItemsCountsType": {
      "type": "object",
      "properties": {
        "all": {
          "$ref": "#/definitions/MembersMessageMessageItemsCountsTypeAll"
        },
        "current": {
          "$ref": "#/definitions/MembersMessageMessageItemsCountsTypeCurrent"
        },
        "backfile": {
          "$ref": "#/definitions/MembersMessageMessageItemsCountsTypeBackfile"
        }
      },
      "additionalProperties": false,
      "required": [
        "all",
        "current",
        "backfile"
      ]
    },
    "MembersMessageMessageItemsCountsTypeAll": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "MembersMessageMessageItemsCountsTypeBackfile": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "MembersMessageMessageItemsCountsTypeCurrent": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "MembersMessageMessageItemsCoverageType": {
      "type": "object",
      "properties": {
        "all": {
          "$ref": "#/definitions/MembersMessageMessageItemsCoverageTypeAll"
        },
        "current": {
          "$ref": "#/definitions/MembersMessageMessageItemsCoverageTypeCurrent"
        },
        "backfile": {
          "$ref": "#/definitions/MembersMessageMessageItemsCoverageTypeBackfile"
        }
      },
      "additionalProperties": false,
      "required": [
        "all",
        "current",
        "backfile"
      ]
    },
    "MembersMessageMessageItemsCoverageTypeAll": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Coverage"
      }
    },
    "MembersMessageMessageItemsCoverageTypeBackfile": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Coverage"
      }
    },
    "MembersMessageMessageItemsCoverageTypeCurrent": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Coverage"
      }
    },
    "Prefix": {
      "type": "object",
      "properties": {
        "member": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "member",
        "name",
        "prefix"
      ]
    },
    "PrefixMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "prefix"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Prefix"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Query": {
      "type": "object",
      "properties": {
        "start-index": {
          "type": "integer",
          "format": "int64"
        },
        "search-terms": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "start-index",
        "search-terms"
      ]
    },
    "Reference": {
      "type": "object",
      "properties": {
        "issn": {
          "type": "string"
        },
        "standards-body": {
          "type": "string"
        },
        "issue": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "series-title": {
          "type": "string"
        },
        "isbn-type": {
          "type": "string"
        },
        "doi-asserted-by": {
          "type": "string"
        },
        "first-page": {
          "type": "string"
        },
        "isbn": {
          "type": "string"
        },
        "doi": {
          "type": "string"
        },
        "component": {
          "type": "string"
        },
        "article-title": {
          "type": "string"
        },
        "volume-title": {
          "type": "string"
        },
        "volume": {
          "type": "string"
        },
        "author": {
          "type": "string"
        },
        "standard-designator": {
          "type": "string"
        },
        "year": {
          "type": "string"
        },
        "unstructured": {
          "type": "string"
        },
        "edition": {
          "type": "string"
        },
        "journal-title": {
          "type": "string"
        },
        "issn-type": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "key"
      ]
    },
    "Type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "label": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id",
        "label"
      ]
    },
    "TypeMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "type"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Type"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Types": {
      "type": "object",
      "properties": {
        "items-per-page": {
          "type": "integer",
          "format": "int64"
        },
        "query": {
          "$ref": "#/definitions/Query"
        },
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Type"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "items-per-page",
        "query",
        "total-results",
        "items"
      ]
    },
    "TypesMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "type-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Types"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "Work": {
      "type": "object",
      "properties": {
        "institution": {
          "$ref": "#/definitions/WorkInstitution"
        },
        "indexed": {
          "$ref": "#/definitions/Date"
        },
        "posted": {
          "$ref": "#/definitions/DateParts"
        },
        "publisher-location": {
          "type": "string"
        },
        "update-to": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkUpdate"
          }
        },
        "standards-body": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkStandardsBody"
          }
        },
        "edition-number": {
          "type": "string"
        },
        "group-title": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "reference-count": {
          "type": "integer",
          "format": "int64"
        },
        "publisher": {
          "type": "string"
        },
        "issue": {
          "type": "string"
        },
        "isbn-type": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkISSNType"
          }
        },
        "license": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkLicense"
          }
        },
        "funder": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkFunder"
          }
        },
        "content-domain": {
          "$ref": "#/definitions/WorkDomain"
        },
        "chair": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Author"
          }
        },
        "short-container-title": {
          "type": "string"
        },
        "accepted": {
          "$ref": "#/definitions/DateParts"
        },
        "content-updated": {
          "$ref": "#/definitions/DateParts"
        },
        "published-print": {
          "$ref": "#/definitions/DateParts"
        },
        "abstract": {
          "type": "string"
        },
        "DOI": {
          "description": "The DOI identifier associated with the work",
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "created": {
          "$ref": "#/definitions/Date"
        },
        "approved": {
          "$ref": "#/definitions/DateParts"
        },
        "page": {
          "type": "string"
        },
        "update-policy": {
          "type": "string"
        },
        "source": {
          "type": "string"
        },
        "is-referenced-by-count": {
          "type": "integer",
          "format": "int64"
        },
        "title": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "prefix": {
          "type": "string"
        },
        "volume": {
          "type": "string"
        },
        "clinical-trial-number": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkClinicalTrial"
          }
        },
        "author": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Author"
          }
        },
        "member": {
          "type": "string"
        },
        "content-created": {
          "$ref": "#/definitions/DateParts"
        },
        "published-online": {
          "$ref": "#/definitions/DateParts"
        },
        "reference": {
          "$ref": "#/definitions/Reference"
        },
        "container-title": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "review": {
          "$ref": "#/definitions/WorkReview"
        },
        "original-title": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "language": {
          "type": "string"
        },
        "link": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkLink"
          }
        },
        "deposited": {
          "$ref": "#/definitions/Date"
        },
        "score": {
          "type": "integer",
          "format": "int64"
        },
        "degree": {
          "type": "string"
        },
        "subtitle": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "translator": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Author"
          }
        },
        "free-to-read": {
          "$ref": "#/definitions/WorkFreeToRead"
        },
        "editor": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Author"
          }
        },
        "component-number": {
          "type": "string"
        },
        "short-title": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "issued": {
          "$ref": "#/definitions/DateParts"
        },
        "ISBN": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "references-count": {
          "type": "integer",
          "format": "int64"
        },
        "part-number": {
          "type": "string"
        },
        "journal-issue": {
          "$ref": "#/definitions/WorkJournalIssue"
        },
        "alternative-id": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "URL": {
          "type": "string"
        },
        "archive": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "relation": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/definitions/WorkRelation"
          }
        },
        "ISSN": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "issn-type": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkISSNType"
          }
        },
        "subject": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "published-other": {
          "$ref": "#/definitions/DateParts"
        },
        "published": {
          "$ref": "#/definitions/DateParts"
        },
        "assertion": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/WorkAssertion"
          }
        },
        "subtype": {
          "type": "string"
        },
        "article-number": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "indexed",
        "reference-count",
        "publisher",
        "content-domain",
        "DOI",
        "type",
        "created",
        "source",
        "is-referenced-by-count",
        "title",
        "prefix",
        "author",
        "member",
        "deposited",
        "score",
        "issued",
        "references-count",
        "URL"
      ]
    },
    "WorkAssertion": {
      "type": "object",
      "properties": {
        "group": {
          "$ref": "#/definitions/WorksMessageMessageItemsAssertionGroup"
        },
        "explanation": {
          "$ref": "#/definitions/WorksMessageMessageItemsAssertionExplanation"
        },
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        },
        "URL": {
          "type": "string"
        },
        "order": {
          "type": "integer",
          "format": "int64"
        }
      },
      "additionalProperties": false,
      "required": [
        "group",
        "explanation",
        "name",
        "value",
        "URL",
        "order"
      ]
    },
    "WorkClinicalTrial": {
      "type": "object",
      "properties": {
        "clinical-trial-number": {
          "type": "string"
        },
        "registry": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "clinical-trial-number",
        "registry",
        "type"
      ]
    },
    "WorkDomain": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "crossmark-restriction": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "required": [
        "domain",
        "crossmark-restriction"
      ]
    },
    "WorkFreeToRead": {
      "type": "object",
      "properties": {
        "start-date": {
          "$ref": "#/definitions/DateParts"
        },
        "end-date": {
          "$ref": "#/definitions/DateParts"
        }
      },
      "additionalProperties": false
    },
    "WorkFunder": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "DOI": {
          "type": "string"
        },
        "doi-asserted-by": {
          "type": "string"
        },
        "award": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "award"
      ]
    },
    "WorkISSNType": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "value": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "type",
        "value"
      ]
    },
    "WorkInstitution": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "place": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "department": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "acronym": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "place",
        "department",
        "acronym"
      ]
    },
    "WorkJournalIssue": {
      "type": "object",
      "properties": {
        "issue": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "issue"
      ]
    },
    "WorkLicense": {
      "type": "object",
      "properties": {
        "URL": {
          "type": "string"
        },
        "start": {
          "$ref": "#/definitions/Date"
        },
        "delay-in-days": {
          "type": "integer",
          "format": "int64"
        },
        "content-version": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "URL",
        "start",
        "delay-in-days",
        "content-version"
      ]
    },
    "WorkLink": {
      "type": "object",
      "properties": {
        "URL": {
          "type": "string"
        },
        "content-type": {
          "type": "string"
        },
        "content-version": {
          "type": "string"
        },
        "intended-application": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "URL",
        "content-type",
        "content-version",
        "intended-application"
      ]
    },
    "WorkMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "work"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Work"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "WorkMessageMessageAssertionExplanation": {
      "type": "object",
      "properties": {
        "URL": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "URL"
      ]
    },
    "WorkMessageMessageAssertionGroup": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "label": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "label"
      ]
    },
    "WorkMessageMessageRelationJava.lang.string39107": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    },
    "WorkRelation": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/WorkRelationEntry"
      }
    },
    "WorkReview": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "running-number": {
          "type": "string"
        },
        "revision-round": {
          "type": "string"
        },
        "stage": {
          "type": "string"
        },
        "competing-interest-statement": {
          "type": "string"
        },
        "recommendation": {
          "type": "string"
        },
        "language": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "type",
        "running-number",
        "revision-round",
        "stage",
        "competing-interest-statement",
        "recommendation",
        "language"
      ]
    },
    "WorkStandardsBody": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "acronym": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "acronym"
      ]
    },
    "WorkUpdate": {
      "type": "object",
      "properties": {
        "label": {
          "type": "string"
        },
        "DOI": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "updated": {
          "$ref": "#/definitions/Date"
        }
      },
      "additionalProperties": false,
      "required": [
        "label",
        "DOI",
        "type",
        "updated"
      ]
    },
    "Works": {
      "type": "object",
      "properties": {
        "items-per-page": {
          "type": "integer",
          "format": "int64"
        },
        "query": {
          "$ref": "#/definitions/Query"
        },
        "total-results": {
          "type": "integer",
          "format": "int64"
        },
        "next-cursor": {
          "description": "Used to navigate to the next page of results when using cursor deep paging",
          "type": "string"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Work"
          }
        }
      },
      "additionalProperties": false,
      "required": [
        "items-per-page",
        "query",
        "total-results",
        "items"
      ]
    },
    "WorksMessage": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "message-type": {
          "type": "string",
          "pattern": "work-list"
        },
        "message-version": {
          "type": "string"
        },
        "message": {
          "$ref": "#/definitions/Works"
        }
      },
      "additionalProperties": false,
      "required": [
        "status",
        "message-type",
        "message-version",
        "message"
      ]
    },
    "WorksMessageMessageItemsAssertionExplanation": {
      "type": "object",
      "properties": {
        "URL": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "URL"
      ]
    },
    "WorksMessageMessageItemsAssertionGroup": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "label": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "label"
      ]
    },
    "WorkRelationEntry": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    },
    "WorksMessageMessageItemsRelationJava.lang.string39102": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    },
    "WorksMessageMessageItemsRelationJava.lang.string39103": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    },
    "WorksMessageMessageItemsRelationJava.lang.string39104": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    },
    "WorksMessageMessageItemsRelationJava.lang.string39108": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    },
    "WorksMessageMessageItemsRelationJava.lang.string39109": {
      "type": "object",
      "properties": {
        "id-type": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "asserted-by": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "id-type",
        "id",
        "asserted-by"
      ]
    }
  }
}