Hints

Display hints are a means to provide additional information to 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.

These hints were developed to support a specific user interface implementation. These values may change without warning as specific UI needs evolve.

Property Hints

The following are a selection of hints that are in use for properties. You can find every property and its display hint on your instance's API documentation (your instance's url + /api)

allocationContentsSummary

A complex JSON object describing all of the items on an allocation. The value is structured as follows:

• lock a description of the session holding the lock on the allocation.
• groups a JSON object stuctured as:
  • label the label for the group.
  • items a JSON array of objects with this structure:
    • label the label for the resource type.
    • subitems a JSON array of objects with this structure:
      • label the label for the resource.
      • due The date the resource is due back

allocationReturnTime

A timestamp representing when an allocation is to be returned.

combobox

Equivalent to the HTML selectBox. Likely to be removed in the future.

date

A timestamp where precision is meaningful to the day.

durationWithRefresh

This hint is equivalent to duration and can safely be ignored. It exists for compatability purposes.

email

This string is an email address.

entity

The value of this property is an instance of an entity.

entityList

A list of entities.

entitySelectBox

An entity which should be selected from a constrained set.

identity

The value of this property is the entity itself.

longString

A string which may contain new line characters, intended to be rendered on multiple lines.

mailingAddress

This value is a list of 6 values corresponding to the following 6 properties:

1. street
2. street2
3. city
4. state
5. postalCode
6. country

patronStatus

A tag representing the current status of a patron. See the person "status" property for details.

personNameList

This value is a list of 3 values corresponding to the following 3 properties:

1. firstName
2. otherName
3. lastName

preciseTimeStamp

A timestamp where full precision is likely desirable, for example in the case of event logging.

resourceLongStatus

A JSON object with 4 keys corresponding to the following 4 properties of a resource:

• status
• currentAllocation
• nextAllocation
• onlineTime

resourceOnlineTime

A timestamp representing the time a resource will come back on line.

resourceOtherUser

An allocation, in the context of a resource, used to provide historical and future circulation information.

schedulingGroupList A list of schedulingGroup entities. selectBox

This is a constrained type where the values of the property are limited to those in the constraint.

selectBoxWithRefresh

This hint is equivilent to selectBox and can safely be ignored. It exists for compatability purposes.

stringList

A list of strings.

stringWithRefresh

This hint is equivilent to string and can safely be ignored. It exists for compatability purposes.

Query Term Hints

autocomplete and autocompleteString

These hints are related to the Autcomplete Framework detailed in the Entities section.

selectBox

This is a constrained type where the options for the search should be limited to those in the constraint.

string

A string intended to be rendered on a single line.