Fee

Represents a single fee.

URI
/api/v9/fees/ID

GET Get a fee

Return information about a fee identified by the fee ID.

Syntax
GET /api/v9/fees/123
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/fees/123"

Response headers

HeaderValueDescription
Content-Typeapplication/jsonMedia type of the resource

Response codes

Response codeDescription
200 OKThe fee data was successfully returned
404 Not FoundThe fee was not found

Example response

Response
{
  "name": "Tuition fee",
  "type": "Tuition",
  "notes": null,
  "amounts": {
    "001": {
      "qualifier": null,
      "currency": "EUR",
      "amount": "1100.00",
      "basis": "Year",
      "info": ""
    },
    "EE": {
      "qualifier": null,
      "currency": "EUR",
      "amount": "99.00",
      "basis": "Year",
      "info": "Special price for applicants from Estonia :)"
    },
    "EU": {
      "qualifier": null,
      "currency": "EUR",
      "amount": "123.00",
      "basis": "Year",
      "info": "Additional information may be specified here"
    }
  }
}