NameDescriptionTypeAdditional information
MeasureId

The internal id of the incidental measure

globally unique identifier

Required

AppliedFrom

The date when the measure is applied

date

Required

AppliedUntil

The date when the measure is ended

date

Required

Precedence

The situation before applying the measure

string

None.

ApplicationReason

The reason why the measure is applied

string

None.

Situation

The description of the situation in which the measure is applied

string

None.

Completion

The description of how the situation with the client is completed

string

None.

MeasureResult

The result after applying the measure

string

None.

LegalContactRemarks

The remarks of the legal representative. Only used when LegalContact has value NoWithRemarks

string

None.

LegalContact

Defines if there has been contact with the legal representative

MeasureLegalContact

Required

ClientResistance

Describles if the client showed any kind of resistance applying the measure

boolean

Required

ApplierId

The internal id of the employee that has applied the measure

integer

Required

Applier

The lookupname of the employee that has applied the measure. This property is for reading purposes only

string

None.

Id

The internal id of the report

integer

Required

AggregateId

AggregateId of the report. For reading purposes only.

globally unique identifier

None.

ClientId

The internal id of the client

integer

Required

ClientName

The name of the client

string

None.

ModifiedDate

The modified date of the client report

date

None.

AvailableFor

Determines the read permission for the report. When the value is 'Disciplines', only the specified disciplines can read the report. When the value is 'Everyone', everyone can read the report. The default value is Everyone

AvailableFor

Required

AvailableForDisciplineIds

The list of disciplines ids that are allowed to read the report.

Collection of integer

None.

AvailableForDisciplineNames

The list of disciplines that are allowed to read the report. This property is for reading purposes only.

Collection of string

None.

AvailableForDisciplineGroupIds

The list of disciplinegroups ids that are allowed to read the report.

Collection of integer

None.

AvailableForDisciplineGroupNames

The list of disciplinegroups that are allowed to read the report. This property is for reading purposes only.

Collection of string

None.

Subject

The subject of the client report.

string

Conditional Required: Only required for 'General' client report type

Date

The date of the client report.

date

Required

Priority

The priority of the report.

boolean

Required

PriorityText

The priority of the client report. This property is for reading purposes only.

string

None.

EmployeeId

The internal id of employee. This property is for reading purposes only. EmployeeId of the provided token will be used when creating a new ClientReport.

integer

Required

EmployeeName

The original creator of the client report. This property is for reading purposes only.

string

None.

ShiftId

The internal id of the shift.

integer

Required

Shift

The shift of the client report. This property is for reading purposes only.

string

None.

DisciplineId

The internal id of the discipline.

integer

Required

Discipline

The discipline of the client report. This property is for reading purposes only.

string

None.

TypeDescription

The type of the client report. This property is for reading purposes only.

string

None.

ReportTags

The tags of the client report.

Collection of ReportTag

None.

ReportTagsText

The tags of the client report formatted in a string. This property is for reading purposes only.

string

None.

AttributeIds

The list of selected attribute id's.

Collection of integer

Deprecated: Please use 'ReportTags' instead.

Attributes

The attributes of the client report. This property is for reading purposes only.

string

Deprecated: Please use 'ReportTagsText' instead.

ParentId

The internal id of the parent client report on which this client report is based.

integer

None.

ChildReports

The child reports of the client report.

Collection of ClientReport

None.

ContactTypeId

References to a Choice of ChoiceType 'CONTACTTYPE'.

integer

None.