GET api/v1/drugidentification/attributes

Returns the full collection of all drug attributes

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Response containing all attributes

AttributesResponse
NameDescriptionTypeAdditional information
colors

Collection of ColorModel

None.

dosages

Collection of DosageModel

None.

scorings

Collection of ScoringModel

None.

shapes

Collection of ShapeModel

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:
{
  "colors": [
    {
      "id": 1,
      "code": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "code": "sample string 2",
      "name": "sample string 3"
    }
  ],
  "dosages": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "scorings": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "shapes": [
    {
      "id": 1,
      "code": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "code": "sample string 2",
      "name": "sample string 3"
    }
  ],
  "_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:
<attributesResponse 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>
  <colors>
    <color>
      <code>sample string 2</code>
      <id>1</id>
      <name>sample string 3</name>
    </color>
    <color>
      <code>sample string 2</code>
      <id>1</id>
      <name>sample string 3</name>
    </color>
  </colors>
  <dosages>
    <dosage>
      <id>1</id>
      <name>sample string 2</name>
    </dosage>
    <dosage>
      <id>1</id>
      <name>sample string 2</name>
    </dosage>
  </dosages>
  <scorings>
    <scoring>
      <id>1</id>
      <name>sample string 2</name>
    </scoring>
    <scoring>
      <id>1</id>
      <name>sample string 2</name>
    </scoring>
  </scorings>
  <shapes>
    <shape>
      <code>sample string 2</code>
      <id>1</id>
      <name>sample string 3</name>
    </shape>
    <shape>
      <code>sample string 2</code>
      <id>1</id>
      <name>sample string 3</name>
    </shape>
  </shapes>
</attributesResponse>