Display hints are a means to provide additional information to a user interfaces about the semantics of properties and query terms above and beyond their data type. In some cases they will simply be equal to the type of the property. The user of the API may well be able
These hints were developed to support a specific user interface implementation. These values may change without warning as specific UI needs evolve.
The following hints are in use for properties as of 4.3.0.
A complex JSON object describing all of the items on an allocation. The value is structured as follows:
A timestamp representing when an allocation is to be returned.
Equivilent to selectBox. Likely to be removed.
A timestamp where precision is meaningful to the day.
This hint is equivilent to duration and can safely be ignored. It exists for compatability purposes.
This string is an email address.
The value of this property is an instance of an entity.
A list of entities.
An entity which shoudl be selected from a constrained set.
The value of this property is the entity itself.
A wall time value represented as a number of minutes after midnight.
A string which may contain new line characters, intended to be rendered on multiple lines.
This value is a list of 6 values corresponding to the following 6 properties:
A tag representing the current status of a patron.
This value is a list of 3 values corresponding to the following 3 properties:
A list of "personRole" entities.
A timestamp where full precision is likely desirable, for example in the case of event logging.
A JSON object with 4 keys corresponding to the followign 4 properties of a resource:
A timestamp representing the time a resource will come back on line.
An allocation, in the context of a resource, used to provide historical and future circulation information.
This is a constrained type where the values of the property are limited to those in the constraint.
This hint is equivilent to selectBox and can safely be ignored. It exists for compatability purposes.
A list of staffAvailability entities.
A list of staffLimit entities.
A list of staff entities.
A list of strings.
This hint is equivilent to string and can safely be ignored. It exists for compatability purposes.
These hints are related to the Autcomplete Frameword detailed in the Entities section.
This is a constrained type where the options for the search should be limited to those in the constraint.
This hint is currently only used for the ISBN query term.