Package org.oxerr.viagogo.client.rescu.resource.catalog

Interface EventResource

@Path("/catalog/events")
public interface EventResource

Method Summary

Modifier and Type	Method	Description
Event	getEvent(Long eventId)	Get an event
Event	getEventByExternalEventId(String platform, Long externalEventId)	Get an event on the viagogo platform using an identifier from an external platform.
PagedResource<Event>	getEvents(Integer page, Integer pageSize, Instant updatedSince, String sort, Long minResourceVersion, String countryCode, Double latitude, Double longitude, Integer maxDistanceInmeters, Integer genreId)	List Events
PagedResource<Event>	searchEvents(String q, LocalDateTime dateLocal, Integer page, Integer pageSize, Instant updatedSince, String sort, Long minResourceVersion, String countryCode, Double latitude, Double longitude, Integer maxDistanceInMeters, Integer genreId)	Search events

Method Details

getEvents

@GET
PagedResource<Event> getEvents(@QueryParam("page")
 Integer page,
 @QueryParam("page_size")
 Integer pageSize,
 @QueryParam("updated_since")
 Instant updatedSince,
 @QueryParam("sort")
 String sort,
 @QueryParam("min_resource_version")
 Long minResourceVersion,
 @QueryParam("country_code")
 String countryCode,
 @QueryParam("latitude")
 Double latitude,
 @QueryParam("longitude")
 Double longitude,
 @QueryParam("max_distance_in_meters")
 Integer maxDistanceInmeters,
 @QueryParam("genre_id")
 Integer genreId)
                        throws IOException,
ViagogoException

List Events

Lists all events on the viagogo platform. Use this endpoint to sync the entire viagogo event catalog with your application.

Parameters:

page - Specifies which page of data to retrieve.

pageSize - Set custom page sizes on response.

updatedSince - Filters the response to only return items that have been updated since the given timestamp

sort - Determines the ordering of items. A comma-separated string containing resource_version.

minResourceVersion - the minimum resource version.

countryCode - Filters results to only include events located in the specified country.

latitude - When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude - When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

maxDistanceInmeters - When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genreId - Filters results to only include events for the specified genre id.

Returns:

all events on the viagogo platform.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

getEventByExternalEventId

@GET
@Path("/external_mappings/{platform}/{externalEventId}")
Event getEventByExternalEventId(@PathParam("platform")
 String platform,
 @PathParam("externalEventId")
 Long externalEventId)
                         throws IOException,
ViagogoException

Get an event on the viagogo platform using an identifier from an external platform.

Parameters:

platform - The name of the external platform. Can be legacy_stubhub

externalEventId - The event identifier from the external platform.

Returns:

the event.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

getEvent

@GET
@Path("/{eventId}")
Event getEvent(@PathParam("eventId")
 Long eventId)
        throws IOException,
ViagogoException

Get an event

Note that the eventID being passed can already be merged with another event. And in this case, details of the new event will be returned, if a different eventId is returned then it means that the event has been merged with the returned event. Also inside _embedded field of the response, a mapping between the original eventId and new eventId will be provided.

Parameters:

eventId - The event identifier.

Returns:

the event.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

searchEvents

@GET
@Path("/search")
PagedResource<Event> searchEvents(@QueryParam("q")
 String q,
 @QueryParam("dateLocal")
 LocalDateTime dateLocal,
 @QueryParam("page")
 Integer page,
 @QueryParam("page_size")
 Integer pageSize,
 @QueryParam("updated_since")
 Instant updatedSince,
 @QueryParam("sort")
 String sort,
 @QueryParam("min_resource_version")
 Long minResourceVersion,
 @QueryParam("country_code")
 String countryCode,
 @QueryParam("latitude")
 Double latitude,
 @QueryParam("longitude")
 Double longitude,
 @QueryParam("max_distance_in_meters")
 Integer maxDistanceInMeters,
 @QueryParam("genre_id")
 Integer genreId)
                           throws IOException,
ViagogoException

Search events

Search for events on the viagogo platform. Use this endpoint to search the entire viagogo event catalog with your application.

Parameters:

q - The query text to be used to match events.

dateLocal - The specific date of the event, this is optional

page - Specifies which page of data to retrieve.

pageSize - Set custom page sizes on response.

updatedSince - Filters the response to only return items that have been updated since the given timestamp

sort - Determines the ordering of items. A comma-separated string containing resource_version.

minResourceVersion - the minimum resource version.

countryCode - Filters results to only include events located in the specified country.

latitude - When provided with longitude and distance filters events returned to ones within the specified distance of the lat/long.

longitude - When provided with latitude and distance filters events returned to ones within the specified distance of the lat/long.

maxDistanceInMeters - When provided with latitude and longitude filters events returned to ones within the specified distance of the lat/long.

genreId - Filters results to only include events for the specified genre id.

Returns:

events.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception