ApexERPHost

<back to all web services

GetECommerceFilters

Requires Authentication
The following routes are available for this service:
GET/eCommerce/Filters
GetECommerceFilters Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryint?No
BranchIdqueryint?No
LangquerystringNo
GetECommerceFiltersResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<ECommerceFilterGroup>No
ECommerceFilterGroup Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
LocationformstringNo
FiltersformList<ECommerceFilter>No
ECommerceFilter Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeformintNo
NameformstringNo
QueryParamformstringNo
ValuesformList<ECommerceFilterValue>No
DefaultValueformECommerceFilterValueNo
ECommerceFilterValue Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
NameformstringNo
MinValueformdecimal?No
MaxValueformdecimal?No
ParentValueformstringNo
ImgLinkformstringNo
SortformstringNo
SlugformstringNo
ShortDescriptionformstringNo
DescriptionformstringNo
ShortDescription2formstringNo
Description2formstringNo
VideoLinkformstringNo
ImageLinksformList<string>No
MinCountformdecimal?No

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 /eCommerce/Filters HTTP/1.1 
Host: 10.10.0.107 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			Id: 0,
			Name: String,
			Location: String,
			Filters: 
			[
				{
					Id: 0,
					Type: 0,
					Name: String,
					QueryParam: String,
					Values: 
					[
						{
							Value: String,
							Name: String,
							MinValue: 0,
							MaxValue: 0,
							ParentValue: String,
							ImgLink: String,
							Sort: String,
							Slug: String,
							ShortDescription: String,
							Description: String,
							ShortDescription2: String,
							Description2: String,
							VideoLink: String,
							ImageLinks: 
							[
								String
							],
							MinCount: 0
						}
					],
					DefaultValue: 
					{
						Value: String,
						Name: String,
						MinValue: 0,
						MaxValue: 0,
						ParentValue: String,
						ImgLink: String,
						Sort: String,
						Slug: String,
						ShortDescription: String,
						Description: String,
						ShortDescription2: String,
						Description2: String,
						VideoLink: String,
						ImageLinks: 
						[
							String
						],
						MinCount: 0
					}
				}
			]
		}
	]
}