Class IbisInstitution

Class representing an institution returned by the web service API.

IbisDto

Extended by

IbisInstitution

Author: Dean Rasheed (dev-group@ucs.cam.ac.uk)
Located at dto/IbisInstitution.php

Properties summary

`public boolean`	`$cancelled` Flag indicating if the institution is cancelled. Flag indicating if the institution is cancelled.	#
`public string`	`$instid` The institution's unique ID (e.g., "CS"). The institution's unique ID (e.g., "CS").	#
`public string`	`$name` The institution's name. The institution's name.	#
`public string`	`$acronym` The institution's acronym, if set (e.g., "UCS"). The institution's acronym, if set (e.g., "UCS").	#
`public IbisAttribute[]`	`$attributes` 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"`. 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"`.	#
`public IbisContactRow[]`	`$contactRows` A list of the institution's contact rows. This will only be populated if the `fetch` parameter includes the `"contact_rows"` option. A list of the institution's contact rows. This will only be populated if the `fetch` parameter includes the `"contact_rows"` option.	#
`public IbisPerson[]`	`$members` A list of the institution's members. This will only be populated if the `fetch` parameter includes the `"all_members"` option. A list of the institution's members. This will only be populated if the `fetch` parameter includes the `"all_members"` option.	#
`public IbisInstitution[]`	`$parentInsts` 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. 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.	#
`public IbisInstitution[]`	`$childInsts` A list of the institution's child institutions. This will only be populated if the `fetch` parameter includes the `"child_insts"` option. A list of the institution's child institutions. This will only be populated if the `fetch` parameter includes the `"child_insts"` option.	#
`public IbisGroup[]`	`$groups` 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. 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.	#
`public IbisGroup[]`	`$membersGroups` 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. 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.	#
`public IbisGroup[]`	`$managedByGroups` A list of the groups that manage this institution. This will only be populated if the `fetch` parameter includes the `"managed_by_groups"` option. A list of the groups that manage this institution. This will only be populated if the `fetch` parameter includes the `"managed_by_groups"` option.	#