Serialized Form (api 1.6.0 API)

Package travel.izi.api
- Class travel.izi.api.IZITravelError extends java.lang.RuntimeException implements Serializable
  - Serialized Fields
    - url
```
java.lang.String url
```
    - response
```
retrofit.client.Response response
```
    - httpError
```
IZITravelError.HttpError httpError
```
    - kind
```
retrofit.RetrofitError.Kind kind
```
- Class travel.izi.api.IZITravelError.HttpError extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1942575303158771456L
  - Serialized Fields
    - code
```
int code
```
      The error code.
    - message
```
java.lang.String message
```
      The error message.
Package travel.izi.api.model
Package travel.izi.api.model.entity
- Class travel.izi.api.model.entity.CompactMtgObject extends MtgObject implements Serializable
  
  serialVersionUID:
  
  -6765762325500029435L
  - Serialized Fields
    - language
```
java.lang.String language
```
      Language (ISO 639-1) of object's content.
    - title
```
java.lang.String title
```
      Title.
    - summary
```
java.lang.String summary
```
      Shortened description.
    - description
```
java.lang.String description
```
      Full description. Only for objects from "children" section.
    - images
```
Media[] images
```
      Array of images data.
      NOTE: Contains only one object (first image).
    - quiz
```
Quiz quiz
```
      Quiz data. Only for objects from "children" section.
    - route
```
java.lang.String route
```
      Route in KML format (typical for tour). This route is for display on map purposes only.
    - childrenCount
```
int childrenCount
```
      Number of children.
- Class travel.izi.api.model.entity.Contacts extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  9000346967520879862L
  - Serialized Fields
    - phone
```
java.lang.String phone
```
      Phone number. Typical for museum.
    - website
```
java.lang.String website
```
      Website link. Typical for museum and publisher.
    - country
```
java.lang.String country
```
      Country code, ISO 3166-1 alpha-2. Typical for museum.
    - city
```
java.lang.String city
```
      City name. Typical for museum.
    - address
```
java.lang.String address
```
      Address. Typical for museum.
    - postcode
```
java.lang.String postcode
```
      Postal code. Typical for museum.
    - state
```
java.lang.String state
```
      Administrative subdivision. Typical for museum.
    - twitter
```
java.lang.String twitter
```
      URL to Twitter account. Typical for publisher.
    - facebook
```
java.lang.String facebook
```
      URL to Facebook account. Typical for publisher.
    - googleplus
```
java.lang.String googleplus
```
      URL to Google+ account. Typical for publisher.
    - instagram
```
java.lang.String instagram
```
      URL to Instagram account. Typical for publisher.
    - youtube
```
java.lang.String youtube
```
      URL to Youtube account. Typical for publisher.
    - vk
```
java.lang.String vk
```
      URL to VK account. Typical for publisher.
- Class travel.izi.api.model.entity.Content extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -7649775755228665105L
  - Serialized Fields
    - language
```
java.lang.String language
```
      Language (ISO 639-1) of this content item.
    - title
```
java.lang.String title
```
      Title.
    - summary
```
java.lang.String summary
```
      Shortened description.
    - description
```
java.lang.String description
```
      Full description.
    - news
```
java.lang.String news
```
      News (typical for museum).
    - playback
```
Playback playback
```
      MTGObject's playback algorithm settings. Specifies the way data inside MTGObject must be played.
    - download
```
Download download
```
      Download links to offline packages for each supported mobile platform and combination of image, audio and video data formats.
    - images
```
Media[] images
```
      Array of images data.
    - audio
```
Media[] audio
```
      Array of audio data.
    - video
```
Media[] video
```
      Array of video data.
    - children
```
CompactMtgObject[] children
```
      Array of included object's content.
    - collections
```
CompactMtgObject[] collections
```
      Array of included museum collection's content.
    - references
```
CompactMtgObject[] references
```
      Array of linked object's content.
    - quiz
```
Quiz quiz
```
      Quiz data.
    - childrenCount
