Get Search criteria fields

Resource type: searchCriteriaFields

With this API call all fields can be queried that are marked / selected as search criteria.

Parameters:

• language
  STRING. 3-digit ISO code, e.g. “ENG”. If parameter is set, the field labels in the response are displayed in the set language.
• additionalTranslations
  BOOLEAN. If true, the parameter additionalTranslations is also output for all ‘from-to’ fields, e.g. purchase price in the response, and shows the field name and field label of the ‘from’ and ‘to’ information.

Request example

    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid": "",
        "identifier": "",
        "resourcetype": "searchCriteriaFields",
        "parameters": []
    }

Response:

• name
  Name of the category
• fields
  Array of JSON objects. List of fields in a category.
  • id
    Unique field key
  • name
    name of field
  • position
    Position of the field within the search criteria fields
  • type
    Type of field (data type, singleselect, multiselect)
    Special case “regionaler_zusatz” (Regional addition): limitExceeded, displayAll, displayLive
  • ko
    OPTIONAL. Field is marked as knockout criterion
  • mandatory
    OPTIONAL. Field is a mandatory field
  • rangefield
    OPTIONAL. Field has a value range (“from” – “to” field)
  • objektarten
    OPTIONAL. Field filter for property classes. Comma-separated “list” of the property classes for which the field is to be displayed
  • nutzungsarten
    OPTIONAL. Field filter for type of usage. Comma-separated “list” of the types of usage for which the field is to be displayed
  • vermarktungsarten
    OPTIONAL. Field filter for marketing method. Comma-separated “list” of marketing methods for which the field is to be displayed
  • values
    OPTIONAL. Only for type single- and multiselect. JSON object with individual key-value pairs
  • default
    OPTIONAL. Only for type single- und multiselect. Default value of the singleselect or multiselect values
  • additionalTranslations
    OPTIONAL. BOOLEAN. If request parameter additionalTranslations is true, this response parameter is output for all ‘from-to’ fields, e.g. purchase price in the response, and shows the field name and field label of the ‘from’ and ‘to’ information.

Beispiel:

...
elements: {
	name: "Flächen",
	fields: [
	{
		id: "wohnflaeche",
		name: "Wohnfläche",
		position: "3",
		ko: "true",
		rangefield: "true",
		type: "urn:onoffice-de-ns:smart:2.5:dbAccess:dataType:float",
		objektarten: "wohnung,haus,waz,hallen_lager_prod,zimmer"
	},
...