API (v3.1) Migration Documentation

v3.1 is backwardly compatible with v3.0 with base URL /api/v3 for all methods.

The upgrade includes a couple of new endpoints to access the bird's eye view and JSON (domain object) attributes to access record slugs and image captions.

Any API method or JSON domain object not listed below remains unchanged. If you notice any errors contact us at support@vernonsystems.com.

Data Visulaisations

The data visualisation methods, though available publicly have not been documented like other API methods as considerable frontend development is required to make full use of these. Get in touch with us at vsl@vernonsystems.com if you plan to use these methods and we can share more details about it.

New

1. GET /datavisualisations/birdseyeview/opacobjects has been added to retrieve object records in bird's eye view.
Note: This method has not been documented and so cannot be tried out on the interactive user interface.

2. GET /datavisualisations/birdseyeview/opacobjects/{opacObjectId} has been added to retrieve individual object records in bird's eye view.
Note: This method has not been documented and so cannot be tried out on the interactive user interface.

JSON Domain Objects

New

BirdsEyeViewsCollection Domain

BirdsEyeView Domain

BirdsEyeViewFieldSet Domain

BirdsEyeViewField Domain

BirdsEyeViewBase64Image Domain

Modified

OPACObject Domain

Attribute slug within the OPACObject domain has been added.

OPACPerson Domain

Attribute slug within the OPACPerson domain has been added.

OPACVenue Domain

Attribute slug within the OPACVenue domain has been added.

RelatedRecord Domain

Attribute slug within the RelatedRecord domain has been added.

OPACRecord Domain

Attribute slug within the OPACRecord domain has been added.

Image Domain

Attribute caption within the Image domain has been added.