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.
SearchObjectName | Description | Type | Additional information |
---|---|---|---|
nodeId | integer |
None. |
|
parameters | Collection of SearchParameter |
None. |
Request Formats
application/json, text/json
{ "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
{"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
<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 not available.
Response Information
Resource Description
List of nodes under the heading that match the search parameters
Collection of NodeName | Description | Type | Additional information |
---|---|---|---|
ID |
Node ID |
integer |
None. |
Name |
The name of the Node (heading title, or part number). |
string |
Max length: 200 |
NodeType |
The type of the Node. |
NodeType |
None. |
BrandNode |
The ID of the brand node this node belongs to. A node can only ever exist within a single brand. |
integer |
None. |
ManufacturerNodes |
List of IDs for the manufacturer nodes that this node belongs to. In principle, a node can belong to several manufacturers - a part that shared between several manufacturers within the same brand. In reality, this probably won't happen very often and most of the time this list will only contain a single integer. |
Collection of integer |
None. |
ManufacturerNodesSerialized |
A serialised version of the ManufacturerNodes list, with integers separated by ';' characters. |
string |
None. |
ArchiveStatus |
A flag to determine whether the Node is editing status of the node, whether it is live, archived, or deleted. |
ArchiveStatus |
None. |
Visibility |
Visibility status of node. 0 is public, 1 is to select users and 2 is for internal only purposes. |
VisibilityStatus |
None. |
DateCreated |
The date and time the node was created |
date |
None. |
DateModified |
The date and time the node was last modified |
date |
None. |
Response Formats
application/json, text/json
[ { "ID": 31, "Name": "Heading A", "NodeType": 0, "BrandNode": null, "ManufacturerNodes": [ 63, 21 ], "ManufacturerNodesSerialized": "63;21", "ArchiveStatus": 0, "Visibility": 0, "DateCreated": "2019-12-10T22:13:41.2862124Z", "DateModified": "2019-12-10T22:13:41.2862124Z" }, { "ID": 47, "Name": "Heading B", "NodeType": 0, "BrandNode": null, "ManufacturerNodes": [ 63, 21 ], "ManufacturerNodesSerialized": "63;21", "ArchiveStatus": 0, "Visibility": 0, "DateCreated": "2019-12-10T22:13:41.2862124Z", "DateModified": "2019-12-10T22:13:41.2862124Z" }, { "ID": 53, "Name": "Part", "NodeType": 1, "BrandNode": null, "ManufacturerNodes": [ 63, 21 ], "ManufacturerNodesSerialized": "63;21", "ArchiveStatus": 0, "Visibility": 0, "DateCreated": "2019-12-10T22:13:41.2862124Z", "DateModified": "2019-12-10T22:13:41.2862124Z" } ]
text/html
[{"ID":31,"Name":"Heading A","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2019-12-10T22:13:41.2862124Z","DateModified":"2019-12-10T22:13:41.2862124Z"},{"ID":47,"Name":"Heading B","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2019-12-10T22:13:41.2862124Z","DateModified":"2019-12-10T22:13:41.2862124Z"},{"ID":53,"Name":"Part","NodeType":1,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2019-12-10T22:13:41.2862124Z","DateModified":"2019-12-10T22:13:41.2862124Z"}]
application/xml, text/xml
<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>2019-12-10T22:13:41.2862124Z</DateCreated> <DateModified>2019-12-10T22:13:41.2862124Z</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>2019-12-10T22:13:41.2862124Z</DateCreated> <DateModified>2019-12-10T22:13:41.2862124Z</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>2019-12-10T22:13:41.2862124Z</DateCreated> <DateModified>2019-12-10T22:13:41.2862124Z</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>