GET Forms/Score

Get scores

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeActive

Include records where RecordState == RecordState.Active

boolean

None.

IncludeInactive

Include records where RecordState == RecordState.Inactive

boolean

None.

IncludeDeleted

Include records where RecordState == RecordState.Deleted

boolean

None.

Match

When searching by string, include records based on match type

MatchCriteriaStringType

None.

FormScoreIDs

Filter by FormScoreIDs

Collection of integer

None.

FormID

Filter by FormID

integer

None.

ClientID

integer

None.

ScoreName

Filter by ScoreName

string

None.

DataType

Filter by DataType

FormScoreDataType

None.

Caption

Filter by Caption

string

None.

ScoreGroup

Filter by ScoreGroup

string

None.

SortOrder

Filter by SortOrder

integer

None.

CalculationSortOrder

Filter by CalculationSortOrder

integer

None.

Tips

Filter by Tips

string

None.

Props

Filter by Props

Collection of Object

None.

CreatedDateUtcMin

Filter by CreatedDateUtcMin

date

None.

CreatedDateUtcMax

Filter by CreatedDateUtcMax

date

None.

LastUpdatedDateUtcMin

Filter by LastUpdatedDateUtcMin

date

None.

LastUpdatedDateUtcMax

Filter by LastUpdatedDateUtcMax

date

None.

Body Parameters

None.

Response Information

Resource Description

List of FormScoreDTOs

Collection of FormScoreDto
NameDescriptionTypeAdditional information
FormScoreID

integer

None.

FormID

integer

None.

ScoreName

string

None.

DataType

FormScoreDataType

None.

Caption

string

None.

ScoreGroup

string

None.

SortOrder

integer

None.

CalculationSortOrder

integer

None.

Tips

string

None.

Ranges

Collection of FormScoreRangeDto

None.

CalculateScript

string

None.

FormEntryScore

FormEntryScoreDto

None.

Props

Collection of Object

None.

Result

FormScoreResultDto

None.

ResultSummary

string

None.

RecordState

FormRecordState

None.

IsPartialData

boolean

None.

Created

FormAuditDataDto

None.

LastUpdated

FormAuditDataDto

None.