Retrieve a particular staff member's relationships.

Permission requirements

The user must have Permissions.Profiles.StudentRelationship.Read (Any[StudentRelationshipType]) on the member.

Information about API permissions

Definition

GET https://tabula.warwick.ac.uk/api/v1/member/:universityId/relationships

URL substitution variables

:universityId	The 7-digit University ID of the staff member to get the relationships for, e.g. 1234567.

Example request

GET https://tabula.warwick.ac.uk/api/v1/member/1234567/relationships

Request parameters

relationshipType Optional	The relationship type ID to return data for. This can be provided to filter/limit the array of results returned in the response. Valid types are available in the documentation or via API request: GET /v1/relationships. From version 2019.11.4

Response parameters

An unsuccessful response is returned in the standard format. A successful response returns the HTTP code 200 OK and the following parameters:

success	Boolean true
status	The string "ok"
relationships	An array of relationship objects containing the following properties: relationshipType – a student relationship type object students – an array of student objects containing the following properties: universityId – the member's 7-digit University ID userId – the IT Services username for this member

Example response

{
  "success": true,
  "status": "ok",
  "relationships": [
   {
      "relationshipType": {
         "agentRole": "personal tutor",
         "id": "personalTutor",
         "studentRole": "personal tutee",
         "description": "Personal Tutor"
      },
      "students": [
      {
        "universityId": "1111111",
        "userId": "u1111111"
      },
      {
        "universityId": "2111111",
        "userId": "u2111111"
      }
     ]
   },
   {
      "relationshipType": {
         "agentRole": "supervisor",
         "id": "supervisor",
         "studentRole": "research student",
         "description": "Research Supervisor"
      },
      "students": [
      {
        "universityId": "3111111",
        "userId": "u3111111"
      },
      {
        "universityId": "4111111",
        "userId": "u4111111"
      }
     ]
   }
  ]
 }