POST api/ListProductImages
Accepts product identifiers as input and returns package, drug, or non-drug Image Identifier, along with the Image Type.
Includes a ‘MaxResults’ option that allows you to limit the number of results returned.
This data can then be used with the GET Image method request to retrieve the image file.
Request Information
URI Parameters
None.
Body Parameters
ListProductImagesRequestName | Description | Type | Additional information |
---|---|---|---|
ProductId | Input parameters for any product identifiers passed into the request. | ProductIdentifier |
Required |
MaxResults | Limits the number of results returned. A null value means no limit, and everthing will be returned. | integer |
None. |
AccessToken |
Temporary access token from the GSDD Auth API.
Used to validate your license.
Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "ProductId": { "IdType": "NDC9", "Id": "12345-0001" }, "MaxResults": 10, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ListProductImagesResponseName | Description | Type | Additional information |
---|---|---|---|
ImageIds | A collection of image identifiers associated with the product. | Collection of ImageIdentifier |
None. |
Response Formats
application/json, text/json
Sample:
{ "ImageIds": [ { "Id": 1, "IdType": "DrugItem" }, { "Id": 2, "IdType": "DrugItem" } ] }