```
int childrenCount
```
      Number of children.
    - audioDuration
```
int audioDuration
```
      Total audio duration.
- Class travel.izi.api.model.entity.ContentProvider extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  7467456948397776542L
  - Serialized Fields
    - uuid
```
java.lang.String uuid
```
      Universally Unique Identifier of content provider.
    - name
```
java.lang.String name
```
      Not localized Content Provider’s name.
    - copyright
```
java.lang.String copyright
```
      Content provider copyright information. E.g., “© 2015 Art Museum”.
- Class travel.izi.api.model.entity.Download extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -3739763654442410883L
  - Serialized Fields
    - iosLow
```
Download.Package iosLow
```
      Package for iPhone 3GS and below (no retina display).
    - iosHigh
```
Download.Package iosHigh
```
      Package for iPhone 4 and above (retina display).
    - androidLow
```
Download.Package androidLow
```
      Package for android devices with low and medium screen resolution (width <= 480px).
    - androidHigh
```
Download.Package androidHigh
```
      Package for android devices with high and extra high screen resolution (width > 480px).
    - video
```
Download.Package video
```
      Package with videos for certain language.
    - map
```
Download.Package map
```
      Package with off-line map in mbtiles format for current MTGObject.
- Class travel.izi.api.model.entity.Download.Package extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -2995200961827501157L
  - Serialized Fields
    - url
```
java.lang.String url
```
      Direct link to download a package.
    - size
```
int size
```
      File size (in bytes).
    - md5
```
java.lang.String md5
```
      MD5 hash from file. Actually this is ETag property for checking if content changed.
    - updated
```
java.lang.String updated
```
      Date of the package generation.
- Class travel.izi.api.model.entity.FeaturedObject extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  70956846103293590L
  - Serialized Fields
    - uuid
```
java.lang.String uuid
```
      Universally Unique Identifier of the object.
    - type
```
MtgObjectType type
```
      Object type (museum or tour).
    - category
```
Category category
```
      Category (typical for tour).
    - title
```
java.lang.String title
```
      Title (name) defined by a featured content publisher.
    - subTitle
```
java.lang.String subTitle
```
      Optional sub-title (additional info) defined by a featured content publisher. Examples: ‘BUS TOUR’, 'MUSEUM’, 'WALKING TOUR’.
    - position
```
int position
```
      A position of object in returned set (the order to show on a dashboard). Values: [1..10]
    - images
```
Media[] images
```
      Images of the content.
      NOTE: Contains only one object (first image).
- Class travel.izi.api.model.entity.FullMtgObject extends MtgObject implements Serializable
  
  serialVersionUID:
  
  -8905964278900400446L
  - Serialized Fields
    - contents
```
Content[] contents
```
      Array of language specific MtgObject content: texts, descriptions, media. Everything displayed to end-user come within this array.
    - parentUuid
```
java.lang.String parentUuid
```
      The UUID of parent MtgObject. For example, tour’s uuid of a tourist attraction, museum’s uuid of an exhibit.
    - schedule
```
Schedule schedule
```
      Schedule details (typical for museum).
    - contacts
```
Contacts contacts
```
      Contacts (typical for museum/publisher).
    - sponsors
```
Sponsor[] sponsors
```
      Sponsors (typical for museum/tour).
    - size
```
java.lang.Long size
```
      The size of the media content (audio + video + images) for the object and all its children. Typical for museum/tour/collection.
- Class travel.izi.api.model.entity.Location extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -9075388054707194916L
  - Serialized Fields
    - latitude
```
double latitude
```
      Object latitude.
    - longitude
```
double longitude
```
      Object longitude.
    - altitude
```
double altitude
```
      Object altitude. This parameter has zero value for now and reserved for future use and geocoding consistency.
    - number
