Get part media for a part id
Endpoint:
GET v1/Media/{id}?showImages={showImages}&format={format}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Part Id |
string |
Required |
showImages |
True if images should be included, otherwise false |
boolean |
Default value is False |
format |
Format type for the response. Value passed in the query string. Options: json, xml, csv |
string |
Default value is json |
Body Parameters
None.
Response Information
Collection of PartMediaName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
PartId | string |
None. |
|
Name | string |
None. |
|
MediaType | MediaType |
None. |
|
MediaTypeId | string |
None. |
|
MediaTypeName | string |
None. |
|
FileName | string |
None. |
|
FileExtension | string |
None. |
|
BrandId | string |
None. |
|
BrandWebId | string |
None. |
|
BrandName | string |
None. |
|
WebUrl | string |
None. |
Response Examples
application/json, text/json :
[ { "Id": 1, "PartId": "sample string 2", "Name": "sample string 3", "MediaType": 0, "MediaTypeId": "sample string 4", "MediaTypeName": "sample string 5", "FileName": "sample string 6", "FileExtension": "sample string 7", "BrandId": "sample string 8", "BrandWebId": "sample string 9", "BrandName": "sample string 10", "WebUrl": "https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11" }, { "Id": 1, "PartId": "sample string 2", "Name": "sample string 3", "MediaType": 0, "MediaTypeId": "sample string 4", "MediaTypeName": "sample string 5", "FileName": "sample string 6", "FileExtension": "sample string 7", "BrandId": "sample string 8", "BrandWebId": "sample string 9", "BrandName": "sample string 10", "WebUrl": "https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11" } ]
text/javascript :
[{"Id":1,"PartId":"sample string 2","Name":"sample string 3","MediaType":0,"MediaTypeId":"sample string 4","MediaTypeName":"sample string 5","FileName":"sample string 6","FileExtension":"sample string 7","BrandId":"sample string 8","BrandWebId":"sample string 9","BrandName":"sample string 10","WebUrl":"https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11"},{"Id":1,"PartId":"sample string 2","Name":"sample string 3","MediaType":0,"MediaTypeId":"sample string 4","MediaTypeName":"sample string 5","FileName":"sample string 6","FileExtension":"sample string 7","BrandId":"sample string 8","BrandWebId":"sample string 9","BrandName":"sample string 10","WebUrl":"https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11"}]
application/xml, text/xml :
<ArrayOfPartMedia xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models"> <PartMedia> <BrandId>sample string 8</BrandId> <BrandName>sample string 10</BrandName> <BrandWebId>sample string 9</BrandWebId> <FileExtension>sample string 7</FileExtension> <FileName>sample string 6</FileName> <Id>1</Id> <MediaType>Document</MediaType> <MediaTypeId>sample string 4</MediaTypeId> <MediaTypeName>sample string 5</MediaTypeName> <Name>sample string 3</Name> <PartId>sample string 2</PartId> <WebUrl>https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11</WebUrl> </PartMedia> <PartMedia> <BrandId>sample string 8</BrandId> <BrandName>sample string 10</BrandName> <BrandWebId>sample string 9</BrandWebId> <FileExtension>sample string 7</FileExtension> <FileName>sample string 6</FileName> <Id>1</Id> <MediaType>Document</MediaType> <MediaTypeId>sample string 4</MediaTypeId> <MediaTypeName>sample string 5</MediaTypeName> <Name>sample string 3</Name> <PartId>sample string 2</PartId> <WebUrl>https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11</WebUrl> </PartMedia> </ArrayOfPartMedia>
text/csv :
Id,PartId,Name,MediaType,MediaTypeId,MediaTypeName,FileName,FileExtension,BrandId,BrandWebId,BrandName,WebUrl 1,sample string 2,sample string 3,Document,sample string 4,sample string 5,sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11 1,sample string 2,sample string 3,Document,sample string 4,sample string 5,sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11
text/tsv :
Id PartId Name MediaType MediaTypeId MediaTypeName FileName FileExtension BrandId BrandWebId BrandName WebUrl 1 sample string 2 sample string 3 Document sample string 4 sample string 5 sample string 6 sample string 7 sample string 8 sample string 9 sample string 10 https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11 1 sample string 2 sample string 3 Document sample string 4 sample string 5 sample string 6 sample string 7 sample string 8 sample string 9 sample string 10 https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 11