Offers

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a list of offers in the ranking list.

URI
/api/v10/rankings/ID/offers

GET List offers

List all offers in a specific ranking list.

This API request returns the data for each offer along with the detailed scoring parameters. The offers in the response are presented in the descending order, with top-ranking offers at the top.

This request is supported in API version 10 and later.

Syntax
GET /api/v10/rankings/123/offers
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/rankings/123/offers"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonThe media type of the resource
Content-Length1234The size of the response body in bytes
X-Count2The number of offers in the ranking list

Response codes

Response codeDescription
200 OKThe collection of offers was successfully returned

Response fields

Field Show all
id integer

The ID of the offer created for the application.

priority integer

The ID of the priority linked to the offer.

inserted string (ISO 8601)

The date and time when the offer was initially created (the application was submitted).

saved string (ISO 8601)

The date and time of the most recent update to the offer.

confirmed string (ISO 8601)

The date and time when the offer was confirmed.

applicant string (URI)

The URI of the applicant for whom the offer is created.

application string (URI)

The URI of the application for which the offer is created.

course string (URI)

The URI of the course for which the offer was created.

intake string (URI)

The URI of the intake period for which the offer was created.

comments string

The body of the offer letter saved in the system.

comments-confirmed string

The body of the offer letter confirmed and sent to the applicant.

decision string

The applicant’s decision regarding the offer: Final, Declined, None.

decision-policy string

The offer decision policy: Required, Advisory, None.

decision-deadline string (Date)

The final date by which the applicant must respond to the offer.

decided string (ISO 8601)

The date and time when the final decision was recorded.

score object

The root container for scoring and calculation data.

points float

The final total score calculated based on the root evaluation criterion assigned to the course. The root evaluation criterion can aggregate several scoresheets and sub-criteria.

extra integer

Additional points added to the offer by an Administrator.

explanation object

A detailed audit trail that explains the logic used to calculate the final total score.

id integer

The explanation object ID.

points object

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.
formula string | null

The formula used to calculate the final score. This value is only available if the aggregation field is set to Formula.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula had a division by zero or null-reference error.
explanans object | array

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

conversion object

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

aggregation string

The method used to combine values, for example, Sum, Highest or Formula.

nullReference boolean

Indicates a null-reference error. This field is only used if the aggregation field is set to Formula.

divisionByZero boolean

Indicates the division by zero error. This field is only used if the aggregation field is set to Formula.

A detailed audit trail that explains the logic used to calculate the final total score.

id integer

The explanation object ID.

points object

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.
formula string | null

The formula used to calculate the final score. This value is only available if the aggregation field is set to Formula.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula had a division by zero or null-reference error.
explanans object | array

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

conversion object

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

aggregation string

The method used to combine values, for example, Sum, Highest or Formula.

nullReference boolean

Indicates a null-reference error. This field is only used if the aggregation field is set to Formula.

divisionByZero boolean

Indicates the division by zero error. This field is only used if the aggregation field is set to Formula.

The root container for scoring and calculation data.

points float

The final total score calculated based on the root evaluation criterion assigned to the course. The root evaluation criterion can aggregate several scoresheets and sub-criteria.

extra integer

Additional points added to the offer by an Administrator.

explanation object

A detailed audit trail that explains the logic used to calculate the final total score.

id integer

The explanation object ID.

points object

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.
formula string | null

The formula used to calculate the final score. This value is only available if the aggregation field is set to Formula.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula had a division by zero or null-reference error.
explanans object | array

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

conversion object

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

aggregation string

The method used to combine values, for example, Sum, Highest or Formula.

nullReference boolean

Indicates a null-reference error. This field is only used if the aggregation field is set to Formula.

divisionByZero boolean

Indicates the division by zero error. This field is only used if the aggregation field is set to Formula.

A detailed audit trail that explains the logic used to calculate the final total score.

id integer

The explanation object ID.

points object

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.

The root container for point-related data.

aggregated float | null

The actual aggregation result for the evaluation criterion, for example, the sum, latest of all inputs or formula calculation.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula contained a division by zero or null-reference error.
converted float | boolean | null

Indicates if the points were converted to be applied to the final score.

  • If the points were converted, this field contains the conversion result.

  • If the points were not converted, this field is set to false.

  • The field is set to null if the calculation fails for any of the following reasons:

    • The lookup was outside the prescribed ranges, and the conversion was set to hold instead of capping the score.
    • The conversion formula resulted in a division by zero.
formula string | null

The formula used to calculate the final score. This value is only available if the aggregation field is set to Formula.

The field may contain null if the calculation has failed for the following reasons:

  • One of the criterion inputs was not valid.
  • There were no inputs to aggregate.
  • The aggregation formula had a division by zero or null-reference error.
explanans object | array

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

A single input or list of inputs selected for the criterion.

[item] object

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

An individual input contributing to the final score calculation.

