POST api/Search

Retrieves a list of list of nodes with below the given heading node that fufil the parameter attributes given

Request Information

URI Parameters

None.

Body Parameters

The SearchObject consists of two parts, the "nodeId", the ID of the heading node to search underand the "parameters", the list of parameters to limit the returned results by. Parameters take the form {AttributeId (int), AttributeValue (string), Operator(string)}. The inequality operators can only operate on pure number fields.

SearchObject
NameDescriptionTypeAdditional information
nodeId

integer

None.

parameters

Collection of SearchParameter

None.

Request Formats

application/json, text/json

Sample:
{
  "nodeId": 1,
  "parameters": [
    {
      "AttributeName": "sample string 1",
      "Operator": "sample string 2",
      "AttributeValue": "sample string 3"
    },
    {
      "AttributeName": "sample string 1",
      "Operator": "sample string 2",
      "AttributeValue": "sample string 3"
    }
  ]
}

text/html

Sample:
{"nodeId":1,"parameters":[{"AttributeName":"sample string 1","Operator":"sample string 2","AttributeValue":"sample string 3"},{"AttributeName":"sample string 1","Operator":"sample string 2","AttributeValue":"sample string 3"}]}

application/xml, text/xml

Sample:
<AttributeSearch.SearchObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Jotunheim.Services.Search">
  <nodeId>1</nodeId>
  <parameters>
    <AttributeSearch.SearchParameter>
      <AttributeName>sample string 1</AttributeName>
      <AttributeValue>sample string 3</AttributeValue>
      <Operator>sample string 2</Operator>
    </AttributeSearch.SearchParameter>
    <AttributeSearch.SearchParameter>
      <AttributeName>sample string 1</AttributeName>
      <AttributeValue>sample string 3</AttributeValue>
      <Operator>sample string 2</Operator>
    </AttributeSearch.SearchParameter>
  </parameters>
</AttributeSearch.SearchObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of nodes under the heading that match the search parameters

Collection of Node
NameDescriptionTypeAdditional information
ID

integer

None.

Name

string

Max length: 200

NodeType

NodeType

None.

BrandNode

integer

None.

ManufacturerNodes

Collection of integer

None.

ManufacturerNodesSerialized

string

None.

ArchiveStatus

ArchiveStatus

None.

Visibility

VisibilityStatus

None.

DateCreated

date

None.

DateModified

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 31,
    "Name": "Heading A",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2020-08-15T20:27:54.7559372Z",
    "DateModified": "2020-08-15T20:27:54.7559372Z"
  },
  {
    "ID": 47,
    "Name": "Heading B",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2020-08-15T20:27:54.7559372Z",
    "DateModified": "2020-08-15T20:27:54.7559372Z"
  },
  {
    "ID": 53,
    "Name": "Part",
    "NodeType": 1,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2020-08-15T20:27:54.7559372Z",
    "DateModified": "2020-08-15T20:27:54.7559372Z"
  }
]

text/html

Sample:
[{"ID":31,"Name":"Heading A","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2020-08-15T20:27:54.7559372Z","DateModified":"2020-08-15T20:27:54.7559372Z"},{"ID":47,"Name":"Heading B","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2020-08-15T20:27:54.7559372Z","DateModified":"2020-08-15T20:27:54.7559372Z"},{"ID":53,"Name":"Part","NodeType":1,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2020-08-15T20:27:54.7559372Z","DateModified":"2020-08-15T20:27:54.7559372Z"}]

application/xml, text/xml

Sample:
<ArrayOfNode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Jotunheim.Models.Core">
  <Node>
    <ArchiveStatus>Live</ArchiveStatus>
    <BrandNode i:nil="true" />
    <DateCreated>2020-08-15T20:27:54.7559372Z</DateCreated>
    <DateModified>2020-08-15T20:27:54.7559372Z</DateModified>
    <ID>31</ID>
    <ManufacturerNodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>63</d3p1:int>
      <d3p1:int>21</d3p1:int>
    </ManufacturerNodes>
    <ManufacturerNodesSerialized>63;21</ManufacturerNodesSerialized>
    <Name>Heading A</Name>
    <NodeType>Heading</NodeType>
    <Visibility>Public</Visibility>
  </Node>
  <Node>
    <ArchiveStatus>Live</ArchiveStatus>
    <BrandNode i:nil="true" />
    <DateCreated>2020-08-15T20:27:54.7559372Z</DateCreated>
    <DateModified>2020-08-15T20:27:54.7559372Z</DateModified>
    <ID>47</ID>
    <ManufacturerNodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>63</d3p1:int>
      <d3p1:int>21</d3p1:int>
    </ManufacturerNodes>
    <ManufacturerNodesSerialized>63;21</ManufacturerNodesSerialized>
    <Name>Heading B</Name>
    <NodeType>Heading</NodeType>
    <Visibility>Public</Visibility>
  </Node>
  <Node>
    <ArchiveStatus>Live</ArchiveStatus>
    <BrandNode i:nil="true" />
    <DateCreated>2020-08-15T20:27:54.7559372Z</DateCreated>
    <DateModified>2020-08-15T20:27:54.7559372Z</DateModified>
    <ID>53</ID>
    <ManufacturerNodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>63</d3p1:int>
      <d3p1:int>21</d3p1:int>
    </ManufacturerNodes>
    <ManufacturerNodesSerialized>63;21</ManufacturerNodesSerialized>
    <Name>Part</Name>
    <NodeType>Part</NodeType>
    <Visibility>Public</Visibility>
  </Node>
</ArrayOfNode>