GET api/v1/search/monograph-names?q={q}&size={size}&page={page}

Test this API

Returns a list of monograph names in alphabetical order. The default values for size and page are both 0, resulting in the complete list being returned. Should you decide to use the paging feature, pages are 0 indexed.

Request Information

URI Parameters

Name	Description	Type	Additional information
q	Only monograph names matching this filter will be returned. Note: "%" is wildcard, i.e. "a%" will return monograph names that start with "a". "%b" will return monograph names that end with "b". "%c%" will return monograph names that contain "c".	string	Default value is %
size	The page size for the result set.	integer	Default value is 0
page	The page number for the result set.	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

A collection of monograph name information matching input criteria.

MonographNamesSearchResponse

Name	Type	Additional information
count	integer	None.
totalItems	integer	None.
page	integer	None.
pageSize	integer	None.
items	Collection of MonographNameItem	None.
_links	Collection of Link	None.
_languages	Collection of LanguagesLink	None.

Response Codes

Code	Description	Additional information
200	OK	The request returned without error
204	No Content	The request was successful but no results were returned
400	Bad Request	A parameter was missing or invalid
404	Not Found	The requested resource was not found

Response Formats

application/json, text/json

Sample:

{
  "_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"
    }
  ],
  "count": 1,
  "totalItems": 2,
  "page": 3,
  "pageSize": 4,
  "items": [
    {
      "cpNum": 1,
      "monographName": "sample string 2",
      "brandGenericStatus": 1,
      "adult": true,
      "pediatric": true
    },
    {
      "cpNum": 1,
      "monographName": "sample string 2",
      "brandGenericStatus": 1,
      "adult": true,
      "pediatric": true
    }
  ]
}

application/xml, text/xml

Sample:

<monographNames xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <_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>
  <count>1</count>
  <totalItems>2</totalItems>
  <page>3</page>
  <pageSize>4</pageSize>
  <items>
    <monographName>
      <adult>true</adult>
      <brandGenericStatus>Brand</brandGenericStatus>
      <cpNum>1</cpNum>
      <monographName>sample string 2</monographName>
      <pediatric>true</pediatric>
    </monographName>
    <monographName>
      <adult>true</adult>
      <brandGenericStatus>Brand</brandGenericStatus>
      <cpNum>1</cpNum>
      <monographName>sample string 2</monographName>
      <pediatric>true</pediatric>
    </monographName>
  </items>
</monographNames>