GET api/v1/monographs/{cpnum}/monitoringparameters?type={type}
Retrieves information om monograph Monitoring Parameters
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
Content regarding the Monitoring Parameters
MonitoringParametersMonographResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| terms | Collection of MonitoringParameterTerm |
None. |
|
| labPanels | Collection of LabPanelTest |
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:
{
"terms": [
{
"id": 1,
"name": "sample string 2"
},
{
"id": 1,
"name": "sample string 2"
}
],
"labPanels": [
{
"testId": 1,
"testName": "sample string 2",
"items": [
{
"section": "sample string 1",
"traditionalUnits": "sample string 2",
"scientificUnits": "sample string 3",
"comments": "sample string 4"
},
{
"section": "sample string 1",
"traditionalUnits": "sample string 2",
"scientificUnits": "sample string 3",
"comments": "sample string 4"
}
],
"_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"
}
]
},
{
"testId": 1,
"testName": "sample string 2",
"items": [
{
"section": "sample string 1",
"traditionalUnits": "sample string 2",
"scientificUnits": "sample string 3",
"comments": "sample string 4"
},
{
"section": "sample string 1",
"traditionalUnits": "sample string 2",
"scientificUnits": "sample string 3",
"comments": "sample string 4"
}
],
"_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,
"_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 3",
"lastUpdate": "2024-12-28T01:53:37.7854312-05:00"
}
application/xml, text/xml
Sample:
<monitoringParameterMonographResponse 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>1</cpnum>
<type>General</type>
<mini>true</mini>
<name>sample string 3</name>
<lastUpdate>2024-12-28T01:53:37.7854312-05:00</lastUpdate>
<labPanels>
<labPanelTest>
<_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>
<items>
<labPanelItem>
<comments>sample string 4</comments>
<scientificUnits>sample string 3</scientificUnits>
<section>sample string 1</section>
<traditionalUnits>sample string 2</traditionalUnits>
</labPanelItem>
<labPanelItem>
<comments>sample string 4</comments>
<scientificUnits>sample string 3</scientificUnits>
<section>sample string 1</section>
<traditionalUnits>sample string 2</traditionalUnits>
</labPanelItem>
</items>
<testId>1</testId>
<testName>sample string 2</testName>
</labPanelTest>
<labPanelTest>
<_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>
<items>
<labPanelItem>
<comments>sample string 4</comments>
<scientificUnits>sample string 3</scientificUnits>
<section>sample string 1</section>
<traditionalUnits>sample string 2</traditionalUnits>
</labPanelItem>
<labPanelItem>
<comments>sample string 4</comments>
<scientificUnits>sample string 3</scientificUnits>
<section>sample string 1</section>
<traditionalUnits>sample string 2</traditionalUnits>
</labPanelItem>
</items>
<testId>1</testId>
<testName>sample string 2</testName>
</labPanelTest>
</labPanels>
<terms>
<term>
<id>1</id>
<name>sample string 2</name>
</term>
<term>
<id>1</id>
<name>sample string 2</name>
</term>
</terms>
</monitoringParameterMonographResponse>