IbisPerson

Class in module ibisclient.dto

class IbisPerson(attrs={})

Bases: IbisDto

Class representing a person returned by the web service API. Note that the identifier is the person's primary identifier (typically their CRSid), regardless of which identifier was used to query for the person.

Code author: Dean Rasheed (dev-group@ucs.cam.ac.uk)

attributes

list of IbisAttribute

A list of the person's attributes. This will only be populated if the fetch parameter includes the "all_attrs" option, or any specific attribute schemes such as "email" or "title", or the special pseudo-attribute scheme "phone_numbers".

cancelled

bool

Flag indicating if the person is cancelled.

directGroups

list of IbisGroup

A list of all the groups that the person directly belongs to. This does not include indirect group memberships - i.e., groups that include these groups. This will only be populated if the fetch parameter includes the "direct_groups" option.

displayName

str

The person's display name (if visible).

groups

list of IbisGroup

A list of all the groups to which the person belongs, including indirect group memberships, via groups that include other groups. This will only be populated if the fetch parameter includes the "all_groups" option.

identifier

IbisIdentifier

The person's primary identifier (typically their CRSid).

identifiers

list of IbisIdentifier

A list of the person's identifiers. This will only be populated if the fetch parameter included the "all_identifiers" option.

institutions

list of IbisInstitution

A list of all the institution's to which the person belongs. This will only be populated if the fetch parameter includes the "all_insts" option.

is_staff()

Returns True if the person is a member of staff.

Note that this tests for an misAffiliation of "", "staff" or "staff,student" since some members of staff will have a blank misAffiliation.

is_student()

Returns True if the person is a student.

This tests for an misAffiliation of "student" or "staff,student".

misAffiliation

str

The person's MIS status ("staff", "student", "staff,student" or "").

registeredName

str

The person's registered name (if visible).

surname

str

The person's surname (if visible).

visibleName

str

The person's display name if that is visible, otherwise their registered name if that is visible, otherwise their surname if that is visible, otherwise the value of their primary identifier (typically their CRSid) which is always visible.