GET api/PartNodesWithinIndex/{id}?includeVariations={includeVariations}

Returns all part nodes that are connected to the node with a specific ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Start node ID

integer

Required

includeVariations

Whether to include variations or not

boolean

Required

Body Parameters

None.

Response Information

Resource Description

List of nodes, including parts and variations

Collection of Node
NameDescriptionTypeAdditional 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

Sample:
[
  {
    "ID": 31,
    "Name": "Heading A",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2019-08-22T13:23:19.2461393Z",
    "DateModified": "2019-08-22T13:23:19.2461393Z"
  },
  {
    "ID": 47,
    "Name": "Heading B",
    "NodeType": 0,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2019-08-22T13:23:19.2461393Z",
    "DateModified": "2019-08-22T13:23:19.2461393Z"
  },
  {
    "ID": 53,
    "Name": "Part",
    "NodeType": 1,
    "BrandNode": null,
    "ManufacturerNodes": [
      63,
      21
    ],
    "ManufacturerNodesSerialized": "63;21",
    "ArchiveStatus": 0,
    "Visibility": 0,
    "DateCreated": "2019-08-22T13:23:19.2461393Z",
    "DateModified": "2019-08-22T13:23:19.2461393Z"
  }
]

text/html

Sample:
[{"ID":31,"Name":"Heading A","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2019-08-22T13:23:19.2461393Z","DateModified":"2019-08-22T13:23:19.2461393Z"},{"ID":47,"Name":"Heading B","NodeType":0,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2019-08-22T13:23:19.2461393Z","DateModified":"2019-08-22T13:23:19.2461393Z"},{"ID":53,"Name":"Part","NodeType":1,"BrandNode":null,"ManufacturerNodes":[63,21],"ManufacturerNodesSerialized":"63;21","ArchiveStatus":0,"Visibility":0,"DateCreated":"2019-08-22T13:23:19.2461393Z","DateModified":"2019-08-22T13:23:19.2461393Z"}]

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>2019-08-22T13:23:19.2461393Z</DateCreated>
    <DateModified>2019-08-22T13:23:19.2461393Z</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-08-22T13:23:19.2461393Z</DateCreated>
    <DateModified>2019-08-22T13:23:19.2461393Z</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-08-22T13:23:19.2461393Z</DateCreated>
    <DateModified>2019-08-22T13:23:19.2461393Z</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>