API docs by Redocly

Pointeur Backend – Integration API (2.0.0)

Download OpenAPI specification:

Read-only REST API for external integrations with the Pointeur scheduling application. This surface requires an API key passed via the X-Api-Key header.

Constraints:

  • Only GET requests are accepted; all other HTTP methods are denied.
  • Endpoints related to users and API key management are not available.

Levels

Academic levels

List all levels with their groups

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a level with its groups

Authorizations:
apiKeyAuth
path Parameters
levelId
required
integer <int64>

Level identifier

Responses

Response samples

Content type
application/json
{
  • "level": {
    },
  • "groups": [
    ]
}

Groups

Student groups within levels

List groups in a level

Authorizations:
apiKeyAuth
path Parameters
levelId
required
integer <int64>

Level identifier

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a group

Authorizations:
apiKeyAuth
path Parameters
levelId
required
integer <int64>

Level identifier

groupId
required
integer <int64>

Group identifier

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "string",
  • "classe": "string",
  • "size": 0,
  • "level": {
    }
}

Teachers

Teacher registry

List all teachers

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a teacher

Authorizations:
apiKeyAuth
path Parameters
teacherId
required
integer <int64>

Teacher identifier

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "abbreviation": "string"
}

Teaching Units

Teaching unit (subject) registry

List teaching units for a level

Authorizations:
apiKeyAuth
path Parameters
levelId
required
integer <int64>

Level identifier

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all teaching units

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a teaching unit

Authorizations:
apiKeyAuth
path Parameters
unitId
required
integer <int64>

Teaching unit identifier

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "abbreviation": "string",
  • "name": "string",
  • "level": {
    }
}

Rooms

Room registry

List all rooms

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a room

Authorizations:
apiKeyAuth
path Parameters
roomId
required
integer <int64>

Room identifier

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "abbreviation": "string",
  • "size": 0
}

List available rooms in a time range

Returns rooms that are unoccupied between the given start and end times.

Authorizations:
apiKeyAuth
query Parameters
startTime
required
string <date-time>

Start date-time (ISO 8601)

endTime
required
string <date-time>

End date-time (ISO 8601)

size
integer >= 1
Default: 1

Minimum room capacity (defaults to 1)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Schedule

Schedule queries

Query the schedule

Returns schedule items in the given date range. Optionally filter by level and/or group. If groupId is supplied without levelId, only that group's timetable is returned.

Authorizations:
apiKeyAuth
query Parameters
startDate
required
string <date>
endDate
required
string <date>
levelId
integer <int64>
groupId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a schedule item

Authorizations:
apiKeyAuth
path Parameters
scheduleItemId
required
integer <int64>

Schedule item identifier

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "groups": [
    ],
  • "teacher": {
    },
  • "teachingUnit": {
    },
  • "room": {
    },
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}