Fees
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a list of all available fees.
URI
/api/v9/feesView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/fees | C | GET, HEAD | List all available fees |
/api/v9/fees/ID/ | R | GET, HEAD | Get detailed information about a fee |
/api/v9/fees/ID/amounts | C | GET, HEAD | List fee amounts configured for different territories |
/api/v9/fees/ID/amounts/TerritoryName | C | GET, HEAD | Get a fee amount configured for a specific territory |
GET List fees
List fees set up in the system.
Syntax
GET /api/v9/fees
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"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
X-Count | 3 | Number of available fees |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of fees was successfully returned |
Example response
Response
{
"1": {
"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"
}
}
},
"2": {
"name": "Application fee",
"type": "Appfee",
"notes": "A one-time non-refundable charge required to process and review an applicant's submission to an institution",
"amounts": {
"001": {
"qualifier": null,
"currency": "EUR",
"amount": "20.00",
"basis": "One-time",
"info": ""
},
"EE": {
"qualifier": null,
"currency": "EUR",
"amount": "10.00",
"basis": "One-time",
"info": "Special price for applicants from Estonia :)"
},
"EU": {
"qualifier": null,
"currency": "EUR",
"amount": "15.00",
"basis": "One-time",
"info": "Additional information may be specified here"
}
}
}
}