GET api/v1/patiented/medcounselor/{gpcId}?lang={lang}

Returns a med counselor sheet in the specified language.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
gpcId

The gpcId of the med counselor sheet

integer

Required

lang

The id of the language

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

PatientEdMedCounselorSheet
NameDescriptionTypeAdditional information
languages

Collection of Language

None.

sheetName

string

None.

foreignSheetName

string

None.

gpcId

integer

None.

cpnum

integer

None.

sheetId

integer

None.

languageId

integer

None.

language

string

None.

locale

string

None.

rtl

boolean

None.

hasREMS

boolean

None.

hasMedguides

boolean

None.

tradenamesContent

TradeNamesContent

None.

boxedWarnings

Collection of BoxedWarning

None.

description

MedCounselorContent

None.

contraindications

MedCounselorContent

None.

administration

MedCounselorContent

None.

missed

MedCounselorContent

None.

interactions

MedCounselorContent

None.

monitor

MedCounselorContent

None.

side

MedCounselorContent

None.

storage

MedCounselorContent

None.

lastUpdated

date

None.

_links

Collection of Link

None.

_languages

Collection of LanguagesLink

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:
{
  "languages": [
    {
      "id": 1,
      "name": "sample string 2",
      "locale": "sample string 3",
      "rtl": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "locale": "sample string 3",
      "rtl": true
    }
  ],
  "sheetName": "sample string 1",
  "foreignSheetName": "sample string 2",
  "gpcId": 3,
  "cpnum": 4,
  "sheetId": 5,
  "languageId": 6,
  "language": "sample string 7",
  "locale": "sample string 8",
  "rtl": true,
  "hasREMS": true,
  "hasMedguides": true,
  "tradenamesContent": {
    "header": "sample string 1",
    "tradeNames": [
      "sample string 1",
      "sample string 2"
    ],
    "footer": "sample string 2"
  },
  "boxedWarnings": [
    {
      "header": "sample string 1",
      "footer": "sample string 2",
      "riskFactors": [
        "sample string 1",
        "sample string 2"
      ],
      "sideEffects": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "header": "sample string 1",
      "footer": "sample string 2",
      "riskFactors": [
        "sample string 1",
        "sample string 2"
      ],
      "sideEffects": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "description": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "contraindications": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "administration": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "missed": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "interactions": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "monitor": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "side": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "storage": {
    "header": "sample string 1",
    "text": "sample string 2",
    "footer": "sample string 3"
  },
  "lastUpdated": "2023-02-07T03:50:04.8292767-05: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:
<medCounselorSheet 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>
  <administration>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </administration>
  <boxedWarnings>
    <boxedWarnings>
      <footer>sample string 2</footer>
      <header>sample string 1</header>
      <riskFactors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </riskFactors>
      <sideEffects xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </sideEffects>
    </boxedWarnings>
    <boxedWarnings>
      <footer>sample string 2</footer>
      <header>sample string 1</header>
      <riskFactors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </riskFactors>
      <sideEffects xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </sideEffects>
    </boxedWarnings>
  </boxedWarnings>
  <contraindications>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </contraindications>
  <cpnum>4</cpnum>
  <description>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </description>
  <foreignSheetName>sample string 2</foreignSheetName>
  <gpcId>3</gpcId>
  <hasMedguides>true</hasMedguides>
  <hasREMS>true</hasREMS>
  <interactions>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </interactions>
  <language>sample string 7</language>
  <languageId>6</languageId>
  <languages>
    <language>
      <id>1</id>
      <locale>sample string 3</locale>
      <name>sample string 2</name>
      <rtl>true</rtl>
    </language>
    <language>
      <id>1</id>
      <locale>sample string 3</locale>
      <name>sample string 2</name>
      <rtl>true</rtl>
    </language>
  </languages>
  <lastUpdated>2023-02-07T03:50:04.8292767-05:00</lastUpdated>
  <locale>sample string 8</locale>
  <missed>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </missed>
  <monitor>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </monitor>
  <rtl>true</rtl>
  <sheetId>5</sheetId>
  <sheetName>sample string 1</sheetName>
  <side>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </side>
  <storage>
    <footer>sample string 3</footer>
    <header>sample string 1</header>
    <text>sample string 2</text>
  </storage>
  <tradenamesContent>
    <footer>sample string 2</footer>
    <header>sample string 1</header>
    <tradeNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </tradeNames>
  </tradenamesContent>
</medCounselorSheet>