javastrava.api.v3.rest

Interface AthleteAPI

public interface AthleteAPI

API definitions for implementation of AthleteService

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaAthlete	getAthlete(Integer id)
StravaAthlete	getAuthenticatedAthlete()
StravaAthlete[]	listAthleteFriends(Integer id, Integer page, Integer perPage)
StravaSegmentEffort[]	listAthleteKOMs(Integer id, Integer page, Integer perPage)
StravaAthlete[]	listAthletesBothFollowing(Integer id, Integer page, Integer perPage)
StravaAthlete[]	listAuthenticatedAthleteFriends(Integer page, Integer perPage)
StravaStatistics	statistics(Integer id)
StravaAthlete	updateAuthenticatedAthlete(String city, String state, String country, StravaGender sex, Float weight)

Method Detail

getAuthenticatedAthlete

@GET(value="/athlete")
StravaAthlete getAuthenticatedAthlete()

Returns:

Full details of the authenticated athlete

See Also:

AthleteService.getAuthenticatedAthlete()

getAthlete

@GET(value="/athletes/{id}")
StravaAthlete getAthlete(@Path(value="id")
                                                       Integer id)
                                                throws NotFoundException

Parameters:

id - Athlete identifier

Returns:

Details of the athlete, will be somewhat anonymised if the athlete is private

Throws:

NotFoundException - If the athlete doesn't exist

See Also:

AthleteService.getAthlete(java.lang.Integer)

updateAuthenticatedAthlete

@PUT(value="/athlete")
StravaAthlete updateAuthenticatedAthlete(@Query(value="city")
                                                                 String city,
                                                                 @Query(value="state")
                                                                 String state,
                                                                 @Query(value="country")
                                                                 String country,
                                                                 @Query(value="sex")
                                                                 StravaGender sex,
                                                                 @Query(value="weight")
                                                                 Float weight)

Parameters:

city - City the athlete is from

state - State/county/territory/canton/departement/whatever the athlete is from

country - Country the athlete is from

sex - Gender of the athlete

weight - Weight in kilograms

Returns:

Athlete details as updated on Strava

See Also:

AthleteService.updateAuthenticatedAthlete(String, String, String, StravaGender, Float)

listAthleteKOMs

@GET(value="/athletes/{id}/koms")
StravaSegmentEffort[] listAthleteKOMs(@Path(value="id")
                                                                         Integer id,
                                                                         @Query(value="page")
                                                                         Integer page,
                                                                         @Query(value="per_page")
                                                                         Integer perPage)
                                                                  throws NotFoundException

Parameters:

id - Athlete identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of segment efforts which represent the athlete's KOM/QOM's

Throws:

NotFoundException - If the athlete doesn't exist

See Also:

AthleteService.listAthleteKOMs(Integer, javastrava.util.Paging)

listAuthenticatedAthleteFriends

@GET(value="/athlete/friends")
StravaAthlete[] listAuthenticatedAthleteFriends(@Query(value="page")
                                                                                Integer page,
                                                                                @Query(value="per_page")
                                                                                Integer perPage)

Parameters:

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of athletes who the authenticated athlete is following

See Also:

AthleteService.listAuthenticatedAthleteFriends(javastrava.util.Paging)

listAthleteFriends

@GET(value="/athletes/{id}/friends")
StravaAthlete[] listAthleteFriends(@Path(value="id")
                                                                         Integer id,
                                                                         @Query(value="page")
                                                                         Integer page,
                                                                         @Query(value="per_page")
                                                                         Integer perPage)
                                                                  throws NotFoundException

Parameters:

id - Athlete identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of athletes who the identified athlete is following

Throws:

NotFoundException - If the athlete with the given id doesn't exist

See Also:

AthleteService.listAthleteFriends(Integer, javastrava.util.Paging)

listAthletesBothFollowing

@GET(value="/athletes/{id}/both-following")
StravaAthlete[] listAthletesBothFollowing(@Path(value="id")
                                                                                       Integer id,
                                                                                       @Query(value="page")
                                                                                       Integer page,
                                                                                       @Query(value="per_page")
                                                                                       Integer perPage)
                                                                                throws NotFoundException

Parameters:

id - Athlete identifier

page - Page number to be returned (default is 1)

perPage - Page size to be returned (default is 50)

Returns:

Array of athletes who both the identified athlete and the authenticated athlete are following

Throws:

NotFoundException - If the athlete with the given id doesn't exist

See Also:

AthleteService.listAthletesBothFollowing(Integer, javastrava.util.Paging)

statistics

@GET(value="/athletes/{id}/stats")
StravaStatistics statistics(@Path(value="id")
                                                                Integer id)
                                                         throws NotFoundException

Parameters:

id - Athlete identifier

Returns:

Statistics summary for the identified athlete

Throws:

NotFoundException - If the identified athlete doesn't exist

See Also:

AthleteService.statistics(Integer)