```
java.lang.String number
```
      Museum`s exhibit number.
    - ip
```
java.lang.String ip
```
      Public IP address of object’s WiFi router. PLEASE NOTE: The value is not validated in izi.CMS and can not follow IPv4/IPv6 notation.
    - cityUuid
```
java.lang.String cityUuid
```
      UUID of city. Typical for tour, museum, tourist_attraction.
    - countryCode
```
java.lang.String countryCode
```
      Country code, ISO 3166-1 alpha-2. Typical for tour, museum, tourist_attraction, city.
    - countryUuid
```
java.lang.String countryUuid
```
      UUID of country. Typical for tour, museum, tourist_attraction, city.
- Class travel.izi.api.model.entity.Map extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -7351143801283559754L
  - Serialized Fields
    - bounds
```
java.lang.String bounds
```
      Surface bounds for a MTGObject. E.g., bounds for a tour route. The maximum extent of the rendered map area. Bounds must define an area covered by all zoom levels. The bounds are represented as WGS:84 in the OpenLayers Bounds format - left, bottom, right, top. Typical for museum, tour.
      E.g.., "36.0123075,122.0978486,36.0176986,122.0911837"
    - route
```
java.lang.String route
```
      Route in KML format. This route is for display on map purposes only. Typical for tour.
- Class travel.izi.api.model.entity.Media extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -6203198710109285963L
  - Serialized Fields
    - uuid
```
java.lang.String uuid
```
      Universally Unique Identifier of media file.
    - type
```
MediaType type
```
      Type of media.
    - order
```
int order
```
      Defines in what order to show\play media. F.e., picture with order=1 is the first(default) image to display.
    - duration
```
int duration
```
      Duration of media file in seconds. Typical for audio, video.
    - url
```
java.lang.String url
```
      Direct URL to media when a parameter media_links set to true.
    - title
```
java.lang.String title
```
      Title of media. Typical for MediaType.Map and MediaType.Story images.
    - hash
```
java.lang.String hash
```
      ETag hash for checking if file changed (MediaType.BrandCover and MediaType.City has no hash).
    - size
```
java.lang.Long size
```
      Media size in bytes (MediaType.BrandCover and MediaType.City has no size). In case of images with type MediaType.Story, the size of 800x600 image version is used.
- Class travel.izi.api.model.entity.MtgObject extends java.lang.Object implements Serializable
  - Serialized Fields
    - uuid
```
java.lang.String uuid
```
      Universally Unique Identifier of MtgObject.
    - type
```
MtgObjectType type
```
      Type of MtgObject.
    - category
```
Category category
```
      Category of tour.
    - status
```
Status status
```
      Content publication status.
    - publisher
```
CompactMtgObject publisher
```
      Publisher.
    - contentProvider
```
ContentProvider contentProvider
```
      Content provider.
    - languages
```
java.lang.String[] languages
```
      Array of all available languages of MtgObject content (ISO 639-1).
      EXCEPTION: For countries and cities is an array of languages for which there are MTGObject in this locality.
    - location
```
Location location
```
      Location of MtgObject.
    - country
```
CompactMtgObject country
```
      Compact version of country.
    - city
```
CompactMtgObject city
```
      Compact version of city.
    - triggerZones
```
TriggerZone[] triggerZones
```
      Array of trigger zones.
    - map
```
Map map
```
      Object with mapping details.
    - placement
```
Placement placement
```
      Tour placement.
    - distance
```
int distance
```
      Distance of tour (in meters).
    - duration
```
int duration
```
      Total duration of tour (in seconds).
      NOTE: Value is calculated as: distance / category speed.
    - purchase
```
Purchase purchase
```
      Object with product purchasing details.
    - translations
```
Translation[] translations
```
      Available translations of the locality name (typical for city and country).
    - countryCode
```
java.lang.String countryCode
```
      Country code (ISO 3166-1) (typical for country).
    - reviews
```
ReviewsResponse.Estimation reviews
```
      The average of ratings/reviews. The section will be returned if the average was calculated.
    - hidden
```
boolean hidden
```
      Tourist attraction map visibility. Can be: false – object shall be displayed on a map; true – object is hidden from the user.
    - visible
```
boolean visible
```
      Typical for city. Defines if the city should be displayed on izi.TRAVEL site main page.
    - hash
```
java.lang.String hash
```
      SHA1 hash from "uuid + last updated" string.
- Class travel.izi.api.model.entity.Playback extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -6620469467015560941L
  - Serialized Fields
    - type
```
PlaybackType type
```
      Describes how to play data inside MTGObject and its children.
    - order
```
java.lang.String[] order
```
      List of UUIDs. Defines playback order of children MTGObjects. If set, a mobile application can use this data for making decisions which story to play. The first array element is the starting object to play.
- Class travel.izi.api.model.entity.ProductIdResponse extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  7283714223007004507L
  - Serialized Fields
    - productId
```
java.lang.String productId
```
      This parameter must be used as "product ID" at an app market.
- Class travel.izi.api.model.entity.Purchase extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  6877484388017149935L
  - Serialized Fields
    - price
```
float price
```
      Content's price (Decimal(6,2)).
    - currency
```
java.lang.String currency
```
      Currency.
      
      See Also:
      
      ISO 4217
- Class travel.izi.api.model.entity.Quiz extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  5027440801077553005L
  - Serialized Fields
    - question
```
java.lang.String question
```
      Quiz's question.
    - comment
```
java.lang.String comment
```
      The comment for a correct answer.
    - answers
```
Quiz.Answer[] answers
```
      Array of answers. The correct answer is marked.
- Class travel.izi.api.model.entity.Quiz.Answer extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  6937351629954453992L
  - Serialized Fields
    - content
```
java.lang.String content
```
      The answer's content.
    - correct
```
boolean correct
```
      Mark of correctness.
- Class travel.izi.api.model.entity.Review extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  2736455010534732511L
  - Serialized Fields
    - id
```
java.lang.Long id
```
      Unique identifier of rating/review across system.
    - date
```
java.util.Date date
```
      UTC time of Rating/Review submit. Format is according to ISO-8601 "YYYY-MM-DDThh:mm:ssZ".
    - rating
```
java.lang.Integer rating
```
      Rating of the content [0..10].
    - review
```
java.lang.String review
```
      Review on the content (limitation: 500).
    - reviewerName
```
java.lang.String reviewerName
```
      Author of review (limitation: 128).
    - language
```
java.lang.String language
```
      Language of reviewed content.
    - hash
```
java.lang.String hash
```
      Hash of content passed at POST (MTGObject hash returned by common API).
- Class travel.izi.api.model.entity.ReviewsResponse extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1273056820276298311L
  - Serialized Fields
    - estimation
```
ReviewsResponse.Estimation estimation
```
    - reviews
```
java.util.List<E> reviews
```
    - paging
```
ReviewsResponse.Paging paging
```
- Class travel.izi.api.model.entity.ReviewsResponse.Estimation extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1492733520461868503L
  - Serialized Fields
    - uuid
```
java.lang.String uuid
```
      UUID of the MtgObject (content).
    - ratingAverage
```
float ratingAverage
```
      Average of all ratings [0..10] (across all languages), Museums ratings includes their Collections ratings.
    - ratingsCount
```
int ratingsCount
```
      Total number of ratings at average snapshot time (across all languages).
    - reviewsCount
```
int reviewsCount
```
      Total number of reviews at average snapshot time (across all languages).
    - date
```
java.util.Date date
```
      UTC time when average was calculated. Format is according to ISO-8601 "YYYY-MM-DDThh:mm:ssZ".
- Class travel.izi.api.model.entity.ReviewsResponse.Paging extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -2388468821027971899L
  - Serialized Fields
    - limit
```
int limit
```
      The number of individual records that are returned in each page.
    - returnedCount
```
int returnedCount
```
      The number of returned records in section 'data'. Values: [0..limit].
    - totalCount
```
int totalCount
```
      The total number of review records for the content at request time (all languages or for certain language passed as parameter).
    - next
```
java.lang.String next
```
      An endpoint request that will return the next page of data or null.
    - previous
```
java.lang.String previous
```
      An endpoint request that will return the previous page of data or null.
- Class travel.izi.api.model.entity.Schedule extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -2040604864848642432L
  - Serialized Fields
    - mon
```
java.lang.String[] mon
```
      Monday working hours.
    - tue
```
java.lang.String[] tue
```
      Tuesday working hours.
    - wed
```
java.lang.String[] wed
```
      Wednesday working hours.
    - thu
```
java.lang.String[] thu
```
      Thursday working hours.
    - fri
```
java.lang.String[] fri
```
      Friday working hours.
    - sat
```
java.lang.String[] sat
```
      Saturday working hours.
    - sun
```
java.lang.String[] sun
```
      Sunday working hours.
- Class travel.izi.api.model.entity.Sponsor extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  2430807285208843276L
  - Serialized Fields
    - uuid
```
java.lang.String uuid
```
      UUID of sponsor object.
    - name
```
java.lang.String name
```
      Not localized name of sponsor.
    - website
```
java.lang.String website
```
      Web-site link.
    - images
```
Media[] images
```
      An array of images according to generic images format in izi.API. The array keeps only one element with sponsor logo.
    - order
```
int order
```
      Order of the element in the sponsors list, started from 1. Sponsors list shall be shown in ascending order.
    - hash
```
java.lang.String hash
```
      Hash reflects a specific version of the sponsor.
- Class travel.izi.api.model.entity.Translation extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  -7286875629429056105L
  - Serialized Fields
    - name
```
java.lang.String name
```
      Localized name.
    - language
```
java.lang.String language
```
      The language (ISO 639-1) of localization.
- Class travel.izi.api.model.entity.TriggerZone extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  3411312172689813215L
  - Serialized Fields
    - type
```
TriggerZoneType type
```
      Trigger zone type.
    - polygonCorners
```
java.lang.String polygonCorners
```
      Comma separated list of polygon latitude, longitude, altitude.
    - circleLatitude
```
double circleLatitude
```
      Circle center latitude.
    - circleLongitude
```
double circleLongitude
```
      Circle center longitude.
    - circleAltitude
```
double circleAltitude
```
      Circle center altitude. This parameter has zero value for now and reserved for future use and geocoding consistency.
    - circleRadius
```
double circleRadius
```
      Circle radius in meters.

Serialized Form

Package travel.izi.api

Class travel.izi.api.IZITravelError extends java.lang.RuntimeException implements Serializable

Serialized Fields

url

response

httpError

kind

Class travel.izi.api.IZITravelError.HttpError extends java.lang.Object implements Serializable

Serialized Fields

code

message

Package travel.izi.api.model

Package travel.izi.api.model.entity

Class travel.izi.api.model.entity.CompactMtgObject extends MtgObject implements Serializable

Serialized Fields

language

title

summary

description

images

quiz

route

childrenCount

Class travel.izi.api.model.entity.Contacts extends java.lang.Object implements Serializable

Serialized Fields

phone

website

country

city

address

postcode

state

twitter

facebook

googleplus

instagram

youtube

vk

Class travel.izi.api.model.entity.Content extends java.lang.Object implements Serializable

Serialized Fields

language

title

summary

description

news

playback

download

images

audio

video

children

collections

references

quiz

childrenCount

audioDuration

Class travel.izi.api.model.entity.ContentProvider extends java.lang.Object implements Serializable

Serialized Fields

uuid

name

copyright

Class travel.izi.api.model.entity.Download extends java.lang.Object implements Serializable

Serialized Fields

iosLow

iosHigh

androidLow

androidHigh

video

map

Class travel.izi.api.model.entity.Download.Package extends java.lang.Object implements Serializable

Serialized Fields

url

size

md5

updated

Class travel.izi.api.model.entity.FeaturedObject extends java.lang.Object implements Serializable

Serialized Fields

uuid

type