GET api/v1/monographs/retired?startDate={startDate}&endDate={endDate}

Retrieves a list of monographs that have been retired within a date range.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

The starting date from which to look for retired monographs. Defaults to 45 days past.

date

None.

endDate

The ending date from which to look for retired monographs. Defaults to current date.

date

None.

Body Parameters

None.

Response Information

Resource Description

A collection of retired monographs matching the input date range.

MonographRetiredResponse
NameDescriptionTypeAdditional information
Monographs

Collection of MonographRetired

None.

Response Codes

CodeDescriptionAdditional information
200OKThe request returned without error
204No ContentThe request was successful but no results were returned
400Bad RequestA parameter was missing or invalid
404Not FoundThe requested resource was not found

Response Formats

application/json, text/json

Sample:
{
  "Monographs": [
    {
      "cpnum": 1,
      "type": 0,
      "retiredDate": "2024-09-19T04:02:04.9487092-04:00",
      "_links": [
        {
          "rel": "sample string 1",
          "locale": "sample string 4",
          "href": "sample string 2",
          "templated": true
        },
        {
          "rel": "sample string 1",
          "locale": "sample string 4",
          "href": "sample string 2",
          "templated": true
        }
      ],
      "_languages": [
        {
          "rel": "sample string 1",
          "locale": "sample string 3",
          "name": "sample string 4",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "locale": "sample string 3",
          "name": "sample string 4",
          "href": "sample string 2"
        }
      ]
    },
    {
      "cpnum": 1,
      "type": 0,
      "retiredDate": "2024-09-19T04:02:04.9487092-04:00",
      "_links": [
        {
          "rel": "sample string 1",
          "locale": "sample string 4",
          "href": "sample string 2",
          "templated": true
        },
        {
          "rel": "sample string 1",
          "locale": "sample string 4",
          "href": "sample string 2",
          "templated": true
        }
      ],
      "_languages": [
        {
          "rel": "sample string 1",
          "locale": "sample string 3",
          "name": "sample string 4",
          "href": "sample string 2"
        },
        {
          "rel": "sample string 1",
          "locale": "sample string 3",
          "name": "sample string 4",
          "href": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<MonographRetiredResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">
  <Monographs>
    <monographRetired xmlns="">
      <_languages>
        <languageslink>
          <rel>sample string 1</rel>
          <locale>sample string 3</locale>
          <name>sample string 4</name>
          <href>sample string 2</href>
        </languageslink>
        <languageslink>
          <rel>sample string 1</rel>
          <locale>sample string 3</locale>
          <name>sample string 4</name>
          <href>sample string 2</href>
        </languageslink>
      </_languages>
      <_links>
        <link>
          <rel>sample string 1</rel>
          <locale>sample string 4</locale>
          <href>sample string 2</href>
          <templated>true</templated>
        </link>
        <link>
          <rel>sample string 1</rel>
          <locale>sample string 4</locale>
          <href>sample string 2</href>
          <templated>true</templated>
        </link>
      </_links>
      <cpnum>1</cpnum>
      <retiredDate>2024-09-19T04:02:04.9487092-04:00</retiredDate>
      <type>General</type>
    </monographRetired>
    <monographRetired xmlns="">
      <_languages>
        <languageslink>
          <rel>sample string 1</rel>
          <locale>sample string 3</locale>
          <name>sample string 4</name>
          <href>sample string 2</href>
        </languageslink>
        <languageslink>
          <rel>sample string 1</rel>
          <locale>sample string 3</locale>
          <name>sample string 4</name>
          <href>sample string 2</href>
        </languageslink>
      </_languages>
      <_links>
        <link>
          <rel>sample string 1</rel>
          <locale>sample string 4</locale>
          <href>sample string 2</href>
          <templated>true</templated>
        </link>
        <link>
          <rel>sample string 1</rel>
          <locale>sample string 4</locale>
          <href>sample string 2</href>
          <templated>true</templated>
        </link>
      </_links>
      <cpnum>1</cpnum>
      <retiredDate>2024-09-19T04:02:04.9487092-04:00</retiredDate>
      <type>General</type>
    </monographRetired>
  </Monographs>
</MonographRetiredResponse>