IbisResult

Class in module ibisclient.dto

class IbisResult(attrs={})

Bases: IbisDto

Class representing the top-level container for all results.

This may be just a simple textual value or it may contain more complex entities such as people, institutions, groups, attributes, etc.

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

class Entities(attrs={})

Bases: IbisDto

Nested class to hold the full details of all the entities returned in a result. This is used only in the flattened result representation, where each of these entities will have a unique textual ID, and be referred to from the top-level objects returned (and by each other).

In the hierarchical representation, this is not used, since all entities returned will be at the top-level, or directly contained in those top-level entities.

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

groups

list of IbisGroup

A list of all the unique groups returned by the method. This may include additional groups returned as a result of the fetch parameter, so this list may contain more entries than the corresponding field on the enclosing class.

institutions

list of IbisInstitution

A list of all the unique institutions returned by the method. This may include additional institutions returned as a result of the fetch parameter, so this list may contain more entries than the corresponding field on the enclosing class.

people

list of IbisPerson

A list of all the unique people returned by the method. This may include additional people returned as a result of the fetch parameter, so this list may contain more entries than the corresponding field on the enclosing class.

class EntityMap(result)

Bases: object

Nested class to assist during the unflattening process, maintaining efficient maps from IDs to entities (people, institutions and groups).

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

get_group(id)

Get a group from the entity map, given its ID.

get_institution(id)

Get an institution from the entity map, given its ID.

get_person(id)

Get a person from the entity map, given their ID.

attribute

IbisAttribute

The person or institution attribute returned by methods that return a single attribute.

attributeSchemes

list of IbisAttributeScheme

The list of attribute schemes returned by methods that return lists of person/institution attribute schemes.

attributes

list of IbisAttribute

The list of attributes returned by methods that return lists of person/institution attributes.

entities

IbisResult.Entities

In the flattened XML/JSON representation, all the unique entities returned by the method.

Note

This will be None unless the “flatten” parameter is True.

error

IbisError

If the method failed, details of the error.

group

IbisGroup

The group returned by methods that return a single group.

Note that methods that may return multiple groups will always use the groups field, even if only one group was returned.

groups

list of IbisGroup

The list of groups returned by methods that may return multiple groups. This may be empty, or contain one or more groups.

identifier

IbisIdentifier

The identifier returned by methods that return a single identifier.

institution

IbisInstitution

The institution returned by methods that return a single institution.

Note that methods that may return multiple institutions will always use the institutions field, even if only one institution was returned.

institutions

list of IbisInstitution

The list of institutions returned by methods that may return multiple institutions. This may be empty, or contain one or more institutions.

people

list of IbisPerson

The list of people returned by methods that may return multiple people. This may be empty, or contain one or more people.

person

IbisPerson

The person returned by methods that return a single person.

Note that methods that may return multiple people will always use the people field, even if only one person was returned.

value

str

The value returned by methods that return a simple textual value.

version

str

The web service API version number.