GET PlanCare2Api/Call/{id}

Gets call by id.

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

Request Information

URI Parameters

Name Description Type Additional information
id

The id of the call.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Call

Call
Name Description Type Additional information
Id

Identification of the call

integer

-

CallTypeGuid

Identification of the type of the call

globally unique identifier

-

DateIncident

Date of incident

date

-

ReportedByRelationId

Id of relation by whom reported the call, 'null' if reported anonymous

integer

Nullable

ReportedBy

LookupName of relation by whom reported the call, '[Anoniem]' if reported anonymous, '[Verborgen]' if reporter hidden

string

-

Important

Indicates if call is marked as important

boolean

-

LocationOrganizationEntityId

Id of organization-entity for the location

integer

Nullable

LocationOrganizationEntityName

The name of the organization-entity for the location

string

-

LocationAlternative

Alternative location if LocationOrganizationEntityId is not set

string

-

ClientIds

List of ids of clients involved

Collection of integer

-

Clients

Additional data for ClientIds.

Collection of CallClient

-

EmployeeIds

List of ids of employees involved

Collection of integer

-

Employees

Additional data for EmployeeIds.

Collection of CallEmployee

-

FilledQuestionnaireId

FilledQuestionnaireId

integer

Nullable

Successors

Successors

Collection of CallSuccessor

-

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "CallTypeGuid": "8a8efcf4-9d18-4301-b833-30b8cd35f503",
  "DateIncident": "2026-05-26T23:13:15.0719968+02:00",
  "ReportedByRelationId": 1,
  "ReportedBy": "sample string 4",
  "Important": true,
  "LocationOrganizationEntityId": 1,
  "LocationOrganizationEntityName": "sample string 6",
  "LocationAlternative": "sample string 7",
  "ClientIds": [
    1,
    2
  ],
  "Clients": [
    {
      "$id": "2",
      "RelationId": 1,
      "LookupName": "sample string 2",
      "DateOfBirth": "2026-05-26T23:13:15.0719968+02:00"
    },
    {
      "$ref": "2"
    }
  ],
  "EmployeeIds": [
    1,
    2
  ],
  "Employees": [
    {
      "$id": "3",
      "RelationId": 1,
      "LookupName": "sample string 2",
      "DateOfBirth": "2026-05-26T23:13:15.0719968+02:00"
    },
    {
      "$ref": "3"
    }
  ],
  "FilledQuestionnaireId": 1,
  "Successors": [
    {
      "$id": "4",
      "AccessDisciplineId": 1,
      "RelationId": 2
    },
    {
      "$ref": "4"
    }
  ]
}

application/xml, text/xml

Sample:
<Call xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Call">
  <CallTypeGuid>8a8efcf4-9d18-4301-b833-30b8cd35f503</CallTypeGuid>
  <ClientIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ClientIds>
  <Clients>
    <CallClient>
      <DateOfBirth>2026-05-26T23:13:15.0719968+02:00</DateOfBirth>
      <LookupName>sample string 2</LookupName>
      <RelationId>1</RelationId>
    </CallClient>
    <CallClient>
      <DateOfBirth>2026-05-26T23:13:15.0719968+02:00</DateOfBirth>
      <LookupName>sample string 2</LookupName>
      <RelationId>1</RelationId>
    </CallClient>
  </Clients>
  <DateIncident>2026-05-26T23:13:15.0719968+02:00</DateIncident>
  <EmployeeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </EmployeeIds>
  <Employees>
    <CallEmployee>
      <DateOfBirth>2026-05-26T23:13:15.0719968+02:00</DateOfBirth>
      <LookupName>sample string 2</LookupName>
      <RelationId>1</RelationId>
    </CallEmployee>
    <CallEmployee>
      <DateOfBirth>2026-05-26T23:13:15.0719968+02:00</DateOfBirth>
      <LookupName>sample string 2</LookupName>
      <RelationId>1</RelationId>
    </CallEmployee>
  </Employees>
  <FilledQuestionnaireId>1</FilledQuestionnaireId>
  <Id>1</Id>
  <Important>true</Important>
  <LocationAlternative>sample string 7</LocationAlternative>
  <LocationOrganizationEntityId>1</LocationOrganizationEntityId>
  <LocationOrganizationEntityName>sample string 6</LocationOrganizationEntityName>
  <ReportedBy>sample string 4</ReportedBy>
  <ReportedByRelationId>1</ReportedByRelationId>
  <Successors>
    <CallSuccessor>
      <AccessDisciplineId>1</AccessDisciplineId>
      <RelationId>2</RelationId>
    </CallSuccessor>
    <CallSuccessor>
      <AccessDisciplineId>1</AccessDisciplineId>
      <RelationId>2</RelationId>
    </CallSuccessor>
  </Successors>
</Call>