Class IbisResult

Class representing the top-level container for all XML and JSON results. This may be just a simple textual value or it may contain more complex entities such as people, institutions, groups, attributes, etc.

IbisDto

IbisResult

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

Properties summary

`public string`	`$version` The web service API version number. The web service API version number.	#
`public string`	`$value` The value returned by methods that return a simple textual value. The value returned by methods that return a simple textual value.	#
`public IbisPerson`	`$person` The person returned by methods that return a single person. Note that methods that may return multiple people will always use the `IbisResult::$people` field, even if only one person was returned. The person returned by methods that return a single person. Note that methods that may return multiple people will always use the `IbisResult::$people` field, even if only one person was returned.	#
`public IbisInstitution`	`$institution` The institution returned by methods that return a single institution. Note that methods that may return multiple institutions will always use the `IbisResult::$institutions` field, even if only one institution was returned. The institution returned by methods that return a single institution. Note that methods that may return multiple institutions will always use the `IbisResult::$institutions` field, even if only one institution was returned.	#
`public IbisGroup`	`$group` The group returned by methods that return a single group. Note that methods that may return multiple groups will always use the `IbisResult::$groups` field, even if only one group was returned. The group returned by methods that return a single group. Note that methods that may return multiple groups will always use the `IbisResult::$groups` field, even if only one group was returned.	#
`public IbisIdentifier`	`$identifier` The identifier returned by methods that return a single identifier. The identifier returned by methods that return a single identifier.	#
`public IbisAttribute`	`$attribute` The person or institution attribute returned by methods that return a single attribute. The person or institution attribute returned by methods that return a single attribute.	#
`public IbisError`	`$error` If the method failed, details of the error. If the method failed, details of the error.	#
`public IbisPerson[]`	`$people` The list of people returned by methods that may return multiple people. This may be empty, or contain one or more people. The list of people returned by methods that may return multiple people. This may be empty, or contain one or more people.	#
`public IbisInstitution[]`	`$institutions` The list of institutions returned by methods that may return multiple institutions. This may be empty, or contain one or more institutions. The list of institutions returned by methods that may return multiple institutions. This may be empty, or contain one or more institutions.	#
`public IbisGroup[]`	`$groups` The list of groups returned by methods that may return multiple groups. This may be empty, or contain one or more groups. The list of groups returned by methods that may return multiple groups. This may be empty, or contain one or more groups.	#
`public IbisAttribute[]`	`$attributes` The list of attributes returned by methods that return lists of person/institution attributes. The list of attributes returned by methods that return lists of person/institution attributes.	#
`public IbisAttributeScheme[]`	`$attributeSchemes` The list of attribute schemes returned by methods that return lists of person/institution attribute schemes. The list of attribute schemes returned by methods that return lists of person/institution attribute schemes.	#

Classes

Interfaces

Exceptions

Class IbisResult

Properties summary