IbisAttribute¶
Class in module ibisclient.dto
- class IbisAttribute(attrs={})¶
Bases:
IbisDto
Class representing an attribute of a person or institution returned by the web service API. Note that for institution attributes, the
instid
,visibility
andowningGroupid
fields will beNone
.Code author: Dean Rasheed (dev-group@ucs.cam.ac.uk)
- attrid¶
- int
The unique internal identifier of the attribute.
- binaryData¶
- bytes
The binary data held in the attribute (e.g., a JPEG photo).
- comment¶
- str
Any comment associated with the attribute.
- effectiveFrom¶
- date
For time-limited attributes, the date from which it takes effect.
- effectiveTo¶
- date
For time-limited attributes, the date after which it is no longer effective.
- encoded_string()¶
Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method. This string is compatible with valueOf(java.lang.String) on the corresponding Java class, used on the server to decode the attribute parameter.
Note
This requires that the attributeâs
scheme
field be set, and typically thevalue
orbinaryData
should also be set.- Returns
- str
The string encoding of this attribute.
- instid¶
- str
For a person attribute, the optional institution that the attribute is associated with. This will not be set for institution attributes.
- owningGroupid¶
- str
For a person attribute, the ID of the group that owns it (typically the user agent group that created it).
- scheme¶
- str
The attributeâs scheme.
- value¶
- str
The attributeâs value (except for binary attributes).
- visibility¶
- str
For a person attribute, itâs visibility (
"private"
,"institution"
,"university"
or"world"
). This will not be set for institution attributes.