This endpoint finds staff members known to Tabula who act as the provided relationship agent with at least one student in a given department. The "agent" is e.g. the tutor, or supervisor to a student.

Inactive members will be filtered out at query time.

Permission requirements

The user must have Permissions.Profiles.StudentRelationship.Read ("View a student relationship") on the department.

Information about API permissions

Definition

GET https://tabula.warwick.ac.uk/api/v1/relationships/agents/:dept/:studentRelationshipTypeId

URL substitution variables

:dept	The department code to find agents within. You must have the relevant permission on this department.
:studentRelationshipTypeId	The required relationship type's urlPart, e.g. tutor. Valid types are available via API request: GET /v1/relationships.

Example request

GET https://tabula.warwick.ac.uk/api/v1/relationships/agents/cs/tutor

Response parameters

An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 200 OK and the following parameters:

success	Boolean true
status	The string "ok"
agents	Array of matching agents, with keys for universityId, firstName and lastName.

Example response

{
  "success":true,
  "status":"ok",
  "agents":[   
    {
      "firstName": "Reynard",
      "lastName": "Fox",
      "universityId":  "1234567"
    }
  ]
}