type string

The input type: Scoresheet or Criterion.

id integer

The input ID.

points float | null

The number of points assigned through a scoresheet or criterion.

The field may contain null in the following cases:

  • The application was not added to the scoresheet.
  • The application was added to the scoresheet but the score was not set.
  • The score does not meet the required threshold.

In the above cases, the input is set to zeroed:false and valid:false.

If the criterion is set to consider the score as zero, the input may have points:0, valid:true and zeroed:true even if the data is technically missing or invalid.

valid boolean

Indicates whether the calculation was successful.

  • If any input has valid:false, the entire calculation tree holds off and stops immediately.
  • If the parent criterion is set to ignore the scoresheet/criterion, the input may have points:null but still be valid:true.
zeroed boolean

Indicates that the score was considered as zero to report an error or handle an error case. See the points field description.

capped boolean

Indicates that the input did not meet the required threshold set for the criterion.

weight integer

The multiplier applied to the points before they are passed to the parent aggregation.

tstamp string (ISO 8601) | null

The score timestamp:

  • For scoresheets: the timestamp of when the score was entered
  • For criteria: null
sub object

Only present for type Criterion. Contains a recursive explanation object that expands on the parent explanans. Represents a complete nested calculation tree for a sub-criterion with its own fields, such as explanans, aggregation and other.

conversion object

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

The conversion rule applied to the final calculation

id string | null

The conversion rule ID.

aggregation string

The method used to combine values, for example, Sum, Highest or Formula.

nullReference boolean

Indicates a null-reference error. This field is only used if the aggregation field is set to Formula.

divisionByZero boolean

Indicates the division by zero error. This field is only used if the aggregation field is set to Formula.

scored string (ISO 8601)

The date and time when the most recent scoring calculation was performed.

notes string

Notes added to the offer.

subject string

The subject line of the offer letter.

type string (URI)

The most recent offer type saved in the system.

type-confirmed string (URI)

The most recent offer type confirmed and sent to the applicant.

offer-reason string

The reason for the offer as selected by an Administrator.

id integer

The offer reason ID.

reason string

The offer reason description.

The reason for the offer as selected by an Administrator.

id integer

The offer reason ID.

reason string

The offer reason description.

Example response

