All Verbs | /service/QueryProductCatalogs | ||
---|---|---|---|
All Verbs | /service/QueryPromoSheets |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
Online | query | bool? | No | |
Offline | query | bool? | No | |
TagCriteria | query | Dictionary<string, HashSet<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 | |
Label | form | string | No | |
Type | form | string | No | |
Cover | form | string | No | |
Position | form | int | No | |
HideB2B | form | bool | No | |
RepCustom | form | bool | No | |
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
ModifiedOn | form | DateTime | No | |
ExpiresOn | form | DateTime | No | |
PublishOn | form | DateTime | No | |
Active | form | bool | No | |
VendorId | form | string | No | |
Sections | form | List<ProductCatalogSection> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
Attributes | form | ProductCatalogAttributes | No | |
Layout | form | string | No | |
Width | form | double? | No | |
Height | form | double? | No | |
FirstPageBlank | form | bool? | No | |
ArtboardWidth | form | int | No | |
ArtboardHeight | form | int | No | |
ArtboardPageCount | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CatalogId | form | string | No | |
Label | form | string | No | |
Cover | form | string | No | |
Position | form | int | No | |
StartPageNum | form | int? | No | |
EndPageNum | form | int? | No | |
PageCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Layout | form | string | No | |
OffsetPage | form | string | No | |
Height | form | double? | No | |
Width | form | double? | No | |
FirstPageBlank | form | bool? | 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/QueryProductCatalogs HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
online: False,
offline: False,
tagCriteria:
{
String:
[
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, label: String, type: String, cover: String, position: 0, hideB2B: False, repCustom: False, createdBy: String, createdOn: 0001-01-01, modifiedOn: 0001-01-01, expiresOn: 0001-01-01, publishOn: 0001-01-01, active: False, vendorId: String, sections: [ { id: String, catalogId: String, label: String, cover: String, position: 0, startPageNum: 0, endPageNum: 0, pageCount: 0 } ], tags: { String: [ String ] }, attributes: { layout: String, offsetPage: String, height: 0, width: 0, firstPageBlank: False }, layout: String, width: 0, height: 0, firstPageBlank: False, artboardWidth: 0, artboardHeight: 0, artboardPageCount: 0 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }