GET api/Boiler/Search?category={category}&q={q}&manufacture={manufacture}&model={model}&type={type}

This function provides the ability to search and filter through the FGO+ database

Request Information

URI Parameters

NameDescriptionTypeAdditional information
category

integer

Required

q

The search string (query)

string

Default value is

manufacture

Optional filter on manufacture

string

Default value is

model

Optional filter on model (manufacture required)

string

Default value is

type

Optional filter on type (manufacture and model required)

string

Default value is

Body Parameters

None.

Response Information

Resource Description

A basic list of found products

Collection of SearchProductModel
NameDescriptionTypeAdditional information
Id

Gets or sets the unique id of the product used in subsequent operations

string

None.

GLN

Gets or sets the unique identifier of the manufacturer. GLN stands for Global Location Number

string

None.

GTIN

string

None.

Productcode

string

None.

Description

string

None.

Manufacture

string

None.

Model

string

None.

Type

string

None.

Features

Collection of EtimFeatureModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "GLN": "sample string 2",
    "GTIN": "sample string 3",
    "Productcode": "sample string 4",
    "Description": "sample string 5",
    "Manufacture": "sample string 6",
    "Model": "sample string 7",
    "Type": "sample string 8",
    "Features": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  {
    "Id": "sample string 1",
    "GLN": "sample string 2",
    "GTIN": "sample string 3",
    "Productcode": "sample string 4",
    "Description": "sample string 5",
    "Manufacture": "sample string 6",
    "Model": "sample string 7",
    "Type": "sample string 8",
    "Features": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
]

text/xml

Sample:
<ArrayOfSearchProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FGO.Services.Models">
  <SearchProductModel>
    <Description>sample string 5</Description>
    <Features>
      <EtimFeatureModel>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </EtimFeatureModel>
      <EtimFeatureModel>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </EtimFeatureModel>
    </Features>
    <GLN>sample string 2</GLN>
    <GTIN>sample string 3</GTIN>
    <Id>sample string 1</Id>
    <Manufacture>sample string 6</Manufacture>
    <Model>sample string 7</Model>
    <Productcode>sample string 4</Productcode>
    <Type>sample string 8</Type>
  </SearchProductModel>
  <SearchProductModel>
    <Description>sample string 5</Description>
    <Features>
      <EtimFeatureModel>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </EtimFeatureModel>
      <EtimFeatureModel>
        <Name>sample string 1</Name>
        <Value>sample string 2</Value>
      </EtimFeatureModel>
    </Features>
    <GLN>sample string 2</GLN>
    <GTIN>sample string 3</GTIN>
    <Id>sample string 1</Id>
    <Manufacture>sample string 6</Manufacture>
    <Model>sample string 7</Model>
    <Productcode>sample string 4</Productcode>
    <Type>sample string 8</Type>
  </SearchProductModel>
</ArrayOfSearchProductModel>