GET api/v3/Links/GetUnitStatusesForLink?linkId={linkId}

Get's all the units for a department link and their current status information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
linkId

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of UnitStatusResult objects, with status information for each unit.

Collection of UnitStatusResultV3
NameDescriptionTypeAdditional information
Uid

The integer based Unit Identifier

integer

None.

Did

The Id of the Destination for the Unit (could be a Call or a Station)

integer

None.

Typ

The current status/state of the Unit

integer

None.

Tmp

The Timestamp of the status

date

None.

Response Formats

application/json

Sample:
[
  {
    "Uid": 1,
    "Did": 2,
    "Typ": 3,
    "Tmp": "2017-06-23T10:25:47.8329271+00:00"
  },
  {
    "Uid": 1,
    "Did": 2,
    "Typ": 3,
    "Tmp": "2017-06-23T10:25:47.8329271+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfUnitStatusResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Units">
  <UnitStatusResult>
    <Did>2</Did>
    <Tmp>2017-06-23T10:25:47.8329271+00:00</Tmp>
    <Typ>3</Typ>
    <Uid>1</Uid>
  </UnitStatusResult>
  <UnitStatusResult>
    <Did>2</Did>
    <Tmp>2017-06-23T10:25:47.8329271+00:00</Tmp>
    <Typ>3</Typ>
    <Uid>1</Uid>
  </UnitStatusResult>
</ArrayOfUnitStatusResult>