Auditories
The Auditories
controller provides the following endpoints:
/api/v2/Auditories/GetAll
/api/v2/Auditories/Get/{id}
/api/v2/Auditories/GetByName?name={name}
/api/v2/Auditories/Buildings/GetAll
/api/v2/Auditories/Buildings/Get/{id}
/api/v2/Auditories/Buildings/GetByName?name={name}
GetAll
Gets all auditories. Returns a list of Auditory
objects.
Auditory object:
{
"id": integer,
"name": "string",
"floor": integer,
"hasPower": boolean,
"auditoryTypes": [
{
"id": integer,
"name": "string"
}
],
"building": {
"id": "string",
"shortName": "string",
"fullName": "string"
}
},
Note
Because floor
field is nullable in cist.nure.ua, NureTimetableAPI sets floor
to 0 if it's null there.
Call example:
Get/{id}
Gets the auditory by its ID. Returns an Auditory
object.
Parameters:
Name | Type | Description |
---|---|---|
id | integer | Auditory ID |
Call example:
GetByName
Gets the auditory by its name. Returns a list of Auditory
objects whose names contain the specified name.
Parameters:
Name | Type | Description |
---|---|---|
name | string | Auditory name. |
Call example:
Buildings/GetAll
Gets all buildings. Returns a list of Building
objects.
Building object:
{
"id": "string",
"shortName": "string",
"fullName": "string",
"auditories": [
{
"id": integer,
"name": "string",
"floor": integer,
"hasPower": boolean,
"auditoryTypes": [
{
"id": integer,
"name": "string"
}
]
}
]
}
Call example:
Buildings/Get/{id}
Gets the building by its ID. Returns a Building
object.
Parameters:
Name | Type | Description |
---|---|---|
id | string | Building ID |
Call example:
Buildings/GetByName
Gets the building by its name. Returns a list of Building
objects whose names contain the specified name.
Parameters:
Name | Type | Description |
---|---|---|
name | string | Building name. |
Call example: