GET PlanCare2Api/Call?dateIncidentFrom={dateIncidentFrom}&dateIncidentUntil={dateIncidentUntil}&clientId={clientId}

Gets calls.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

Request Information

URI Parameters

Name Description Type Additional information
dateIncidentFrom

Filter DateIncident from.

date

Nullable

dateIncidentUntil

Filter DateIncident until.

date

Nullable

clientId

Id of client.

integer

Nullable

Body Parameters

None.

Response Information

Resource Description

List of calls.

Collection of CallSummary
Name Description Type Additional information
Id

Identification

integer

-

CallTypeName

Name of the type of the call

string

-

CallTypeCategoryName

Name of the category of the call

string

-

CreatedBy

CreatedBy

string

-

ReportedBy

ReportedBy

string

-

DateCreated

Date of creation

date

-

DateIncident

Date of incident

date

-

DateReadyForSuccession

Date of ready for succession

date

Nullable

Important

Indicates if call is marked as important

boolean

-

Location

Location

string

-

AlertInfo

Info for alert

string

-

Status

Status of the call

CallStatus

-

SuccessorInfo

Info for successor

string

-

Clients

List of the involved clients

Collection of CallClient

-

Employees

List of the involved employees

Collection of CallEmployee

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Id": 1,
    "CallTypeName": "sample string 2",
    "CallTypeCategoryName": "sample string 3",
    "CreatedBy": "sample string 4",
    "ReportedBy": "sample string 5",
    "DateCreated": "2026-05-26T22:07:18.9905875+02:00",
    "DateIncident": "2026-05-26T22:07:18.9905875+02:00",
    "DateReadyForSuccession": "2026-05-26T22:07:18.9905875+02:00",
    "Important": true,
    "Location": "sample string 9",
    "AlertInfo": "sample string 10",
    "Status": 1,
    "SuccessorInfo": "sample string 11",
    "Clients": [
      {
        "$id": "2",
        "RelationId": 1,
        "LookupName": "sample string 2",
        "DateOfBirth": "2026-05-26T22:07:18.9905875+02:00"
      },
      {
        "$ref": "2"
      }
    ],
    "Employees": [
      {
        "$id": "3",
        "RelationId": 1,
        "LookupName": "sample string 2",
        "DateOfBirth": "2026-05-26T22:07:18.9905875+02:00"
      },
      {
        "$ref": "3"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCallSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Call">
  <CallSummary>
    <AlertInfo>sample string 10</AlertInfo>
    <CallTypeCategoryName>sample string 3</CallTypeCategoryName>
    <CallTypeName>sample string 2</CallTypeName>
    <Clients>
      <CallClient>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallClient>
      <CallClient>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallClient>
    </Clients>
    <CreatedBy>sample string 4</CreatedBy>
    <DateCreated>2026-05-26T22:07:18.9905875+02:00</DateCreated>
    <DateIncident>2026-05-26T22:07:18.9905875+02:00</DateIncident>
    <DateReadyForSuccession>2026-05-26T22:07:18.9905875+02:00</DateReadyForSuccession>
    <Employees>
      <CallEmployee>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallEmployee>
      <CallEmployee>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallEmployee>
    </Employees>
    <Id>1</Id>
    <Important>true</Important>
    <Location>sample string 9</Location>
    <ReportedBy>sample string 5</ReportedBy>
    <Status>Unsent</Status>
    <SuccessorInfo>sample string 11</SuccessorInfo>
  </CallSummary>
  <CallSummary>
    <AlertInfo>sample string 10</AlertInfo>
    <CallTypeCategoryName>sample string 3</CallTypeCategoryName>
    <CallTypeName>sample string 2</CallTypeName>
    <Clients>
      <CallClient>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallClient>
      <CallClient>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallClient>
    </Clients>
    <CreatedBy>sample string 4</CreatedBy>
    <DateCreated>2026-05-26T22:07:18.9905875+02:00</DateCreated>
    <DateIncident>2026-05-26T22:07:18.9905875+02:00</DateIncident>
    <DateReadyForSuccession>2026-05-26T22:07:18.9905875+02:00</DateReadyForSuccession>
    <Employees>
      <CallEmployee>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallEmployee>
      <CallEmployee>
        <DateOfBirth>2026-05-26T22:07:18.9905875+02:00</DateOfBirth>
        <LookupName>sample string 2</LookupName>
        <RelationId>1</RelationId>
      </CallEmployee>
    </Employees>
    <Id>1</Id>
    <Important>true</Important>
    <Location>sample string 9</Location>
    <ReportedBy>sample string 5</ReportedBy>
    <Status>Unsent</Status>
    <SuccessorInfo>sample string 11</SuccessorInfo>
  </CallSummary>
</ArrayOfCallSummary>