GET api/v3/Calls/GetFilesForCall?callId={callId}&includeData={includeData}&type={type}

Get the files for a call in the Resgrid System

Request Information

URI Parameters

NameDescriptionTypeAdditional information
callId

CallId to get the files for

integer

Required

includeData

Include the data in the result

boolean

Required

type

Type of file to get (Any = 0, Audio = 1, Images = 2, Files = 3, Videos = 4)

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CallFileResult
NameDescriptionTypeAdditional information
Id

Id of the call file

integer

None.

Cid

Id of the Call

integer

None.

Typ

Type of the file (Audio = 1, Image= 2, File = 3, Video = 4)

integer

None.

Fln

Name of the File

string

None.

Data

Base64 File Data (may be null)

string

None.

Nme

User friendly name of the file

string

None.

Sze

Size of the file in bytes

integer

None.

Url

The Url to get the file instead of using the Data value

string

None.

Uid

User Id of the person who uploaded the file

string

None.

Tme

Timestamp of when the file was added

string

None.

Mime

Mime Type for the file

string

None.

Response Formats

application/json

Sample:
[
  {
    "Id": 1,
    "Cid": 2,
    "Typ": 3,
    "Fln": "sample string 4",
    "Data": "sample string 5",
    "Nme": "sample string 6",
    "Sze": 7,
    "Url": "sample string 8",
    "Uid": "sample string 9",
    "Tme": "sample string 10",
    "Mime": "sample string 11"
  },
  {
    "Id": 1,
    "Cid": 2,
    "Typ": 3,
    "Fln": "sample string 4",
    "Data": "sample string 5",
    "Nme": "sample string 6",
    "Sze": 7,
    "Url": "sample string 8",
    "Uid": "sample string 9",
    "Tme": "sample string 10",
    "Mime": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCallFileResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Calls">
  <CallFileResult>
    <Cid>2</Cid>
    <Data>sample string 5</Data>
    <Fln>sample string 4</Fln>
    <Id>1</Id>
    <Mime>sample string 11</Mime>
    <Nme>sample string 6</Nme>
    <Sze>7</Sze>
    <Tme>sample string 10</Tme>
    <Typ>3</Typ>
    <Uid>sample string 9</Uid>
    <Url>sample string 8</Url>
  </CallFileResult>
  <CallFileResult>
    <Cid>2</Cid>
    <Data>sample string 5</Data>
    <Fln>sample string 4</Fln>
    <Id>1</Id>
    <Mime>sample string 11</Mime>
    <Nme>sample string 6</Nme>
    <Sze>7</Sze>
    <Tme>sample string 10</Tme>
    <Typ>3</Typ>
    <Uid>sample string 9</Uid>
    <Url>sample string 8</Url>
  </CallFileResult>
</ArrayOfCallFileResult>