Response
{
  "100": {
    "id": 100,
    "priority": 1,
    "inserted": "2026-04-22T12:12:39+00:00",
    "saved": "2026-05-11T07:12:25+00:00",
    "confirmed": "2026-05-11T07:12:25+00:00",
    "applicant": "/api/v10/applicants/123",
    "application": "/api/v10/applications/321",
    "course": "/api/v10/courses/16",
    "intake": "/api/v10/intakes/9",
    "comments": "Dear Emily Williams,\r\n\r\nYou have received a conditionally accepted offer from School of Engineering and Technology regarding [BSc] Data Structures and Algorithms\r\n\r\n\r\n\r\nInstitute of Technology\r\n\r\nOlga DreamApply\r\n\r\n- - - - - - - - - - - -\r\nPlease do not reply to this message.",
    "comments-confirmed": "Dear Emily Williams,\r\n\r\nYou have received a conditionally accepted offer from School of Engineering and Technology regarding [BSc] Data Structures and Algorithms\r\n\r\n\r\n\r\nInstitute of Technology\r\n\r\nOlga DreamApply\r\n\r\n- - - - - - - - - - - -\r\nPlease do not reply to this message.",
    "decision": "None",
    "decision-policy": "Advisory",
    "decision-deadline": "2026-05-18",
    "decided": "2026-05-11T07:12:25+00:00",
    "score": {
      "points": 44,
      "extra": 2,
      "explanation": {
        "id": 13,
        "points": {
          "converted": false,
          "aggregated": 44
        },
        "formula": "Scoresheet13 + Scoresheet9",
        "explanans": [
          {
            "type": "Scoresheet",
            "id": 13,
            "points": 8,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 2,
            "tstamp": "2026-04-23T10:52:22+00:00"
          },
          {
            "type": "Scoresheet",
            "id": 1,
            "points": 10,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 2,
            "tstamp": "2026-04-23T10:49:44+00:00"
          },
          {
            "type": "Criterion",
            "id": 4,
            "points": null,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 1,
            "tstamp": null,
            "sub": {
              "id": 4,
              "points": {
                "converted": false,
                "aggregated": null
              },
              "explanans": [
                {
                  "type": "Scoresheet",
                  "id": 9,
                  "points": null,
                  "valid": true,
                  "zeroed": false,
                  "capped": false,
                  "weight": 1,
                  "tstamp": null
                }
              ],
              "conversion": {
                "id": null
              },
              "aggregation": "Sum",
              "nullReference": false,
              "divisionByZero": false
            }
          },
          {
            "type": "Criterion",
            "id": 3,
            "points": 8,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 1,
            "tstamp": null,
            "sub": {
              "id": 3,
              "points": {
                "converted": 8,
                "aggregated": 110
              },
              "formula": "Scoresheet13 + Scoresheet9/3",
              "explanans": [
                {
                  "type": "Scoresheet",
                  "id": 4,
                  "points": 110,
                  "valid": true,
                  "zeroed": false,
                  "capped": false,
                  "weight": 1,
                  "tstamp": "2026-04-23T10:52:03+00:00"
                }
              ],
              "conversion": {
                "id": 5
              },
              "aggregation": "Latest",
              "nullReference": false,
              "divisionByZero": false
            }
          }
        ],
        "conversion": {
          "id": null
        },
        "aggregation": "Sum",
        "nullReference": false,
        "divisionByZero": false
      }
    },
    "scored": "2026-05-18T13:04:28+00:00",
    "notes": null,
    "subject": "Reply Conditionally accepted from Institute of Technology / School of Engineering and Technology",
    "type": "/api/v10/applications/offers/types/18",
    "type-confirmed": "/api/v10/applications/offers/types/18",
    "type-reason": {
      "id": null,
      "reason": null
    }
  },
  "102": {
    "id": 102,
    "priority": 2,
    "inserted": "2026-04-22T12:12:39+00:00",
    "saved": "2026-05-11T07:12:20+00:00",
    "confirmed": "2026-05-11T07:12:20+00:00",
    "applicant": "/api/v10/applicants/124",
    "application": "/api/v10/applications/322",
    "course": "/api/v10/courses/20",
    "intake": null,
    "comments": "Dear John Smith,\r\n\r\nYou have received positive feedback from School of Applied Science regarding [BSc] Mathematical Modeling\r\n\r\n\r\n\r\nInstitute of Technology\r\n\r\nOlga DreamApply\r\n\r\n- - - - - - - - - - - -\r\nPlease do not reply to this message.",
    "comments-confirmed": "Dear John Smith,\r\n\r\nYou have received positive feedback from School of Applied Science regarding [BSc] Mathematical Modeling\r\n\r\n\r\n\r\nInstitute of Technology\r\n\r\nOlga DreamApply\r\n\r\n- - - - - - - - - - - -\r\nPlease do not reply to this message.",
    "decision": "Declined",
    "decision-policy": "None",
    "decision-deadline": null,
    "decided": "2026-05-15T11:16:11+00:00",
    "score": {
      "points": 44,
      "extra": null,
      "explanation": {
        "id": 13,
        "points": {
          "converted": false,
          "aggregated": 44
        },
        "formula": "Scoresheet13 + Scoresheet9",
        "explanans": [
          {
            "type": "Scoresheet",
            "id": 13,
            "points": 8,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 2,
            "tstamp": "2026-04-23T10:52:22+00:00"
          },
          {
            "type": "Scoresheet",
            "id": 1,
            "points": 10,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 2,
            "tstamp": "2026-04-23T10:49:44+00:00"
          },
          {
            "type": "Criterion",
            "id": 4,
            "points": null,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 1,
            "tstamp": null,
            "sub": {
              "id": 4,
              "points": {
                "converted": false,
                "aggregated": null
              },
              "explanans": [
                {
                  "type": "Scoresheet",
                  "id": 9,
                  "points": null,
                  "valid": true,
                  "zeroed": false,
                  "capped": false,
                  "weight": 1,
                  "tstamp": null
                }
              ],
              "conversion": {
                "id": null
              },
              "aggregation": "Sum",
              "nullReference": false,
              "divisionByZero": false
            }
          },
          {
            "type": "Criterion",
            "id": 3,
            "points": 8,
            "valid": true,
            "zeroed": false,
            "capped": false,
            "weight": 1,
            "tstamp": null,
            "sub": {
              "id": 3,
              "points": {
                "converted": 8,
                "aggregated": 110
              },
              "formula": "Scoresheet13 + Scoresheet9/3",
              "explanans": [
                {
                  "type": "Scoresheet",
                  "id": 4,
                  "points": 110,
                  "valid": true,
                  "zeroed": false,
                  "capped": false,
                  "weight": 1,
                  "tstamp": "2026-04-23T10:52:03+00:00"
                }
              ],
              "conversion": {
                "id": 5
              },
              "aggregation": "Latest",
              "nullReference": false,
              "divisionByZero": false
            }
          }
        ],
        "conversion": {
          "id": null
        },
        "aggregation": "Sum",
        "nullReference": false,
        "divisionByZero": false
      }
    },
    "scored": "2026-05-18T13:04:28+00:00",
    "notes": null,
    "subject": "Reply Positive feedback from Institute of Technology / School of Applied Science",
    "type": "/api/v10/applications/offers/types/8",
    "type-confirmed": "/api/v10/applications/offers/types/8",
    "type-reason": {
      "id": null,
      "reason": null
    }
  }
}

See Also

Previous

Ranking