javastrava.api.v3.rest

Interface StreamAPI

public interface StreamAPI

API definitions for StreamService endpoints

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaStream[]	getActivityStreams(Integer id, String types, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType)
StravaStream[]	getEffortStreams(Long id, String types, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType)
StravaStream[]	getSegmentStreams(Integer id, String types, StravaStreamResolutionType resolution, StravaStreamSeriesDownsamplingType seriesType)

Method Detail

getActivityStreams

@GET(value="/activities/{id}/streams/{types}")
StravaStream[] getActivityStreams(@Path(value="id")
                                                                                  Integer id,
                                                                                  @Path(value="types")
                                                                                  String types,
                                                                                  @Query(value="resolution")
                                                                                  StravaStreamResolutionType resolution,
                                                                                  @Query(value="series_type")
                                                                                  StravaStreamSeriesDownsamplingType seriesType)
                                                                           throws UnauthorizedException,
                                                                                  NotFoundException,
                                                                                  BadRequestException

Parameters:

id - The id of the activity for which streams are to be retrieved

types - List of types, if the activity does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects, or null if the activity doesn't exist

Throws:

UnauthorizedException - If there is a security exception

NotFoundException - If the activity does not exist

BadRequestException - If the request is malformed

See Also:

StreamService.getActivityStreams(Integer, StravaStreamResolutionType, StravaStreamSeriesDownsamplingType, javastrava.api.v3.model.reference.StravaStreamType...)

getEffortStreams

@GET(value="/segment_efforts/{id}/streams/{types}")
StravaStream[] getEffortStreams(@Path(value="id")
                                                                                     Long id,
                                                                                     @Path(value="types")
                                                                                     String types,
                                                                                     @Query(value="resolution")
                                                                                     StravaStreamResolutionType resolution,
                                                                                     @Query(value="series_type")
                                                                                     StravaStreamSeriesDownsamplingType seriesType)
                                                                              throws UnauthorizedException,
                                                                                     NotFoundException,
                                                                                     BadRequestException

Parameters:

id - The id of the segment effort for which streams are to be retrieved

types - List of types, if the effort does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects.

Throws:

UnauthorizedException - If the security token is not valid or the effort is flagged as private

NotFoundException - If the effort does not exist

BadRequestException - If the request is malformed

See Also:

StreamService.getEffortStreams(Long, StravaStreamResolutionType, StravaStreamSeriesDownsamplingType, javastrava.api.v3.model.reference.StravaStreamType...)

getSegmentStreams

@GET(value="/segments/{id}/streams/{types}")
StravaStream[] getSegmentStreams(@Path(value="id")
                                                                               Integer id,
                                                                               @Path(value="types")
                                                                               String types,
                                                                               @Query(value="resolution")
                                                                               StravaStreamResolutionType resolution,
                                                                               @Query(value="series_type")
                                                                               StravaStreamSeriesDownsamplingType seriesType)
                                                                        throws UnauthorizedException,
                                                                               NotFoundException,
                                                                               BadRequestException

Parameters:

id - The id of the segment for which streams are to be retrieved

types - List of types, if the segment does not have that stream it will not be included in the response

resolution - (Optional) low (100), medium (1000) or high (10000), default is all, indicates desired number of data points, streams will only be down sampled

seriesType - (Optional) relevant only if using resolution. Either "time" or "distance", default is "distance", used to index the streams if the stream is being reduced

Returns:

Returns an array of unordered stream objects.

Throws:

UnauthorizedException - If there is a security exception

NotFoundException - If the segment does not exist

BadRequestException - If the request is malformed

See Also:

StreamService.getSegmentStreams(Integer, StravaStreamResolutionType, StravaStreamSeriesDownsamplingType, javastrava.api.v3.model.reference.StravaStreamType...)