All Verbs | /service/QueryProductTemplateTags | ||
---|---|---|---|
All Verbs | /service/QueryProductTemplateTags/{TagKind} | ||
All Verbs | /service/QueryProductTemplateTagTotals | ||
All Verbs | /service/QueryProductTemplateTagTotals/{TagKind} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TagKind | path | string | No | |
TagLabelStartsWith | query | string | No | |
DoNotGroup | query | bool | No | |
Search | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | form | string | No | |
TagCriteria | form | Dictionary<string, HashSet<String>> | No | |
Context | form | string | No | |
Euid | form | Guid? | No | |
Id | form | int? | No | |
Active | form | bool? | 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 |
---|---|---|---|---|
Sku | form | string | No | |
Upc | form | string | No | |
Cost | form | decimal | No | |
MinimumOrderQty | form | double | No | |
PurchaseIncrement | form | double | No | |
VendorId | form | string | No | |
WholesalePrice | form | decimal | No | |
RetailPrice | form | decimal | No | |
Ratio | form | string | No | |
Height | form | double | No | |
Width | form | double | No | |
Depth | form | double | No | |
Weight | form | double | No | |
Images | form | List<MediaReference> | No | |
Documents | form | List<MediaReference> | No | |
Areas | form | List<DesignArea> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RefId | form | string | No | |
Rating | form | double | No | |
Restricted | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Label | form | string | No | |
Name | form | string | No | |
Title | form | string | No | |
Active | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Euid | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | T | No | |
CreatedBy | form | string | No | |
CreatedOn | form | DateTime | No | |
LastModifiedOn | form | DateTime | No | |
LastModifiedBy | form | string | No | |
Position | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Euid | form | Guid? | No | |
Label | form | string | No | |
Description | form | string | No | |
Realm | form | string | No | |
Url | form | string | No | |
ContentType | form | string | No | |
Height | form | double? | No | |
Width | form | double? | No | |
RefId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CopyFrom | form | Guid? | No | |
SupplierCode | form | string | No | |
Ratio | form | string | No | |
Height | form | double | No | |
Width | form | double | No | |
BleedLine | form | double? | No | |
SafeLine | form | double? | No | |
BackgroundColor | form | string | No | |
Design | form | MediaReference | No | |
Overlays | form | List<DesignAreaOverlay> | No | |
Underlays | form | List<DesignAreaUnderlay> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Euid | form | Guid | No | |
Label | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Media | form | MediaReference | No | |
Height | form | double | No | |
Width | form | double | No | |
X | form | double | No | |
Y | form | double | No | |
IsProductImage | form | bool | No | |
IsPrintImage | form | bool | No | |
CanDesign | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | string | No | |
Reason | form | string | No | |
InputId | form | string | No | |
InputIndex | form | int | No | |
CityStates | form | CityEntry[] | No | |
ZipCodes | form | ZipCodeEntry[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
City | form | string | No | |
MailableCity | form | bool | No | |
StateAbbreviation | form | string | No | |
State | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ZipCode | form | string | No | |
ZipCodeType | form | string | No | |
DefaultCity | form | string | No | |
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | form | string | No | |
Latitude | form | double | No | |
Longitude | form | double | No | |
Precision | form | string | No | |
AlternateCounties | form | AlternateCounty[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | form | string | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryProductTemplateTags HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"tagKind":"String","tagLabelStartsWith":"String","doNotGroup":false,"search":"String","tagCriteria":{"String":["String"]},"context":"String","euid":"00000000-0000-0000-0000-000000000000","id":0,"active":false,"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"offset":0,"total":0,"results":[{"id":0,"tagLabel":"String","position":0,"imageUrl":"String","tags":{"String":["String"]},"areas":[{"copyFrom":"00000000-0000-0000-0000-000000000000","supplierCode":"String","ratio":"8:1","height":0,"width":0,"bleedLine":0,"safeLine":0,"backgroundColor":"String","design":{"id":0,"euid":"00000000-0000-0000-0000-000000000000","label":"String","description":"String","realm":"String","url":"String","contentType":"String","height":0,"width":0,"refId":"String"},"overlays":[{"media":{"id":0,"euid":"00000000-0000-0000-0000-000000000000","label":"String","description":"String","realm":"String","url":"String","contentType":"String","height":0,"width":0,"refId":"String"},"height":0,"width":0,"x":0,"y":0,"isProductImage":false,"isPrintImage":false,"canDesign":false,"label":"String","description":"String"}],"underlays":[{"media":{"id":0,"euid":"00000000-0000-0000-0000-000000000000","label":"String","description":"String","realm":"String","url":"String","contentType":"String","height":0,"width":0,"refId":"String"},"height":0,"width":0,"x":0,"y":0,"isProductImage":false,"isPrintImage":false,"canDesign":false,"label":"String","description":"String"}],"label":"String","description":"String"}],"images":[{"predecessorId":0,"replacePredecessor":false,"contentType":"String","predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","predecessor":{"predecessorId":0,"replacePredecessor":false,"contentType":"String","realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0},"realm":"String","height":0,"width":0,"area":0,"contentLength":0,"clientId":"String","url":"String","originalUrl":"String","key":"String","tags":{"String":["String"]},"refId":"String","rating":0,"restricted":false,"description":"String","label":"String","active":false,"id":0,"createdBy":"String","createdOn":"0001-01-01T00:00:00.0000000Z","lastModifiedOn":"0001-01-01T00:00:00.0000000Z","lastModifiedBy":"String","position":0}]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}