travel.izi.api.service

Interface MtgObjectService

public interface MtgObjectService

Endpoints for MTG Object.

Method Summary

Modifier and Type	Method and Description
<any>	childrenNumber(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] types) Retrieve number of children of a MTGObject.
<any>	compactChildren(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset, java.lang.String[] types, java.lang.Boolean show_hidden, java.lang.Boolean audio_duration) Retrieve children of MtgObject in compact form.
<any>	compactMtgObjects(java.lang.String uuids, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Boolean audio_duration) Retrieve list of compact MtgObjects by set of UUIDs param.
<any>	compactParents(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset, java.lang.Boolean audio_duration) Retrieve parents of MtgObject in compact form.
<any>	fullChildren(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset, java.lang.String[] types, java.lang.Boolean show_hidden, java.lang.Boolean audio_duration, java.lang.Boolean children_count) Retrieve children of MtgObject in full form.
<any>	fullMtgObjects(java.lang.String uuids, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Boolean audio_duration, java.lang.Boolean children_count) Retrieve list of full MtgObjects by set of UUIDs param.
<any>	fullParents(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset, java.lang.Boolean audio_duration, java.lang.Boolean children_count) Retrieve parents of MtgObject in full form.
<any>	mtgObject(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Boolean audio_duration, java.lang.Boolean children_count) Retrieve a full MtgObject by UUID param.
<any>	museumByIp(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.String ip, java.lang.Boolean audio_duration, java.lang.Boolean children_count) Retrieve a full museum object using its external IP address.
<any>	productId(java.lang.String uuid) Retrieve product ID of MtgObject.
<any>	searchCompactByProductIds(java.lang.String[] languages, java.lang.String[] productIds, java.lang.String[] includes, java.lang.String[] except) Search for museums and/or tours by product IDs.
<any>	searchFullByProductIds(java.lang.String[] languages, java.lang.String[] productIds, java.lang.String[] includes, java.lang.String[] except) Search for museums and/or tours by product IDs.

Method Detail

mtgObject

<any> mtgObject(java.lang.String uuid,
                java.lang.String[] languages,
                java.lang.String[] includes,
                java.lang.String[] except,
                java.lang.Boolean audio_duration,
                java.lang.Boolean children_count)

Retrieve a full MtgObject by UUID param.

Parameters:

uuid - UUID of MtgObject.

languages - Array of preferable content languages.

includes - Array of ContentSectionModifier (by default: ContentSectionModifier.CHILDREN).

except - The same array of ContentSectionModifier as above for excluding.

audio_duration - Defines if the total audio duration shall be added to returned MTGObject(s). Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection. Field 'audio_duration’ will be added to root of compact form and to content section of full form. The value of 'audio_duration’ is integer and keeps total duration in seconds of the object and children.

children_count - Defines if the field `children_count` shall be added to full form of MTGObject in content section. Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection.

Returns:

Only one MtgObject is returned. The language of content is a first available language from requested languages. If no available language or MtgObject with requested UUID doesn't exist, 404 error code is returned.

compactMtgObjects

<any> compactMtgObjects(java.lang.String uuids,
                        java.lang.String[] languages,
                        java.lang.String[] includes,
                        java.lang.String[] except,
                        java.lang.Boolean audio_duration)

Retrieve list of compact MtgObjects by set of UUIDs param.

Parameters:

uuids - Set of MtgObject UUIDs separated by commas.

languages - Array of preferable content languages.

includes - Array of ContentSectionModifier (by default: ContentSectionModifier.CHILDREN).

except - The same array of ContentSectionModifier as above for excluding.

audio_duration - Defines if the total audio duration shall be added to returned MTGObject(s). Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection. Field 'audio_duration’ will be added to root of compact form and to content section of full form. The value of 'audio_duration’ is integer and keeps total duration in seconds of the object and children.

Returns:

List of MtgObjects. The language of content is a first available language from requested languages. If no available language or MtgObject with requested UUIDs doesn't exist, 404 error code is returned.

See Also:

fullMtgObjects(String, String[], String[], String[], Boolean, Boolean)

fullMtgObjects

<any> fullMtgObjects(java.lang.String uuids,
                     java.lang.String[] languages,
                     java.lang.String[] includes,
                     java.lang.String[] except,
                     java.lang.Boolean audio_duration,
                     java.lang.Boolean children_count)

Retrieve list of full MtgObjects by set of UUIDs param.

See Also:

compactMtgObjects(String, String[], String[], String[], Boolean)

compactParents

<any> compactParents(java.lang.String uuid,
                     java.lang.String[] languages,
                     java.lang.String[] includes,
                     java.lang.String[] except,
                     java.lang.Long limit,
                     java.lang.Long offset,
                     java.lang.Boolean audio_duration)

Retrieve parents of MtgObject in compact form.

Parameters:

uuid - UUID of MtgObject.

languages - Array of preferable content languages.

includes - Array of ContentSectionModifier.

except - The same array of ContentSectionModifier as above for excluding.

limit - Number of results to return, value in interval [1, 100] (20 by default).

offset - Get the results starting at a given offset (0 by default).

audio_duration - Defines if the total audio duration shall be added to returned MTGObject(s). Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection. Field 'audio_duration’ will be added to root of compact form and to content section of full form. The value of 'audio_duration’ is integer and keeps total duration in seconds of the object and children.

Returns:

If MtgObject with requested UUID doesn't exist, 404 error code is returned.

