GET api/Subsegment/GetSubSegmentsBySegmentId/{segmentid}

Returns all subsegments associated with the segment

Request Information

URI Parameters

Name	Description	Type	Additional information
segmentid		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Subsegments

Name	Type	Additional information
Id	integer	None.
Name	string	None.
DisplayName	string	None.
SegmentId	integer	None.
Comparable	boolean	None.
SortOrder	integer	None.
Display	boolean	None.
SectorIdReference	string	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "SegmentId": 4,
    "Comparable": true,
    "SortOrder": 6,
    "Display": true,
    "SectorIdReference": "sample string 8"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "DisplayName": "sample string 3",
    "SegmentId": 4,
    "Comparable": true,
    "SortOrder": 6,
    "Display": true,
    "SectorIdReference": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSubsegments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NiceAPI.Managers">
  <Subsegments>
    <Comparable>true</Comparable>
    <Display>true</Display>
    <DisplayName>sample string 3</DisplayName>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <SectorIdReference>sample string 8</SectorIdReference>
    <SegmentId>4</SegmentId>
    <SortOrder>6</SortOrder>
  </Subsegments>
  <Subsegments>
    <Comparable>true</Comparable>
    <Display>true</Display>
    <DisplayName>sample string 3</DisplayName>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <SectorIdReference>sample string 8</SectorIdReference>
    <SegmentId>4</SegmentId>
    <SortOrder>6</SortOrder>
  </Subsegments>
</ArrayOfSubsegments>