IbisInstitution

Class in module ibisclient.dto

class IbisInstitution(attrs={})

Bases: IbisDto

Class representing an institution returned by the web service API.

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

acronym

str

The institution's acronym, if set (e.g., "UCS").

attributes

list of IbisAttribute

A list of the institution'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 "address", or the special pseudo-attribute scheme "phone_numbers".

cancelled

bool

Flag indicating if the institution is cancelled.

childInsts

list of IbisInstitution

A list of the institution's child institutions. This will only be populated if the fetch parameter includes the "child_insts" option.

contactRows

list of IbisContactRow

A list of the institution's contact rows. This will only be populated if the fetch parameter includes the "contact_rows" option.

groups

list of IbisGroup

A list of all the groups that belong to the institution. This will only be populated if the fetch parameter includes the "inst_groups" option.

instid

str

The institution's unique ID (e.g., "CS").

managedByGroups

list of IbisGroup

A list of the groups that manage this institution. This will only be populated if the fetch parameter includes the "managed_by_groups" option.

members

list of IbisPerson

A list of the institution's members. This will only be populated if the fetch parameter includes the "all_members" option.

membersGroups

list of IbisGroup

A list of the groups that form the institution's membership. This will only be populated if the fetch parameter includes the "members_groups" option.

name

str

The institution's name.

parentInsts

list of IbisInstitution

A list of the institution's parent institutions. This will only be populated if the fetch parameter includes the "parent_insts" option.

Note

Currently all institutions have one parent, but in the future institutions may have multiple parents.