See Also:

fullParents(String, String[], String[], String[], Long, Long, Boolean, Boolean)

fullParents

<any> fullParents(java.lang.String uuid,
                  java.lang.String[] languages,
                  java.lang.String[] includes,
                  java.lang.String[] except,
                  java.lang.Long limit,
                  java.lang.Long offset,
                  java.lang.Boolean audio_duration,
                  java.lang.Boolean children_count)

Retrieve parents of MtgObject in full form.

See Also:

compactParents(String, String[], String[], String[], Long, Long, Boolean)

compactChildren

<any> compactChildren(java.lang.String uuid,
                      java.lang.String[] languages,
                      java.lang.String[] includes,
                      java.lang.String[] except,
                      java.lang.Long limit,
                      java.lang.Long offset,
                      java.lang.String[] types,
                      java.lang.Boolean show_hidden,
                      java.lang.Boolean audio_duration)

Retrieve children of MtgObject in compact form.

Parameters:

uuid - UUID of MtgObject.

languages - Array of preferable content languages.

includes - Array of ContentSectionModifier.

except - The same array of ContentSectionModifier as above for excluding.

limit - Number of results to return, up to 100 (50 by default)

offset - Get the results starting at a given offset (0 by default).

types - Array of requested types of children, i.e. for Museum children could be MtgObjectType.Exhibit or MtgObjectType.Collection, while for Tour children could be MtgObjectType.TouristAttraction or MtgObjectType.StoryNavigation.

show_hidden - If it set to true, then hidden tourist_attraction will be returned.

audio_duration - Defines if the total audio duration shall be added to returned MTGObject(s). Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection. Field 'audio_duration’ will be added to root of compact form and to content section of full form. The value of 'audio_duration’ is integer and keeps total duration in seconds of the object and children.

Returns:

If MtgObject with requested UUID doesn't exist, 404 error code is returned.

See Also:

fullChildren(String, String[], String[], String[], Long, Long, String[], Boolean, Boolean, Boolean)

fullChildren

<any> fullChildren(java.lang.String uuid,
                   java.lang.String[] languages,
                   java.lang.String[] includes,
                   java.lang.String[] except,
                   java.lang.Long limit,
                   java.lang.Long offset,
                   java.lang.String[] types,
                   java.lang.Boolean show_hidden,
                   java.lang.Boolean audio_duration,
                   java.lang.Boolean children_count)

Retrieve children of MtgObject in full form.

See Also:

compactChildren(String, String[], String[], String[], Long, Long, String[], Boolean, Boolean)

childrenNumber

<any> childrenNumber(java.lang.String uuid,
                     java.lang.String[] languages,
                     java.lang.String[] types)

Retrieve number of children of a MTGObject.

Parameters:

uuid - UUID of MtgObject.

languages - Array of preferable content languages.

types - Array of requested types of children, i.e. for Museum children could be MtgObjectType.Exhibit or MtgObjectType.Collection, while for Tour children could be MtgObjectType.TouristAttraction or MtgObjectType.StoryNavigation.

Returns:

Amount of children of MTGObject with requested UUID as integer.

museumByIp

<any> museumByIp(java.lang.String[] languages,
                 java.lang.String[] includes,
                 java.lang.String[] except,
                 java.lang.String ip,
                 java.lang.Boolean audio_duration,
                 java.lang.Boolean children_count)

Retrieve a full museum object using its external IP address. IP address is detected by server if it is not set directly via the parameter 'ip'.

Parameters:

languages - Array of preferable content languages.

includes - Array of ContentSectionModifier (by default: ContentSectionModifier.CHILDREN).

except - The same array of ContentSectionModifier as above for excluding.

ip - External API value. Used to set external IP directly.

audio_duration - Defines if the total audio duration shall be added to returned MTGObject(s). Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection. Field 'audio_duration’ will be added to root of compact form and to content section of full form. The value of 'audio_duration’ is integer and keeps total duration in seconds of the object and children.

children_count - Defines if the field `children_count` shall be added to full form of MTGObject in content section. Values: `true` or `false`. Default value: `false`. Makes sense for MTGObjects museum, tour or collection.

Returns:

Only one MtgObject is returned. The language of content is a first available language from requested languages. If no available language or MtgObject with requested ip doesn't exist, 404 error code is returned.

productId

<any> productId(java.lang.String uuid)

Retrieve product ID of MtgObject.

Parameters:

uuid - UUID of MtgObject.

Returns:

If MtgObject with requested UUID doesn't exist, 404 error code is returned.

searchCompactByProductIds

<any> searchCompactByProductIds(java.lang.String[] languages,
                                java.lang.String[] productIds,
                                java.lang.String[] includes,
                                java.lang.String[] except)

Search for museums and/or tours by product IDs.

Parameters:

languages - Array of preferable languages.

productIds - Array of product IDs.

includes - Array of ContentSectionModifier.

except - The same array of ContentSectionModifier as above for excluding.

Returns:

If MtgObject with requested product IDs doesn't exist, 404 error code is returned.

See Also:

searchFullByProductIds(String[], String[], String[], String[])

searchFullByProductIds

<any> searchFullByProductIds(java.lang.String[] languages,
                             java.lang.String[] productIds,
                             java.lang.String[] includes,
                             java.lang.String[] except)

Search for museums and/or tours by product IDs.

See Also:

searchCompactByProductIds(String[], String[], String[], String[])