All Verbs | /service/QueryProductCatalogHotspots |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | query | string | No | |
IdIn | query | string[] | No | |
CatalogId | query | string | No | |
SectionId | query | string | No | |
PageId | query | string | No | |
PageIdIn | query | string[] | No | |
Search | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
PageId | form | string | No | |
Action | form | HotspotActions | No | |
ProductId | form | string | No | |
MediaId | form | string | No | |
YouTubeId | form | string | No | |
ExternalResource | form | string | No | |
LinkedSectionId | form | string | No | |
LinkedCatalogId | form | string | No | |
LinkedPageId | form | string | No | |
Meta | form | Dictionary<string, string> | No | |
ProductIds | form | IEnumerable<string> | No | |
OriginalWidth | form | int | No | |
OriginalHeight | form | int | No | |
Left | form | int | No | |
Top | form | int | No | |
Right | form | int | No | |
Bottom | form | int | No | |
Width | form | int | No | |
Height | form | int | No | |
Generated | form | bool | No | |
RepCustom | form | bool | No | |
Position | form | int | No | |
ModifiedOn | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryProductCatalogHotspots HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
idIn:
[
String
],
catalogId: String,
sectionId: String,
pageId: String,
pageIdIn:
[
String
],
search: String,
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { id: String, pageId: String, action: None, productId: String, meta: { String: String }, originalWidth: 0, originalHeight: 0, left: 0, top: 0, right: 0, bottom: 0, width: 0, height: 0, generated: False, repCustom: False, position: 0, modifiedOn: 0001-01-01 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }