University of Cambridge Institution API

Methods for querying and manipulating institutions. #### The fetch parameter for institutions All methods that return institutions also accept an optional `fetch` parameter that may be used to request additional information about the institutions returned. For more details about the general rules that apply to the `fetch` parameter, refer to the `PersonMethods` documentation. For institutions the `fetch` parameter may be used to fetch any institution attribute by specifying the `schemeid` of an institution attribute scheme. Examples include `"address"`, `"jpegPhoto"`, `"universityPhone"`, `"instPhone"`, `"landlinePhone"`, `"mobilePhone"`, `"faxNumber"`, `"email"` and `"labeledURI"`. The full list (which may be extended over time) may be obtained using `#allAttributeSchemes`. In addition the following pseudo-attributes are supported: * `"phone_numbers"` - fetches all phone numbers. This is equivalent to `"universityPhone,instPhone,landlinePhone,mobilePhone"`. * `"all_attrs"` - fetches all attributes from all institution attribute schemes. This does not include references. * `"contact_rows"` - fetches all institution contact rows. Any chained fetches from contact rows are used to fetch attributes from any people referred to by the contact rows. The `fetch` parameter may also be used to fetch referenced people, institutions or groups. This will only include references to non-cancelled entities. The following references are supported: * `"all_members"` - fetches all the people who are members of the institution. * `"parent_insts"` - fetches all the parent institutions. Note that currently all institutions have only one parent, but this may change in the future, and client applications should be prepared to handle multiple parents. * `"child_insts"` - fetches all the child institutions. * `"inst_groups"` - fetches all the groups that belong to the institution. * `"members_groups"` - fetches all the groups that form the institution's membership list. * `"managed_by_groups"` - fetches all the groups that manage the institution's data (commonly called "Editor" groups). As with person `fetch` parameters, the references may be used in a chain by using the "dot" notation to fetch additional information about referenced people, institutions or groups. For example `"all_members.email"` will fetch the email addresses of all members of the institution. For more information about what can be fetched from referenced people and groups, refer to the documentation for `PersonMethods` and `GroupMethods`.