BusinessApi

<back to all web services

PlaceGetSelectedBrandsRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/place/get_selected_brands
PlaceGetSelectedBrandsRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdquerylongNo
PlaceGetSelectedBrandsResponse Parameters:
NameParameterData TypeRequiredDescription
BrandsWithCategoriesformList<BrandWithCategoriesDto>Yes
CustomBrandsWithCategoriesformList<PlaceCustomBrandWithCategoriesDto>Yes
BrandWithCategoriesDto Parameters:
NameParameterData TypeRequiredDescription
CategoriesformList<CategoryDto>Yes
BrandDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DefinedByRootCategoryIdformlongNo
NameformstringYes
CategoryDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SlugformstringYes
AbsoluteSlugformstringYes
NameformstringYes
ParentIdformlong?No
PlaceCustomBrandWithCategoriesDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DefinedByPlaceIdformlongNo
LabelformstringYes
CategoriesformList<CategoryDto>Yes

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.

GET /place/get_selected_brands HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	brandsWithCategories: 
	[
		{
			categories: 
			[
				{
					id: 0,
					slug: String,
					absoluteSlug: String,
					name: String,
					parentId: 0
				}
			],
			id: 0,
			definedByRootCategoryId: 0,
			name: String
		}
	],
	customBrandsWithCategories: 
	[
		{
			id: 0,
			definedByPlaceId: 0,
			label: String,
			categories: 
			[
				{
					id: 0,
					slug: String,
					absoluteSlug: String,
					name: String,
					parentId: 0
				}
			]
		}
	]
}