This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| brandId | integer |
Required |
|
| excludeImages | integer |
Default value is 0 |
|
| excludeVideos | integer |
Default value is 0 |
|
| includeVideoUrls | boolean |
Default value is False |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": {
"Videos": [
{
"NhsVideoId": "sample string 1",
"BcRefId": "sample string 2",
"BuilderId": 3,
"CommunityId": 1,
"PlanId": 1,
"Sort": 1,
"Title": "sample string 4",
"Caption": "sample string 5",
"Url": "sample string 6",
"Type": "sample string 7",
"SubType": "sample string 8",
"ThumbnailUrl": "sample string 9"
},
{
"NhsVideoId": "sample string 1",
"BcRefId": "sample string 2",
"BuilderId": 3,
"CommunityId": 1,
"PlanId": 1,
"Sort": 1,
"Title": "sample string 4",
"Caption": "sample string 5",
"Url": "sample string 6",
"Type": "sample string 7",
"SubType": "sample string 8",
"ThumbnailUrl": "sample string 9"
}
],
"Images": [
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
},
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
}
],
"PlanImages": [
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
},
{
"Id": 1,
"Sequence": 2,
"BuilderId": 3,
"CommId": 4,
"SpecId": 5,
"Title": "sample string 6",
"Caption": "sample string 7",
"Path": "sample string 8",
"OriginalPath": "sample string 9",
"Type": "sample string 10",
"Pos": 11,
"Description": "sample string 12",
"Name": "sample string 13",
"ClickThruURL": "sample string 14",
"Is360Image": true
}
]
}
}
<Root>
<Time>sample string 1</Time>
<Error>
<ClassName>System.Exception</ClassName>
<Message />
<Data />
<InnerException />
<HelpURL>sample string 1</HelpURL>
<StackTraceString />
<RemoteStackTraceString />
<RemoteStackIndex>0</RemoteStackIndex>
<ExceptionMethod />
<HResult>3</HResult>
<Source>sample string 2</Source>
<WatsonBuckets />
</Error>
<ErrorMessage>sample string 2</ErrorMessage>
<Status>sample string 3</Status>
<Server>sample string 4</Server>
<Count>1</Count>
<FavoriteCounts>
<CommCount>1</CommCount>
<PlanCount>2</PlanCount>
<SpecCount>3</SpecCount>
</FavoriteCounts>
<FavoriteFacets>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
</FavoriteFacets>
<Result>
<Videos>
<NhsVideoId>sample string 1</NhsVideoId>
<BcRefId>sample string 2</BcRefId>
<BuilderId>3</BuilderId>
<CommunityId>1</CommunityId>
<PlanId>1</PlanId>
<Sort>1</Sort>
<Title>sample string 4</Title>
<Caption>sample string 5</Caption>
<Url>sample string 6</Url>
<Type>sample string 7</Type>
<SubType>sample string 8</SubType>
<ThumbnailUrl>sample string 9</ThumbnailUrl>
</Videos>
<Videos>
<NhsVideoId>sample string 1</NhsVideoId>
<BcRefId>sample string 2</BcRefId>
<BuilderId>3</BuilderId>
<CommunityId>1</CommunityId>
<PlanId>1</PlanId>
<Sort>1</Sort>
<Title>sample string 4</Title>
<Caption>sample string 5</Caption>
<Url>sample string 6</Url>
<Type>sample string 7</Type>
<SubType>sample string 8</SubType>
<ThumbnailUrl>sample string 9</ThumbnailUrl>
</Videos>
<Images>
<Id>1</Id>
<Sequence>2</Sequence>
<BuilderId>3</BuilderId>
<CommId>4</CommId>
<SpecId>5</SpecId>
<Title>sample string 6</Title>
<Caption>sample string 7</Caption>
<Path>sample string 8</Path>
<OriginalPath>sample string 9</OriginalPath>
<Type>sample string 10</Type>
<Pos>11</Pos>
<Description>sample string 12</Description>
<Name>sample string 13</Name>
<ClickThruURL>sample string 14</ClickThruURL>
<Is360Image>true</Is360Image>
</Images>
<Images>
<Id>1</Id>
<Sequence>2</Sequence>
<BuilderId>3</BuilderId>
<CommId>4</CommId>
<SpecId>5</SpecId>
<Title>sample string 6</Title>
<Caption>sample string 7</Caption>
<Path>sample string 8</Path>
<OriginalPath>sample string 9</OriginalPath>
<Type>sample string 10</Type>
<Pos>11</Pos>
<Description>sample string 12</Description>
<Name>sample string 13</Name>
<ClickThruURL>sample string 14</ClickThruURL>
<Is360Image>true</Is360Image>
</Images>
<PlanImages>
<Id>1</Id>
<Sequence>2</Sequence>
<BuilderId>3</BuilderId>
<CommId>4</CommId>
<SpecId>5</SpecId>
<Title>sample string 6</Title>
<Caption>sample string 7</Caption>
<Path>sample string 8</Path>
<OriginalPath>sample string 9</OriginalPath>
<Type>sample string 10</Type>
<Pos>11</Pos>
<Description>sample string 12</Description>
<Name>sample string 13</Name>
<ClickThruURL>sample string 14</ClickThruURL>
<Is360Image>true</Is360Image>
</PlanImages>
<PlanImages>
<Id>1</Id>
<Sequence>2</Sequence>
<BuilderId>3</BuilderId>
<CommId>4</CommId>
<SpecId>5</SpecId>
<Title>sample string 6</Title>
<Caption>sample string 7</Caption>
<Path>sample string 8</Path>
<OriginalPath>sample string 9</OriginalPath>
<Type>sample string 10</Type>
<Pos>11</Pos>
<Description>sample string 12</Description>
<Name>sample string 13</Name>
<ClickThruURL>sample string 14</ClickThruURL>
<Is360Image>true</Is360Image>
</PlanImages>
</Result>
</Root>
Code Generator
Response Information
ApiResultModelOfApiCommunityMediaObject
| Name | Description | Type | Additional information |
|---|---|---|---|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | ApiCommunityMediaObject |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
GET
api/v2/Media/Brand?brandId={brandId}&excludeImages={excludeImages}&excludeVideos={excludeVideos}&includeVideoUrls={includeVideoUrls}