GET api/v1/monographs/{cpnum}/pharmacokinetics?type={type}
Retrieves Pharmacokinetic content for the monograph
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
cpnum |
The CpNum of the monograph |
integer |
Required |
type |
The type of monograph (General or Pediatric). |
MonographType |
Default value is General |
Body Parameters
None.
Response Information
Resource Description
A list of Pharmacokinetic content
PharmacokineticsResponseName | Description | Type | Additional information |
---|---|---|---|
note | string |
None. |
|
categories | Collection of PharmacokineticCategory |
None. |
|
terms | Collection of GsTerm |
None. |
|
references | Collection of Reference |
None. |
|
cpnum | integer |
None. |
|
type | MonographType |
None. |
|
mini | boolean |
None. |
|
name | string |
None. |
|
lastUpdate | date |
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:
{ "note": "sample string 1", "categories": [ { "name": "sample string 1", "sections": [ { "heading": "sample string 1", "description": "sample string 2" }, { "heading": "sample string 1", "description": "sample string 2" } ] }, { "name": "sample string 1", "sections": [ { "heading": "sample string 1", "description": "sample string 2" }, { "heading": "sample string 1", "description": "sample string 2" } ] } ], "terms": [ { "name": "sample string 1", "termId": 2 }, { "name": "sample string 1", "termId": 2 } ], "cpnum": 2, "_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" } ], "type": 0, "mini": true, "name": "sample string 4", "lastUpdate": "2024-12-28T02:04:47.3365893-05:00", "references": [ { "id": 1, "title": "sample string 2", "pubMedId": 3 }, { "id": 1, "title": "sample string 2", "pubMedId": 3 } ] }
application/xml, text/xml
Sample:
<pharmacokineticsResponse 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> <cpnum>2</cpnum> <type>General</type> <mini>true</mini> <name>sample string 4</name> <lastUpdate>2024-12-28T02:04:47.3365893-05:00</lastUpdate> <references> <reference> <id>1</id> <pubMedId>3</pubMedId> <title>sample string 2</title> </reference> <reference> <id>1</id> <pubMedId>3</pubMedId> <title>sample string 2</title> </reference> </references> <categories> <category> <name>sample string 1</name> <sections> <section> <description xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 2</description> <heading xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 1</heading> </section> <section> <description xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 2</description> <heading xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 1</heading> </section> </sections> </category> <category> <name>sample string 1</name> <sections> <section> <description xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 2</description> <heading xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 1</heading> </section> <section> <description xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 2</description> <heading xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">sample string 1</heading> </section> </sections> </category> </categories> <note>sample string 1</note> <terms> <term> <name>sample string 1</name> <termId>2</termId> </term> <term> <name>sample string 1</name> <termId>2</termId> </term> </terms> </pharmacokineticsResponse>