EMUN1 ASP.NET

<back to all web services

QueryProductCollections

The following routes are available for this service:
All Verbs/service/QueryProductCollections
All Verbs/service/QueryProductCollections/{Id}
QueryProductCollections Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ProductCollection Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TypeformstringNo
LabelformstringNo
ShortRomanceformstringNo
LongRomanceformstringNo
FabricformstringNo
FinishformstringNo
LeatherformstringNo
CharacteristicsCareformstringNo
NextCollectionIdformstringNo
VideoUrlformstringNo
PositionformintNo
GalleryImageUrlsformHashSet<string>No
BedroomPiecesformHashSet<string>No
DiningPiecesformHashSet<string>No
LivingPiecesformHashSet<string>No
WorkspacePiecesformHashSet<string>No
SeatingPiecesformHashSet<string>No
CocktailAccentTablesformHashSet<string>No
AccentPillowsformHashSet<string>No
FurnitureCoversformHashSet<string>No
FinishShownformHashSet<string>No
FabricShownformHashSet<string>No
LeatherShownformIEnumerable<string>No
ProductImagesformList<ProductImage>No
CalculatedTagsformIEnumerable<ProductTag>No
TagsformDictionary<string, HashSet<String>>No
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
ProductImage Parameters:
NameParameterData TypeRequiredDescription
ProductIdformstringNo
PositionformintNo
CreatedOnformDateTimeNo
ProductTag Parameters:
NameParameterData TypeRequiredDescription
ProductIdformstringNo
TagKindformstringNo
TagLabelformstringNo
ParentTagKindformstringNo
ParentTagLabelformstringNo
GeneratedformboolNo
PositionformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}