Get scoring point totals filtered and paged

paging.pageSize

integer

No

Maximum number of entries to return per page. Defaults to 100 when not given. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number to retrieve. Defaults to 1 when not given. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on, for example realEstateObjectReference.

sorting.order

integer

No

Sort direction for columnName. 0 sorts ascending, 1 sorts descending.

filter.reference

string

No

Filters results on the internal reference of the scoring point total entry.

filter.externalIdentifier

string

No

Filters results on the external identifier of the scoring point total entry.

filter.realEstateObjectReference

string

No

Filters results on the reference of the real estate object the entry applies to.

filter.homeType

integer

No

Filters results on the home type. Valid values are 1 (Independent), for self-contained living space, and 2 (Dependent), for non-self-contained living space.

filter.timePeriodTitle

string

No

Filters results on the time period title of the entry.

filter.pointTotal.from

integer

No

Minimum total scoring points to include in the selection.

filter.pointTotal.to

integer

No

Maximum total scoring points to include in the selection.

filter.finalPrice.from

number (double)

No

Minimum maximum-rent price to include in the selection.

filter.finalPrice.to

number (double)

No

Maximum maximum-rent price to include in the selection.

paging.pageSize

integer

No

Page size used for this result set. Minimum 1, maximum 1000.

paging.pageNumber

integer

No

Page number returned in this result set. Minimum 1, maximum 9999.

sorting.columnName

string

No

Field the results are sorted on.

sorting.order

integer

No

Sort direction for columnName. 0 is ascending, 1 is descending.

scoringPointTotals

array of object

No

The list of scoring point totals matching the filter, for the requested page. Empty or omitted when no entries match.

scoringPointTotals.reference

string

No

Internal identifier of the scoring point total entry.

scoringPointTotals.externalIdentifier

string

No

External identifier of the scoring point total entry.

scoringPointTotals.realEstateObjectReference

string

No

Reference of the real estate object the entry applies to.

scoringPointTotals.homeType

integer

Yes

Type of home the scoring points apply to. Valid values are 1 (Independent), for self-contained living space, and 2 (Dependent), for non-self-contained living space.

scoringPointTotals.timePeriodTitle

string

No

Title of the time period the entry applies to.

scoringPointTotals.pointTotal

integer

Yes

Total scoring points for this time period.

scoringPointTotals.finalPrice

number (double)

Yes

Maximum rent price associated with the total scoring points for this time period.