GET api/v3/Units/GetUnitsForDepartment?departmentId={departmentId}

Get's all the units in a department and their basic info

Request Information

URI Parameters

NameDescriptionTypeAdditional information
departmentId

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of UnitResult objects, with basic information for each unit.

Collection of UnitResult
NameDescriptionTypeAdditional information
Id

Id For the Unit

integer

None.

DepartmentId

Department Id the unit is under

integer

None.

Name

Name of the unit

string

None.

Type

Type of unit (department defined)

string

None.

StationId

The station id the group is housed at

integer

None.

VIN

Vehicle Identifcation Number for the Unit (if applicable)

string

None.

PlateNumber

The Plate numbber for the Unit (if applicable)

string

None.

FourWheel

Can the unit go off-road

boolean

None.

SpecialPermit

Is a special permit or certification required to drive the unit (if applicable)

boolean

None.

Response Formats

application/json

Sample:
[
  {
    "Id": 1,
    "DepartmentId": 2,
    "Name": "sample string 3",
    "Type": "sample string 4",
    "StationId": 1,
    "VIN": "sample string 5",
    "PlateNumber": "sample string 6",
    "FourWheel": true,
    "SpecialPermit": true
  },
  {
    "Id": 1,
    "DepartmentId": 2,
    "Name": "sample string 3",
    "Type": "sample string 4",
    "StationId": 1,
    "VIN": "sample string 5",
    "PlateNumber": "sample string 6",
    "FourWheel": true,
    "SpecialPermit": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfUnitResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Units">
  <UnitResult>
    <DepartmentId>2</DepartmentId>
    <FourWheel>true</FourWheel>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <PlateNumber>sample string 6</PlateNumber>
    <SpecialPermit>true</SpecialPermit>
    <StationId>1</StationId>
    <Type>sample string 4</Type>
    <VIN>sample string 5</VIN>
  </UnitResult>
  <UnitResult>
    <DepartmentId>2</DepartmentId>
    <FourWheel>true</FourWheel>
    <Id>1</Id>
    <Name>sample string 3</Name>
    <PlateNumber>sample string 6</PlateNumber>
    <SpecialPermit>true</SpecialPermit>
    <StationId>1</StationId>
    <Type>sample string 4</Type>
    <VIN>sample string 5</VIN>
  </UnitResult>
</ArrayOfUnitResult>