GET api/v1/patiented/medcounselor/productphoto/{gpcId}

Returns a collection of photos for medcounselor app.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
gpcId

The gpcId of the photos to get

integer

Required

Body Parameters

None.

Response Information

Resource Description

ProductPhotoResponse
NameDescriptionTypeAdditional information
count

integer

None.

productPhotos

Collection of ProductPhoto

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:
{
  "_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,
  "productPhotos": [
    {
      "productName": "sample string 1",
      "offMarketDate": "2023-02-07T02:54:30.3044208-05:00",
      "manufacturerName": "sample string 2",
      "activeIngredients": [
        "sample string 1",
        "sample string 2"
      ],
      "drugPhotos": [
        "sample string 1",
        "sample string 2"
      ],
      "packagePhotos": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "productName": "sample string 1",
      "offMarketDate": "2023-02-07T02:54:30.3044208-05:00",
      "manufacturerName": "sample string 2",
      "activeIngredients": [
        "sample string 1",
        "sample string 2"
      ],
      "drugPhotos": [
        "sample string 1",
        "sample string 2"
      ],
      "packagePhotos": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<productPhotoResponse 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>
  <productPhotos>
    <productPhoto>
      <activeIngredients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </activeIngredients>
      <drugPhotos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </drugPhotos>
      <manufacturerName>sample string 2</manufacturerName>
      <offMarketDate>2023-02-07T02:54:30.3044208-05:00</offMarketDate>
      <packagePhotos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </packagePhotos>
      <productName>sample string 1</productName>
    </productPhoto>
    <productPhoto>
      <activeIngredients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </activeIngredients>
      <drugPhotos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </drugPhotos>
      <manufacturerName>sample string 2</manufacturerName>
      <offMarketDate>2023-02-07T02:54:30.3044208-05:00</offMarketDate>
      <packagePhotos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </packagePhotos>
      <productName>sample string 1</productName>
    </productPhoto>
  </productPhotos>
</productPhotoResponse>