Media
Endpoint:
GET v2/Part/Media?PartId={PartId}&ShowImages={ShowImages}&ReferenceId={ReferenceId}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PartId | string |
None. |
|
ShowImages | boolean |
None. |
|
ReferenceId | globally unique identifier |
None. |
Body Parameters
None.
Response Information
ResponseDataOfListOfPartMediaName | Description | Type | Additional information |
---|---|---|---|
Success | boolean |
None. |
|
ResponseId | globally unique identifier |
None. |
|
ReferenceId | globally unique identifier |
None. |
|
SuccessCount | integer |
None. |
|
Message | string |
None. |
|
ValidationResults | Validation |
None. |
|
QueryTime | string |
None. |
|
Data | Collection of PartMedia |
None. |
Response Examples
application/json, text/json :
{ "Success": true, "ResponseId": "9434583f-7fa2-4efe-853a-f7e662f9cbe4", "ReferenceId": "a1d6f6f7-762e-4ee0-8ce5-e999194bdddb", "SuccessCount": 3, "Message": "sample string 4", "ValidationResults": { "IsValid": false, "Errors": [], "Warnings": [], "Info": [ { "FieldName": "sample string 1", "FieldValue": "sample string 2", "Allow": true, "Message": "sample string 5", "Severity": 0, "Category": 0 }, { "FieldName": "sample string 1", "FieldValue": "sample string 2", "Allow": true, "Message": "sample string 5", "Severity": 0, "Category": 0 } ] }, "QueryTime": "sample string 5", "Data": [ { "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": "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": "sample string 11" } ] }
text/javascript :
{"Success":true,"ResponseId":"9434583f-7fa2-4efe-853a-f7e662f9cbe4","ReferenceId":"a1d6f6f7-762e-4ee0-8ce5-e999194bdddb","SuccessCount":3,"Message":"sample string 4","ValidationResults":{"IsValid":false,"Errors":[],"Warnings":[],"Info":[{"FieldName":"sample string 1","FieldValue":"sample string 2","Allow":true,"Message":"sample string 5","Severity":0,"Category":0},{"FieldName":"sample string 1","FieldValue":"sample string 2","Allow":true,"Message":"sample string 5","Severity":0,"Category":0}]},"QueryTime":"sample string 5","Data":[{"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":"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":"sample string 11"}]}
application/xml, text/xml :
<ResponseDataOfArrayOfPartMediauwLiWYs0 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models.Api.V2.Responses"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models"> <d2p1:PartMedia> <d2p1:BrandId>sample string 8</d2p1:BrandId> <d2p1:BrandName>sample string 10</d2p1:BrandName> <d2p1:BrandWebId>sample string 9</d2p1:BrandWebId> <d2p1:FileExtension>sample string 7</d2p1:FileExtension> <d2p1:FileName>sample string 6</d2p1:FileName> <d2p1:Id>1</d2p1:Id> <d2p1:MediaType>Document</d2p1:MediaType> <d2p1:MediaTypeId>sample string 4</d2p1:MediaTypeId> <d2p1:MediaTypeName>sample string 5</d2p1:MediaTypeName> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:PartId>sample string 2</d2p1:PartId> <d2p1:WebUrl>sample string 11</d2p1:WebUrl> </d2p1:PartMedia> <d2p1:PartMedia> <d2p1:BrandId>sample string 8</d2p1:BrandId> <d2p1:BrandName>sample string 10</d2p1:BrandName> <d2p1:BrandWebId>sample string 9</d2p1:BrandWebId> <d2p1:FileExtension>sample string 7</d2p1:FileExtension> <d2p1:FileName>sample string 6</d2p1:FileName> <d2p1:Id>1</d2p1:Id> <d2p1:MediaType>Document</d2p1:MediaType> <d2p1:MediaTypeId>sample string 4</d2p1:MediaTypeId> <d2p1:MediaTypeName>sample string 5</d2p1:MediaTypeName> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:PartId>sample string 2</d2p1:PartId> <d2p1:WebUrl>sample string 11</d2p1:WebUrl> </d2p1:PartMedia> </Data> <Message>sample string 4</Message> <QueryTime>sample string 5</QueryTime> <ReferenceId>a1d6f6f7-762e-4ee0-8ce5-e999194bdddb</ReferenceId> <ResponseId>9434583f-7fa2-4efe-853a-f7e662f9cbe4</ResponseId> <Success>true</Success> <SuccessCount>3</SuccessCount> <ValidationResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models"> <d2p1:Errors /> <d2p1:Info> <d2p1:ValidationSummary> <d2p1:Allow>true</d2p1:Allow> <d2p1:Category>Missing</d2p1:Category> <d2p1:FieldName>sample string 1</d2p1:FieldName> <d2p1:FieldValue>sample string 2</d2p1:FieldValue> <d2p1:Severity>Info</d2p1:Severity> </d2p1:ValidationSummary> <d2p1:ValidationSummary> <d2p1:Allow>true</d2p1:Allow> <d2p1:Category>Missing</d2p1:Category> <d2p1:FieldName>sample string 1</d2p1:FieldName> <d2p1:FieldValue>sample string 2</d2p1:FieldValue> <d2p1:Severity>Info</d2p1:Severity> </d2p1:ValidationSummary> </d2p1:Info> <d2p1:Warnings /> </ValidationResults> </ResponseDataOfArrayOfPartMediauwLiWYs0>