01. izi.TRAVEL Directory API Overview
his is the API reference document for accessing the izi.TRAVEL data:
izi.TRAVEL API notes License Terms of the izi.TRAVEL API izi.TRAVEL Academy All API requests are made over HTTPS to API endpoints.
The response format for all requests is a JSON object or array of objects.
Data character encoding is UTF-8.
Whether a request succeeded is indicated by the HTTP status code. A 2xx status code indicates success, whereas a 4xx status code indicates failure. When a request fails, the response body is still JSON, but always contains the fields code and error which you can inspect to use for debugging.
API declares Generic Errors codes, applicable for all requests. However, an endpoint can declare own error codes.
Starting from API version 1.2.3, the “Museum Tours” feature is introduced extending the concept of navigational story to Museum’s collections for showing the visitor “navigational pictures/audio” between exhibits and allowing the visitor to understand where to go next. More than one navigational stories are allowed between two exhibits.
The order of exhibits and story_navigations in collections is important for the feature and the order is defined in izi.TRAVEL CMS (Content Management System). Corespondent API end-points will return collection’s children in this order.
Highlights:
If indicated API version is 1.2.3 or above, in Full form of MTGObject for collection: – story_navigations will be returned (if exist) in section children in additional to exhibits and in the order defined in izi.TRAVEL CMS.
– Playback object will be returned with type as sequential and order as arrays of ordered exhibits and story_navigations UUIDs.
children_count field for collection will always return the number of exhibits, it does not depend on indicated API version (See Compact form of MTGObject and Content of MTGObject Full form). To get the number of exhibits and story_navigations in a collection use /mtgobjects/:uuid/children/count end-point (see next bullet).
/mtgobjects/:uuid/children/count end-point will return the number of exhibits and story_navigations in a collection if indicated API version 1.2.3 or above.
/mtgobjects/:uuid/children end-point will return exhibits and story_navigations for a collection in the order defined in izi.TRAVEL CMS.
audio_duration and size fields will include story_navigation data for collections and museums if indicated API version is 1.2.3 or above (see MTGObject Compact and Full forms).