GET api/Sector

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Sector
NameDescriptionTypeAdditional information
SectorId

globally unique identifier

None.

Name

string

None.

Description

string

None.

UsedByCourse

boolean

None.

UsedByProgram

boolean

None.

SchoolId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SectorId": "91117eba-030c-4aef-8ee1-beadbdf55586",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "UsedByCourse": true,
    "UsedByProgram": true,
    "SchoolId": "00a7be0e-d1f0-4500-aa15-f2f411f724f3"
  },
  {
    "SectorId": "91117eba-030c-4aef-8ee1-beadbdf55586",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "UsedByCourse": true,
    "UsedByProgram": true,
    "SchoolId": "00a7be0e-d1f0-4500-aa15-f2f411f724f3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSector xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDMS.REST.Models">
  <Sector>
    <Description>sample string 3</Description>
    <Name>sample string 2</Name>
    <SchoolId>00a7be0e-d1f0-4500-aa15-f2f411f724f3</SchoolId>
    <SectorId>91117eba-030c-4aef-8ee1-beadbdf55586</SectorId>
    <UsedByCourse>true</UsedByCourse>
    <UsedByProgram>true</UsedByProgram>
  </Sector>
  <Sector>
    <Description>sample string 3</Description>
    <Name>sample string 2</Name>
    <SchoolId>00a7be0e-d1f0-4500-aa15-f2f411f724f3</SchoolId>
    <SectorId>91117eba-030c-4aef-8ee1-beadbdf55586</SectorId>
    <UsedByCourse>true</UsedByCourse>
    <UsedByProgram>true</UsedByProgram>
  </Sector>
</ArrayOfSector>