public interface MtgObjectService
| Modifier and Type | Method and Description |
|---|---|
java.lang.Integer |
getChildrenNumber(java.lang.String uuid,
java.lang.String[] languages,
java.lang.String[] types)
Retrieve number of children of a MTGObject.
|
java.util.List<CompactMtgObject> |
getCompactChildren(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.
|
java.util.List<CompactMtgObject> |
getCompactMtgObjects(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.
|
java.util.List<FullMtgObject> |
getFullChildren(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.
|
java.util.List<FullMtgObject> |
getFullMtgObjects(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.
|
java.util.List<FullMtgObject> |
getMtgObject(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.
|
java.util.List<FullMtgObject> |
getMuseumByIp(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.
|
ProductIdResponse |
getProductId(java.lang.String uuid)
Retrieve product ID of MtgObject.
|
java.util.List<CompactMtgObject> |
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.
|
java.util.List<FullMtgObject> |
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.
|
@GET(value="/mtgobjects/{uuid}")
java.util.List<FullMtgObject> getMtgObject(@Path(value="uuid")
java.lang.String uuid,
@Query(value="languages")
java.lang.String[] languages,
@Query(value="includes")
java.lang.String[] includes,
@Query(value="except")
java.lang.String[] except,
@Query(value="audio_duration")
java.lang.Boolean audio_duration,
@Query(value="children_count_in_full_form")
java.lang.Boolean children_count)
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.@GET(value="/mtgobjects/batch/{uuids}?form=compact")
java.util.List<CompactMtgObject> getCompactMtgObjects(@Path(value="uuids")
java.lang.String uuids,
@Query(value="languages")
java.lang.String[] languages,
@Query(value="includes")
java.lang.String[] includes,
@Query(value="except")
java.lang.String[] except,
@Query(value="audio_duration")
java.lang.Boolean audio_duration)
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.getFullMtgObjects(String, String[], String[], String[], Boolean, Boolean)@GET(value="/mtgobjects/batch/{uuids}?form=full")
java.util.List<FullMtgObject> getFullMtgObjects(@Path(value="uuids")
java.lang.String uuids,
@Query(value="languages")
java.lang.String[] languages,
@Query(value="includes")
java.lang.String[] includes,
@Query(value="except")
java.lang.String[] except,
@Query(value="audio_duration")
java.lang.Boolean audio_duration,
@Query(value="children_count_in_full_form")
java.lang.Boolean children_count)
@GET(value="/mtgobjects/{uuid}/children?form=compact")
java.util.List<CompactMtgObject> getCompactChildren(@Path(value="uuid")
java.lang.String uuid,
@Query(value="languages")
java.lang.String[] languages,
@Query(value="includes")
java.lang.String[] includes,
@Query(value="except")
java.lang.String[] except,
@Query(value="limit")
java.lang.Long limit,
@Query(value="offset")
java.lang.Long offset,
@Query(value="type")
java.lang.String[] types,
@Query(value="show_hidden")
java.lang.Boolean show_hidden,
@Query(value="audio_duration")
java.lang.Boolean audio_duration)
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.getFullChildren(String, String[], String[], String[], Long, Long, String[], Boolean, Boolean, Boolean)@GET(value="/mtgobjects/{uuid}/children?form=full")
java.util.List<FullMtgObject> getFullChildren(@Path(value="uuid")
java.lang.String uuid,
@Query(value="languages")
java.lang.String[] languages,
@Query(value="includes")
java.lang.String[] includes,
@Query(value="except")
java.lang.String[] except,
@Query(value="limit")
java.lang.Long limit,
@Query(value="offset")
java.lang.Long offset,
@Query(value="type")
java.lang.String[] types,
@Query(value="show_hidden")
java.lang.Boolean show_hidden,
@Query(value="audio_duration")
java.lang.Boolean audio_duration,
@Query(value="children_count_in_full_form")
java.lang.Boolean children_count)
@GET(value="/mtgobjects/{uuid}/children/count")
java.lang.Integer getChildrenNumber(@Path(value="uuid")
java.lang.String uuid,
@Query(value="languages")
java.lang.String[] languages,
@Query(value="type")
java.lang.String[] types)
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.@GET(value="/mtgobjects/ip?form=full") java.util.List<FullMtgObject> getMuseumByIp(@Query(value="languages") java.lang.String[] languages, @Query(value="includes") java.lang.String[] includes, @Query(value="except") java.lang.String[] except, @Query(value="ip") java.lang.String ip, @Query(value="audio_duration") java.lang.Boolean audio_duration, @Query(value="children_count_in_full_form") java.lang.Boolean children_count)
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.@GET(value="/mtgobjects/{uuid}/product_id")
ProductIdResponse getProductId(@Path(value="uuid")
java.lang.String uuid)
uuid - UUID of MtgObject.@GET(value="/mtgobjects/search/paid?form=compact") java.util.List<CompactMtgObject> searchCompactByProductIds(@Query(value="languages") java.lang.String[] languages, @Query(value="product_ids") java.lang.String[] productIds, @Query(value="includes") java.lang.String[] includes, @Query(value="except") java.lang.String[] except)
languages - Array of preferable languages.productIds - Array of product IDs.includes - Array of ContentSectionModifier.except - The same array of ContentSectionModifier as above for excluding.searchFullByProductIds(String[], String[], String[], String[])@GET(value="/mtgobjects/search/paid?form=full") java.util.List<FullMtgObject> searchFullByProductIds(@Query(value="languages") java.lang.String[] languages, @Query(value="product_ids") java.lang.String[] productIds, @Query(value="includes") java.lang.String[] includes, @Query(value="except") java.lang.String[] except)