Score on DreamApply Knowledge Base

Points

Mon, 01 Jan 0001 00:00:00 +0000

Represents the points of the scoresheet score.

URI

/api/v9/scoresheets/ID/scores/ID/points

Get points

A request with the GET verb returns the score’s points as JSON encoded string (or null, if there are no points set). Note that 0 points is returned as “0” as it is a perfectly valid number of points.

Syntax

GET /api/v9/scoresheets/123/scores/321/points
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/v9/scoresheets/123/scores/321/points"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The points value was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"90.00"

Set points

Set the points of a scoresheet score to a particular value. This will still run all validation checks and will not permit illegal point values to be entered that fall out of the accepted range as set in the scoresheet settings. If setting mapped values (for example if 5 = Excellent), the numeric value must be sent.

Comments

Mon, 01 Jan 0001 00:00:00 +0000

Represents the comments for the scoresheet score.

URI

/api/v9/scoresheets/ID/scores/ID/comments

Get comments

A request with the GET verb returns the score’s comments as JSON encoded string (or null, if there are no comments stored).

Syntax

GET /api/v9/scoresheets/123/score/321/comments
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/v9/scoresheets/123/scores/321/comments"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The comments were successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"Some comments"

Add comments

Set the comments of a scoresheet score to a particular text.

Date

Mon, 01 Jan 0001 00:00:00 +0000

Represents the date of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/date

Get the date

A request with the GET verb returns the score’s date as a JSON encoded string (or null, if there is no date stored).

Syntax

GET /api/v9/scoresheets/123/score/321/date
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/v9/scoresheets/123/scores/321/date"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The date was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"2025-01-30"

Set the date

Set the date of a scoresheet score to a particular value.

Language

Mon, 01 Jan 0001 00:00:00 +0000

Represents the language of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/language

Get the language

A request with the GET verb returns the score’s language code as JSON encoded string (or null, if there is no language stored).

Syntax

GET /api/v9/scoresheets/123/score/321/language
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/v9/scoresheets/123/scores/321/language"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The language was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"en"

Set the language

Set the language of a scoresheet score to a particular value.

Reference

Mon, 01 Jan 0001 00:00:00 +0000

Represents the reference of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/reference

Get the reference

A request with the GET verb returns the score’s reference metadata as JSON encoded string (or null, if there is no reference stored).

Syntax

GET /api/v9/scoresheets/123/score/321/reference
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/v9/scoresheets/123/scores/321/reference"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The reference was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"Diploma nr. 789"

Set the reference

Set the reference of a scoresheet score to a particular value.

Subject

Mon, 01 Jan 0001 00:00:00 +0000

Represents the subject of the scoresheet score.

URI

/api/v9/scoresheets/ID/score/ID/subject

Get the subject

A request with the GET verb returns the score’s subject metadata as JSON encoded string (or null, if there is no subject stored).

Syntax

GET /api/v9/scoresheets/123/score/321/subject
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/v9/scoresheets/123/scores/321/subject"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	Media type of the resource
`Content-Length`	`1234`	Size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The subject was successfully returned
`404 Not Found`	The scoresheet does not have this score

Example response

Response

"Mathematics"

Set the subject

Set the subject of a scoresheet score to a particular value.

Score on DreamApply Knowledge Base

Points

GET Get points

Example request

Response headers

Response codes

Example response

PUT Set points

Comments

GET Get comments

Example request

Response headers

Response codes

Example response

PUT Add comments

Date

GET Get the date

Example request

Response headers

Response codes

Example response

PUT Set the date

Language

GET Get the language

Example request

Response headers

Response codes

Example response

PUT Set the language

Reference

GET Get the reference

Example request

Response headers

Response codes

Example response

PUT Set the reference

Subject

GET Get the subject

Example request

Response headers

Response codes

Example response

PUT Set the subject

Get points

Set points

Get comments

Add comments

Get the date

Set the date

Get the language

Set the language

Get the reference

Set the reference

Get the subject

Set the subject