GET api/v3/Calls/GetActiveCalls

Returns all the active calls for the department

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Array of CallResult objects for each active call in the department

Collection of CallResultV3
NameDescriptionTypeAdditional information
Cid

Id of the call

integer

None.

Pri

Priority of the call (Low = 0, Medium = 1, High = 2, Emergency = 3)

integer

None.

Ctl

Is Call Critical

boolean

None.

Nme

Name of the Call

string

None.

Noc

Nature of the Call

string

None.

Map

Map Location of the Call

string

None.

Not

High level note for the Call

string

None.

Add

Call Address

string

None.

Geo

Gelocation Coordinates

string

None.

Lon

When was the call Logged On

date

None.

Ste

State of the call (Active = 0, Closed = 1, Cancelled = 2, Unfounded = 3)

integer

None.

Num

Call Number, will be the 2 digit year (i.e. 15 for 2015) and an auto incrementing number for the call in the year. So 15-43 is the 43'rd call in 2015.

string

None.

Nts

The amount of notes the call has

integer

None.

Aud

The amount of audio the call has

integer

None.

Img

The amount of images the call has

integer

None.

Fls

The amount of files the call has

integer

None.

w3w

What 3 Words Address

string

None.

Response Formats

application/json

Sample:
[
  {
    "Cid": 1,
    "Pri": 2,
    "Ctl": true,
    "Nme": "sample string 4",
    "Noc": "sample string 5",
    "Map": "sample string 6",
    "Not": "sample string 7",
    "Add": "sample string 8",
    "Geo": "sample string 9",
    "Lon": "2017-08-16T09:08:00.870971+00:00",
    "Ste": 11,
    "Num": "sample string 12",
    "Nts": 13,
    "Aud": 14,
    "Img": 15,
    "Fls": 16,
    "w3w": "sample string 17"
  },
  {
    "Cid": 1,
    "Pri": 2,
    "Ctl": true,
    "Nme": "sample string 4",
    "Noc": "sample string 5",
    "Map": "sample string 6",
    "Not": "sample string 7",
    "Add": "sample string 8",
    "Geo": "sample string 9",
    "Lon": "2017-08-16T09:08:00.870971+00:00",
    "Ste": 11,
    "Num": "sample string 12",
    "Nts": 13,
    "Aud": 14,
    "Img": 15,
    "Fls": 16,
    "w3w": "sample string 17"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCallResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Calls">
  <CallResult>
    <Add>sample string 8</Add>
    <Aud>14</Aud>
    <Cid>1</Cid>
    <Ctl>true</Ctl>
    <Fls>16</Fls>
    <Geo>sample string 9</Geo>
    <Img>15</Img>
    <Lon>2017-08-16T09:08:00.870971+00:00</Lon>
    <Map>sample string 6</Map>
    <Nme>sample string 4</Nme>
    <Noc>sample string 5</Noc>
    <Not>sample string 7</Not>
    <Nts>13</Nts>
    <Num>sample string 12</Num>
    <Pri>2</Pri>
    <Ste>11</Ste>
    <w3w>sample string 17</w3w>
  </CallResult>
  <CallResult>
    <Add>sample string 8</Add>
    <Aud>14</Aud>
    <Cid>1</Cid>
    <Ctl>true</Ctl>
    <Fls>16</Fls>
    <Geo>sample string 9</Geo>
    <Img>15</Img>
    <Lon>2017-08-16T09:08:00.870971+00:00</Lon>
    <Map>sample string 6</Map>
    <Nme>sample string 4</Nme>
    <Noc>sample string 5</Noc>
    <Not>sample string 7</Not>
    <Nts>13</Nts>
    <Num>sample string 12</Num>
    <Pri>2</Pri>
    <Ste>11</Ste>
    <w3w>sample string 17</w3w>
  </CallResult>
</ArrayOfCallResult>