GET api/v3/Calls/GetCall?callId={callId}

Returns a specific call from the Resgrid System

Request Information

URI Parameters

NameDescriptionTypeAdditional information
callId

integer

Required

Body Parameters

None.

Response Information

Resource Description

CallResult of the call in the Resgrid system

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.
Rnm

Reporter Name

 string

None.
Rci

Reporter Contact Info

 string

None.
Rid

Reference Id

 string

None.
Eid

External Id

 string

None.
Aid

Audio File Id

 string

None.
Utc

When was the call Logged On in UTC time

 date

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": "2018-08-11T02:18:48.2666019+00:00",
  "Ste": 11,
  "Num": "sample string 12",
  "Nts": 13,
  "Aud": 14,
  "Img": 15,
  "Fls": 16,
  "w3w": "sample string 17",
  "Rnm": "sample string 18",
  "Rci": "sample string 19",
  "Rid": "sample string 20",
  "Eid": "sample string 21",
  "Aid": "sample string 22",
  "Utc": "2018-08-11T02:18:48.2666019+00:00"
}

application/xml, text/xml

Sample: 
<CallResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Calls">
  <Add>sample string 8</Add>
  <Aid>sample string 22</Aid>
  <Aud>14</Aud>
  <Cid>1</Cid>
  <Ctl>true</Ctl>
  <Eid>sample string 21</Eid>
  <Fls>16</Fls>
  <Geo>sample string 9</Geo>
  <Img>15</Img>
  <Lon>2018-08-11T02:18:48.2666019+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>
  <Rci>sample string 19</Rci>
  <Rid>sample string 20</Rid>
  <Rnm>sample string 18</Rnm>
  <Ste>11</Ste>
  <Utc>2018-08-11T02:18:48.2666019+00:00</Utc>
  <w3w>sample string 17</w3w>
</CallResult>