GET api/SearchNodes?name={name}&nodeType={nodeType}&brandNode={brandNode}&exactMatch={exactMatch}

Retrieves a list of list of nodes with a name that matches the search string within the given brand node.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Search string for node name

string

Required

nodeType

Node Type to search for (optional). If not specified, searches all node types.

NodeType

None.

brandNode

Brand node to search within (optional). If not specified, searches all nodes.

integer

None.

exactMatch

Toggle for whether to perform exact match or contains query

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

List of nodes that matches 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

Sample:
[
  {
    "ID": 31,
    "Name": "Heading A",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2024-04-20T01:31:21.9889292Z",
    "DateModified": "2024-04-20T01:31:21.9889292Z"
  },
  {
    "ID": 47,
    "Name": "Heading B",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2024-04-20T01:31:21.9889292Z",
    "DateModified": "2024-04-20T01:31:21.9889292Z"
  },
  {
    "ID": 53,
    "Name": "Part",
    "NodeType": 1,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2024-04-20T01:31:21.9889292Z",
    "DateModified": "2024-04-20T01:31:21.9889292Z"
  }
]

text/json

Sample:
[
  {
    "ID": 31,
    "Name": "Heading A",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2024-04-20T01:31:22.0826764Z",
    "DateModified": "2024-04-20T01:31:22.0826764Z"
  },
  {
    "ID": 47,
    "Name": "Heading B",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2024-04-20T01:31:22.0826764Z",
    "DateModified": "2024-04-20T01:31:22.0826764Z"
  },
  {
    "ID": 53,
    "Name": "Part",
    "NodeType": 1,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2024-04-20T01:31:22.0826764Z",
    "DateModified": "2024-04-20T01:31:22.0826764Z"
  }
]

text/html

Sample:
[{"ID":31,"Name":"Heading A","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2024-04-20T01:31:22.0826764Z","DateModified":"2024-04-20T01:31:22.0826764Z"},{"ID":47,"Name":"Heading B","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2024-04-20T01:31:22.0826764Z","DateModified":"2024-04-20T01:31:22.0826764Z"},{"ID":53,"Name":"Part","NodeType":1,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2024-04-20T01:31:22.0826764Z","DateModified":"2024-04-20T01:31:22.0826764Z"}]

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>2024-04-20T01:31:22.098301Z</DateCreated>
    <DateModified>2024-04-20T01:31:22.098301Z</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>2024-04-20T01:31:22.098301Z</DateCreated>
    <DateModified>2024-04-20T01:31:22.098301Z</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>2024-04-20T01:31:22.098301Z</DateCreated>
    <DateModified>2024-04-20T01:31:22.098301Z</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>