Administrator
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 single administrator in the system.
URI
/api/v9/administrators/IDGET Get an administrator
Retrieve the administrator data.
Syntax
GET /api/v9/administrators/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/administrators/123"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 administrator data was successfully returned |
404 Not Found | The admin was not found |
Example response
Response
{
"id": 10001,
"name": "John Smith",
"email": "j.smith@email.com",
"phone": "+32 472 85 1234",
"function": "Admissions administrator"
"roles": [
{
"id": 2,
"name": "Admissions administrator"
},
{
"id": 7,
"name": "Courses administrator"
}
]
}