All Verbs | /service/QueryProductCollections | ||
---|---|---|---|
All Verbs | /service/QueryProductCollections/{Id} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | 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 | |
Type | form | string | No | |
Label | form | string | No | |
ShortRomance | form | string | No | |
LongRomance | form | string | No | |
Fabric | form | string | No | |
Finish | form | string | No | |
Leather | form | string | No | |
CharacteristicsCare | form | string | No | |
NextCollectionId | form | string | No | |
VideoUrl | form | string | No | |
Position | form | int | No | |
GalleryImageUrls | form | HashSet<string> | No | |
BedroomPieces | form | HashSet<string> | No | |
DiningPieces | form | HashSet<string> | No | |
LivingPieces | form | HashSet<string> | No | |
WorkspacePieces | form | HashSet<string> | No | |
SeatingPieces | form | HashSet<string> | No | |
CocktailAccentTables | form | HashSet<string> | No | |
AccentPillows | form | HashSet<string> | No | |
FurnitureCovers | form | HashSet<string> | No | |
FinishShown | form | HashSet<string> | No | |
FabricShown | form | HashSet<string> | No | |
LeatherShown | form | IEnumerable<string> | No | |
ProductImages | form | List<ProductImage> | No | |
CalculatedTags | form | IEnumerable<ProductTag> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | string | No | |
Position | form | int | No | |
CreatedOn | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | string | No | |
TagKind | form | string | No | |
TagLabel | form | string | No | |
ParentTagKind | form | string | No | |
ParentTagLabel | form | string | No | |
Generated | form | bool | No | |
Position | form | int | 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/QueryProductCollections HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 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, type: String, label: String, shortRomance: String, longRomance: String, fabric: String, finish: String, leather: String, characteristicsCare: String, nextCollectionId: String, videoUrl: String, position: 0, galleryImageUrls: [ String ], bedroomPieces: [ String ], diningPieces: [ String ], livingPieces: [ String ], workspacePieces: [], seatingPieces: [ String ], cocktailAccentTables: [ String ], accentPillows: [ String ], furnitureCovers: [ String ], finishShown: [ String ], fabricShown: [ String ], leatherShown: [], productImages: [ { productId: String, position: 0, createdOn: 0001-01-01 } ], calculatedTags: [ { tagKind: Finishes, tagLabel: String, generated: False, position: 0 }, { tagKind: Fabrics, tagLabel: String, generated: False, position: 1 }, { tagKind: Seating, tagLabel: String, generated: False, position: 2 }, { tagKind: Cocktail & Accent Tables, tagLabel: String, generated: False, position: 3 }, { tagKind: Dining, tagLabel: String, generated: False, position: 4 }, { tagKind: Living, tagLabel: String, generated: False, position: 5 }, { tagKind: Bedroom, tagLabel: String, generated: False, position: 6 }, { tagKind: Accent Pillows, tagLabel: String, generated: False, position: 7 }, { tagKind: Furniture Covers, tagLabel: String, generated: False, position: 8 } ], tags: { Accent Pillows: [ String ], Bedroom: [ String ], Cocktail & Accent Tables: [ String ], Dining: [ String ], Fabrics: [ String ], Finishes: [ String ], Furniture Covers: [ String ], Living: [ String ], Seating: [ String ], String: [ String ] } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }