POST api/v3/Calls/AddCall

Request Information

URI Parameters

None.

Body Parameters

AddCallInput
NameDescriptionTypeAdditional information
CallId

integer

None.

Number

string

None.

DepartmentId

integer

None.

ReportingUserId

string

None.

Priority

integer

None.

IsCritical

boolean

None.

Type

string

None.

IncidentNumber

string

None.

Name

string

None.

NatureOfCall

string

None.

MapPage

string

None.

Notes

string

None.

CompletedNotes

string

None.

Address

string

None.

GeoLocationData

string

None.

LoggedOn

date

None.

ClosedByUserId

string

None.

ClosedOn

date

None.

State

integer

None.

IsDeleted

boolean

None.

CallSource

integer

None.

DispatchCount

integer

None.

LastDispatchedOn

date

None.

SourceIdentifier

string

None.

Attachments

Collection of CallAttachmentInput

None.

W3W

string

None.

GroupDispatches

Collection of CallDispatchGroupInput

None.

ContactName

string

None.

ContactNumber

string

None.

Public

boolean

None.

ExternalIdentifier

string

None.

ReferenceNumber

string

None.

GroupCodesToDispatch

Collection of string

None.

AllCall

boolean

None.

Request Formats

application/json

Sample:
{
  "CallId": 1,
  "Number": "sample string 2",
  "DepartmentId": 3,
  "ReportingUserId": "sample string 4",
  "Priority": 5,
  "IsCritical": true,
  "Type": "sample string 7",
  "IncidentNumber": "sample string 8",
  "Name": "sample string 9",
  "NatureOfCall": "sample string 10",
  "MapPage": "sample string 11",
  "Notes": "sample string 12",
  "CompletedNotes": "sample string 13",
  "Address": "sample string 14",
  "GeoLocationData": "sample string 15",
  "LoggedOn": "2018-10-20T09:27:19.7218424+00:00",
  "ClosedByUserId": "sample string 17",
  "ClosedOn": "2018-10-20T09:27:19.7218424+00:00",
  "State": 18,
  "IsDeleted": true,
  "CallSource": 20,
  "DispatchCount": 21,
  "LastDispatchedOn": "2018-10-20T09:27:19.7218424+00:00",
  "SourceIdentifier": "sample string 22",
  "Attachments": [
    {
      "CallAttachmentId": 1,
      "CallId": 2,
      "CallAttachmentType": 3,
      "FileName": "sample string 4",
      "Data": "QEA=",
      "UserId": "sample string 5",
      "Timestamp": "2018-10-20T09:27:19.7218424+00:00",
      "Name": "sample string 6",
      "Size": 1,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    {
      "CallAttachmentId": 1,
      "CallId": 2,
      "CallAttachmentType": 3,
      "FileName": "sample string 4",
      "Data": "QEA=",
      "UserId": "sample string 5",
      "Timestamp": "2018-10-20T09:27:19.7218424+00:00",
      "Name": "sample string 6",
      "Size": 1,
      "Latitude": 1.0,
      "Longitude": 1.0
    }
  ],
  "W3W": "sample string 23",
  "GroupDispatches": [
    {
      "CallDispatchGroupId": 1,
      "CallId": 2,
      "DepartmentGroupId": 3,
      "DispatchCount": 4,
      "LastDispatchedOn": "2018-10-20T09:27:19.7218424+00:00"
    },
    {
      "CallDispatchGroupId": 1,
      "CallId": 2,
      "DepartmentGroupId": 3,
      "DispatchCount": 4,
      "LastDispatchedOn": "2018-10-20T09:27:19.7218424+00:00"
    }
  ],
  "ContactName": "sample string 24",
  "ContactNumber": "sample string 25",
  "Public": true,
  "ExternalIdentifier": "sample string 27",
  "ReferenceNumber": "sample string 28",
  "GroupCodesToDispatch": [
    "sample string 1",
    "sample string 2"
  ],
  "AllCall": true
}

application/xml, text/xml

Sample:
<AddCallInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Calls">
  <Address>sample string 14</Address>
  <AllCall>true</AllCall>
  <Attachments>
    <CallAttachmentInput>
      <CallAttachmentId>1</CallAttachmentId>
      <CallAttachmentType>3</CallAttachmentType>
      <CallId>2</CallId>
      <Data>QEA=</Data>
      <FileName>sample string 4</FileName>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Name>sample string 6</Name>
      <Size>1</Size>
      <Timestamp>2018-10-20T09:27:19.7218424+00:00</Timestamp>
      <UserId>sample string 5</UserId>
    </CallAttachmentInput>
    <CallAttachmentInput>
      <CallAttachmentId>1</CallAttachmentId>
      <CallAttachmentType>3</CallAttachmentType>
      <CallId>2</CallId>
      <Data>QEA=</Data>
      <FileName>sample string 4</FileName>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Name>sample string 6</Name>
      <Size>1</Size>
      <Timestamp>2018-10-20T09:27:19.7218424+00:00</Timestamp>
      <UserId>sample string 5</UserId>
    </CallAttachmentInput>
  </Attachments>
  <CallId>1</CallId>
  <CallSource>20</CallSource>
  <ClosedByUserId>sample string 17</ClosedByUserId>
  <ClosedOn>2018-10-20T09:27:19.7218424+00:00</ClosedOn>
  <CompletedNotes>sample string 13</CompletedNotes>
  <ContactName>sample string 24</ContactName>
  <ContactNumber>sample string 25</ContactNumber>
  <DepartmentId>3</DepartmentId>
  <DispatchCount>21</DispatchCount>
  <ExternalIdentifier>sample string 27</ExternalIdentifier>
  <GeoLocationData>sample string 15</GeoLocationData>
  <GroupCodesToDispatch xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </GroupCodesToDispatch>
  <GroupDispatches>
    <CallDispatchGroupInput>
      <CallDispatchGroupId>1</CallDispatchGroupId>
      <CallId>2</CallId>
      <DepartmentGroupId>3</DepartmentGroupId>
      <DispatchCount>4</DispatchCount>
      <LastDispatchedOn>2018-10-20T09:27:19.7218424+00:00</LastDispatchedOn>
    </CallDispatchGroupInput>
    <CallDispatchGroupInput>
      <CallDispatchGroupId>1</CallDispatchGroupId>
      <CallId>2</CallId>
      <DepartmentGroupId>3</DepartmentGroupId>
      <DispatchCount>4</DispatchCount>
      <LastDispatchedOn>2018-10-20T09:27:19.7218424+00:00</LastDispatchedOn>
    </CallDispatchGroupInput>
  </GroupDispatches>
  <IncidentNumber>sample string 8</IncidentNumber>
  <IsCritical>true</IsCritical>
  <IsDeleted>true</IsDeleted>
  <LastDispatchedOn>2018-10-20T09:27:19.7218424+00:00</LastDispatchedOn>
  <LoggedOn>2018-10-20T09:27:19.7218424+00:00</LoggedOn>
  <MapPage>sample string 11</MapPage>
  <Name>sample string 9</Name>
  <NatureOfCall>sample string 10</NatureOfCall>
  <Notes>sample string 12</Notes>
  <Number>sample string 2</Number>
  <Priority>5</Priority>
  <Public>true</Public>
  <ReferenceNumber>sample string 28</ReferenceNumber>
  <ReportingUserId>sample string 4</ReportingUserId>
  <SourceIdentifier>sample string 22</SourceIdentifier>
  <State>18</State>
  <Type>sample string 7</Type>
  <W3W>sample string 23</W3W>
</AddCallInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddCallInput
NameDescriptionTypeAdditional information
CallId

integer

None.

Number

string

None.

DepartmentId

integer

None.

ReportingUserId

string

None.

Priority

integer

None.

IsCritical

boolean

None.

Type

string

None.

IncidentNumber

string

None.

Name

string

None.

NatureOfCall

string

None.

MapPage

string

None.

Notes

string

None.

CompletedNotes

string

None.

Address

string

None.

GeoLocationData

string

None.

LoggedOn

date

None.

ClosedByUserId

string

None.

ClosedOn

date

None.

State

integer

None.

IsDeleted

boolean

None.

CallSource

integer

None.

DispatchCount

integer

None.

LastDispatchedOn

date

None.

SourceIdentifier

string

None.

Attachments

Collection of CallAttachmentInput

None.

W3W

string

None.

GroupDispatches

Collection of CallDispatchGroupInput

None.

ContactName

string

None.

ContactNumber

string

None.

Public

boolean

None.

ExternalIdentifier

string

None.

ReferenceNumber

string

None.

GroupCodesToDispatch

Collection of string

None.

AllCall

boolean

None.

Response Formats

application/json

Sample:
{
  "CallId": 1,
  "Number": "sample string 2",
  "DepartmentId": 3,
  "ReportingUserId": "sample string 4",
  "Priority": 5,
  "IsCritical": true,
  "Type": "sample string 7",
  "IncidentNumber": "sample string 8",
  "Name": "sample string 9",
  "NatureOfCall": "sample string 10",
  "MapPage": "sample string 11",
  "Notes": "sample string 12",
  "CompletedNotes": "sample string 13",
  "Address": "sample string 14",
  "GeoLocationData": "sample string 15",
  "LoggedOn": "2018-10-20T09:27:19.7843442+00:00",
  "ClosedByUserId": "sample string 17",
  "ClosedOn": "2018-10-20T09:27:19.7843442+00:00",
  "State": 18,
  "IsDeleted": true,
  "CallSource": 20,
  "DispatchCount": 21,
  "LastDispatchedOn": "2018-10-20T09:27:19.7843442+00:00",
  "SourceIdentifier": "sample string 22",
  "Attachments": [
    {
      "CallAttachmentId": 1,
      "CallId": 2,
      "CallAttachmentType": 3,
      "FileName": "sample string 4",
      "Data": "QEA=",
      "UserId": "sample string 5",
      "Timestamp": "2018-10-20T09:27:19.7843442+00:00",
      "Name": "sample string 6",
      "Size": 1,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    {
      "CallAttachmentId": 1,
      "CallId": 2,
      "CallAttachmentType": 3,
      "FileName": "sample string 4",
      "Data": "QEA=",
      "UserId": "sample string 5",
      "Timestamp": "2018-10-20T09:27:19.7843442+00:00",
      "Name": "sample string 6",
      "Size": 1,
      "Latitude": 1.0,
      "Longitude": 1.0
    }
  ],
  "W3W": "sample string 23",
  "GroupDispatches": [
    {
      "CallDispatchGroupId": 1,
      "CallId": 2,
      "DepartmentGroupId": 3,
      "DispatchCount": 4,
      "LastDispatchedOn": "2018-10-20T09:27:19.7843442+00:00"
    },
    {
      "CallDispatchGroupId": 1,
      "CallId": 2,
      "DepartmentGroupId": 3,
      "DispatchCount": 4,
      "LastDispatchedOn": "2018-10-20T09:27:19.7843442+00:00"
    }
  ],
  "ContactName": "sample string 24",
  "ContactNumber": "sample string 25",
  "Public": true,
  "ExternalIdentifier": "sample string 27",
  "ReferenceNumber": "sample string 28",
  "GroupCodesToDispatch": [
    "sample string 1",
    "sample string 2"
  ],
  "AllCall": true
}

application/xml, text/xml

Sample:
<AddCallInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Calls">
  <Address>sample string 14</Address>
  <AllCall>true</AllCall>
  <Attachments>
    <CallAttachmentInput>
      <CallAttachmentId>1</CallAttachmentId>
      <CallAttachmentType>3</CallAttachmentType>
      <CallId>2</CallId>
      <Data>QEA=</Data>
      <FileName>sample string 4</FileName>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Name>sample string 6</Name>
      <Size>1</Size>
      <Timestamp>2018-10-20T09:27:19.7843442+00:00</Timestamp>
      <UserId>sample string 5</UserId>
    </CallAttachmentInput>
    <CallAttachmentInput>
      <CallAttachmentId>1</CallAttachmentId>
      <CallAttachmentType>3</CallAttachmentType>
      <CallId>2</CallId>
      <Data>QEA=</Data>
      <FileName>sample string 4</FileName>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <Name>sample string 6</Name>
      <Size>1</Size>
      <Timestamp>2018-10-20T09:27:19.7843442+00:00</Timestamp>
      <UserId>sample string 5</UserId>
    </CallAttachmentInput>
  </Attachments>
  <CallId>1</CallId>
  <CallSource>20</CallSource>
  <ClosedByUserId>sample string 17</ClosedByUserId>
  <ClosedOn>2018-10-20T09:27:19.7843442+00:00</ClosedOn>
  <CompletedNotes>sample string 13</CompletedNotes>
  <ContactName>sample string 24</ContactName>
  <ContactNumber>sample string 25</ContactNumber>
  <DepartmentId>3</DepartmentId>
  <DispatchCount>21</DispatchCount>
  <ExternalIdentifier>sample string 27</ExternalIdentifier>
  <GeoLocationData>sample string 15</GeoLocationData>
  <GroupCodesToDispatch xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </GroupCodesToDispatch>
  <GroupDispatches>
    <CallDispatchGroupInput>
      <CallDispatchGroupId>1</CallDispatchGroupId>
      <CallId>2</CallId>
      <DepartmentGroupId>3</DepartmentGroupId>
      <DispatchCount>4</DispatchCount>
      <LastDispatchedOn>2018-10-20T09:27:19.7843442+00:00</LastDispatchedOn>
    </CallDispatchGroupInput>
    <CallDispatchGroupInput>
      <CallDispatchGroupId>1</CallDispatchGroupId>
      <CallId>2</CallId>
      <DepartmentGroupId>3</DepartmentGroupId>
      <DispatchCount>4</DispatchCount>
      <LastDispatchedOn>2018-10-20T09:27:19.7843442+00:00</LastDispatchedOn>
    </CallDispatchGroupInput>
  </GroupDispatches>
  <IncidentNumber>sample string 8</IncidentNumber>
  <IsCritical>true</IsCritical>
  <IsDeleted>true</IsDeleted>
  <LastDispatchedOn>2018-10-20T09:27:19.7843442+00:00</LastDispatchedOn>
  <LoggedOn>2018-10-20T09:27:19.7843442+00:00</LoggedOn>
  <MapPage>sample string 11</MapPage>
  <Name>sample string 9</Name>
  <NatureOfCall>sample string 10</NatureOfCall>
  <Notes>sample string 12</Notes>
  <Number>sample string 2</Number>
  <Priority>5</Priority>
  <Public>true</Public>
  <ReferenceNumber>sample string 28</ReferenceNumber>
  <ReportingUserId>sample string 4</ReportingUserId>
  <SourceIdentifier>sample string 22</SourceIdentifier>
  <State>18</State>
  <Type>sample string 7</Type>
  <W3W>sample string 23</W3W>
</AddCallInput>