Unifeed – Parameters filter

Supplying Filter as part of the parameters in the adress bar

A part of the parameters that can be supplied via the address bar, is the filter object. By supplying the filter when starting Unifeed, all following searches will be executed within the context of this filter. The format of the filter is a JSON string. All parameters have to be URL-encoded, the filter object is no exception.

Because the filter object offers extended options, it is described separately below.

Structure

De structure of the filter wrapper object is  

class wrapper {
		public filters: Array<Filter>;
		public query: string;
}

class Filter {
		public id: string; 
		public name: string;
		public type: string;
		public values: Array<IValue>;
		public hidden: boolean;
}

interface IValue {
		id: string;
		name: string;
	}

class ValueA implements IValue {
		public id: string;
		public name: string;
	}

class ValueN implements IValue {
		public id: string;
		public name: string;
		public min: number;
		public max: number;
	}

class ValueR implements IValue {
		public id: string;
		public name: string;
		public rangevalue: number;
	}


 A list of all possible filter types

Filter type DescriptionExample
class

Filter by one or more classes (ETIM classes, EC*)
Filter values are of type A(lphanumeric)

filter.type=”class”
filter.name=”class”
value.id=EC-code
value.name=EC-name

 filter={“filters”:[{“id”:”class”,”name”:”Klasse”,”type”:”class”,”values”:[{“id”:”EC000188″,”name”:”Bistabiel relais”},{“id”:”EC000196″,”name”:”Hulprelais”}]}]}
featureA

Filter by Alphanumeric features (ETIM features, EF*, type A)
Filter values are of type A(lphanumeric)

filter.type=”featureA
filter.id=EF-code
filter.name=EF-name
value.id=EV-code
value.name=EV-name

 filter={“filters”:[{“id”:”EF000007″,”name”:”Kleur”,”type”:”featureA”,”values”:[{“id”:”EV000233″,”name”:”Rood”},{“id”:”EV000119″,”name”:”Goud”}]}]}
featureN

Filter by Numeric features (ETIM features, EF*, type N). 
Filter values are of type N(umeric)

filter.type=”featureN”
filter.id=EF-code
filter.name=EF-name
value.name=min-max
value.min=number
value.max=number 

filter={“filters”:[{“id”:”EF000035″,”name”:”Lampvermogen”,”type”:”featureN”,”values”:[{“id”:”x”,”name”:”0 – 100″, “min”:”0″, “max”:”100″}]}]}
featureR

Filter by Range features (ETIM features, EF*, type R). 
Filter values are of type R(ange)

filter.type=”featureR”
filter.id=EF-code
filter.name=EF-name
value.name=rangevalue
value.rangevalue=number

filter={“filters”:[{“id”:”EF000280″,”name”:”Geschikt voor lampvermogen”,”type”:”featureR”,”values”:[{“id”:”x”,”name”:”25.00″, “rangevalue”:”25.00″}]}]}
   
manufacture

Filter by manufacture

filter.type=”manufacture”
filter.name=”Manufacture”
value.id=manufacture
value.name=manufacture

 filter={“filters”:[{“id”:”manufacture”,”name”:”Manufacture”,”type”:”manufacture”,”values”:[{“id”:”PHILIPS”,”name”:”PHILIPS”}]}]}

 

model

Filter by model / serie

filter.type=”model”
filter.name=”Serie”
value.id=model
value.name=model

 filter={“filters”:[{“id”:”model”,”name”:”Serie”,”type”:”model”,”values”:[{“id”:”CleanRoom”,”name”:”CleanRoom”}]}]}

 

type 

Filter by type

filter.type=”type”
filter.name=”Type”
value.id=type
value.name=type

 filter={“filters”:[{“id”:”type”,”name”:”Type”,”type”:”type”,”values”:[{“id”:”CR200B414GTL65″,”name”:”CR200B414GTL65″}]}]}

 

   
sgln 

Filter by supplier (GLN)

filter.type=”sgln”
filter.name=”Supplier”
value.id=leveranciersGLN
value.name=leveranciersNaam

 filter={“filters”:[{“id”:”sgln”,”name”:”Supplier”,”type”:”sgln”,”values”:[{“id”:”8711389000001″,”name”:”Technische Unie”},{“id”:”8711891990012″,”name”:”Solar Nederland”},{“id”:”8714253035000″,”name”:”Oosterberg”},{“id”:”8714253038261″,”name”:”Finder”}]}]}
   
expired

Searching expired products

filter.type=”expired”
filter.name=”Expired products”
value.id=true/false
value.name=YES/NO

 filter={“filters”:[{“id”:”expired”,”name”:”Expired products”,”type”:”expired”,”values”:[{“id”:”true”,”name”:”YES”}]}]}
   
This site is registered on wpml.org as a development site.