Administrators
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 administrators in the system.
URI
/api/v9/administratorsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/administrators | C | GET, HEAD | List all administrators in the system |
/api/v9/administrators/ID | R | GET, HEAD | Get information about an administrator |
GET List administrators
List administrator accounts in the system along with basic data.
Syntax
GET /api/v9/administrators
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"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
X-Count | 15 | Number of registered administrators |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of administrators was successfully returned |
Example response
Response
{
"10001": {
"id": 10001,
"name": "John Smith",
"email": "j.smith@example.com",
"phone": "+32 472 85 1234",
"function": "Admissions administrator",
"roles": [
{
"id": 2,
"name": "Admissions administrator"
},
{
"id": 7,
"name": "Courses administrator"
}
]
},
"10002": {
"id": 10002,
"name": "Amanda Jones",
"email": "a.jones@example.com",
"phone": "+32 472 85 1234",
"function": "Content administrator",
"roles": [
{
"id": 6,
"name": "Content administrator"
}
]
},
"10003": {
"id": 10003,
"name": "James Weber",
"email": "j.weber@example.com",
"phone": "+32 472 85 1234",
"function": null,
"roles": [
{
"id": 1,
"name": "Superuser (all permissions)"
}
]
}
}