AthleteAPI (Strava API 1.0.4-SNAPSHOT API)

```
public interface AthleteAPI
```
API definitions for implementation of AthleteService

Author:

Dan Shannon

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`StravaAthlete`	`getAthlete(Integer athleteId)`
`void`	`getAthlete(Integer athleteId, StravaAPICallback<StravaAthlete> callback)`
`StravaAthlete`	`getAuthenticatedAthlete()`
`void`	`getAuthenticatedAthlete(StravaAPICallback<StravaAthlete> callback)`
`StravaAthleteZones`	`getAuthenticatedAthleteZones()` Returns the current athlete’s heart rate zones.
`void`	`getAuthenticatedAthleteZones(StravaAPICallback<StravaAthleteZones> callback)` Returns the current athlete’s heart rate zones.
`StravaAthlete[]`	`listAthleteFriends(Integer athleteId, Integer page, Integer perPage)`
`void`	`listAthleteFriends(Integer athleteId, Integer page, Integer perPage, StravaAPICallback<StravaAthlete[]> callback)`
`StravaSegmentEffort[]`	`listAthleteKOMs(Integer athleteId, Integer page, Integer perPage)`
`void`	`listAthleteKOMs(Integer athleteId, Integer page, Integer perPage, StravaAPICallback<StravaSegmentEffort[]> callback)`
`StravaAthlete[]`	`listAthletesBothFollowing(Integer athleteId, Integer page, Integer perPage)`
`void`	`listAthletesBothFollowing(Integer athleteId, Integer page, Integer perPage, StravaAPICallback<StravaAthlete[]> callback)`
`StravaAthlete[]`	`listAuthenticatedAthleteFriends(Integer page, Integer perPage)`
`void`	`listAuthenticatedAthleteFriends(Integer page, Integer perPage, StravaAPICallback<StravaAthlete[]> callback)`
`StravaStatistics`	`statistics(Integer athleteId)`
`void`	`statistics(Integer athleteId, StravaAPICallback<StravaStatistics> callback)`
`StravaAthlete`	`updateAuthenticatedAthlete(String city, String state, String country, StravaGender sex, Float weight)`
`void`	`updateAuthenticatedAthlete(String city, String state, String country, StravaGender sex, Float weight, StravaAPICallback<StravaAthlete> callback)`

Method Detail

getAthlete

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

Parameters:: athleteId - 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)

getAthlete

@GET(value="/athletes/{id}")
void getAthlete(@Path(value="id")
                                              Integer athleteId,
                                              StravaAPICallback<StravaAthlete> callback)
                                       throws NotFoundException

Parameters:: athleteId - Athlete identifier; callback - Callback to be executed once the call is completed
Throws:: NotFoundException - If the athlete doesn't exist
See Also:: AthleteService.getAthlete(java.lang.Integer)

getAuthenticatedAthlete
```
@GET(value="/athlete")
StravaAthlete getAuthenticatedAthlete()
```
Returns:

Full details of the authenticated athlete

See Also:

AthleteService.getAuthenticatedAthlete()

getAuthenticatedAthlete
```
@GET(value="/athlete")
void getAuthenticatedAthlete(StravaAPICallback<StravaAthlete> callback)
```
Parameters:

callback - Callback to be executed once the call is completed

See Also:

AthleteService.getAuthenticatedAthlete()

listAthleteFriends

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

Parameters:: athleteId - 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; BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAthleteFriends(Integer, javastrava.util.Paging)

listAthleteFriends

@GET(value="/athletes/{id}/friends")
void listAthleteFriends(@Path(value="id")
                                                              Integer athleteId,
                                                              @Query(value="page")
                                                              Integer page,
                                                              @Query(value="per_page")
                                                              Integer perPage,
                                                              StravaAPICallback<StravaAthlete[]> callback)
                                                       throws NotFoundException,
                                                              BadRequestException

Parameters:: athleteId - Athlete identifier; page - Page number to be returned (default is 1); perPage - Page size to be returned (default is 50); callback - Callback to be executed once the call is completed
Throws:: NotFoundException - If the athlete with the given id doesn't exist; BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAthleteFriends(Integer, javastrava.util.Paging)

listAthleteKOMs

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

Parameters:: athleteId - 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; BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAthleteKOMs(Integer, javastrava.util.Paging)

listAthleteKOMs

@GET(value="/athletes/{id}/koms")
void listAthleteKOMs(@Path(value="id")
                                                        Integer athleteId,
                                                        @Query(value="page")
                                                        Integer page,
                                                        @Query(value="per_page")
                                                        Integer perPage,
                                                        StravaAPICallback<StravaSegmentEffort[]> callback)
                                                 throws NotFoundException,
                                                        BadRequestException

Parameters:: athleteId - Athlete identifier; page - Page number to be returned (default is 1); perPage - Page size to be returned (default is 50); callback - Callback to be executed once the call is completed
Throws:: NotFoundException - If the athlete doesn't exist; BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAthleteKOMs(Integer, javastrava.util.Paging)

listAthletesBothFollowing

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

Parameters:: athleteId - 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; BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAthletesBothFollowing(Integer, javastrava.util.Paging)

listAthletesBothFollowing

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

Parameters:: athleteId - Athlete identifier; page - Page number to be returned (default is 1); perPage - Page size to be returned (default is 50); callback - Callback to be executed once the call is completed
Throws:: NotFoundException - If the athlete with the given id doesn't exist; BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAthletesBothFollowing(Integer, javastrava.util.Paging)

listAuthenticatedAthleteFriends

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

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
Throws:: BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAuthenticatedAthleteFriends(javastrava.util.Paging)

listAuthenticatedAthleteFriends

@GET(value="/athlete/friends")
void listAuthenticatedAthleteFriends(@Query(value="page")
                                                                     Integer page,
                                                                     @Query(value="per_page")
                                                                     Integer perPage,
                                                                     StravaAPICallback<StravaAthlete[]> callback)
                                                              throws BadRequestException

Parameters:: page - Page number to be returned (default is 1); perPage - Page size to be returned (default is 50); callback - Callback to be executed once the call is completed
Throws:: BadRequestException - If the paging instructions are invalid
See Also:: AthleteService.listAuthenticatedAthleteFriends(javastrava.util.Paging)

statistics

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

Parameters:: athleteId - Athlete identifier
Returns:: Statistics summary for the identified athlete
Throws:: NotFoundException - If the identified athlete doesn't exist
See Also:: AthleteService.statistics(Integer)

statistics

@GET(value="/athletes/{id}/stats")
void statistics(@Path(value="id")
                                                    Integer athleteId,
                                                    StravaAPICallback<StravaStatistics> callback)
                                             throws NotFoundException

Parameters:: athleteId - Athlete identifier; callback - Callback to be executed once the call is completed
Throws:: NotFoundException - If the identified athlete doesn't exist
See Also:: AthleteService.statistics(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)

updateAuthenticatedAthlete

@PUT(value="/athlete")
void 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,
                                                        StravaAPICallback<StravaAthlete> callback)

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; callback - Callback to be executed once the call is completed
See Also:: AthleteService.updateAuthenticatedAthlete(String, String, String, StravaGender, Float)

getAuthenticatedAthleteZones
```
@GET(value="/athlete/zones")
StravaAthleteZones getAuthenticatedAthleteZones()
```
Returns the current athlete’s heart rate zones. The min for Zone 1 is always 0 and the max for Zone 5 is always -1

Returns:

The athlete zones object

getAuthenticatedAthleteZones
```
@GET(value="/athlete/zones")
void getAuthenticatedAthleteZones(StravaAPICallback<StravaAthleteZones> callback)
```
Returns the current athlete’s heart rate zones. The min for Zone 1 is always 0 and the max for Zone 5 is always -1

Parameters:

callback - The callback used to return the asynchronous result

Interface AthleteAPI

Method Summary

Method Detail

getAthlete

getAthlete

getAuthenticatedAthlete

getAuthenticatedAthlete

listAthleteFriends

listAthleteFriends

listAthleteKOMs

listAthleteKOMs

listAthletesBothFollowing

listAthletesBothFollowing

listAuthenticatedAthleteFriends

listAuthenticatedAthleteFriends

statistics

statistics

updateAuthenticatedAthlete

updateAuthenticatedAthlete

getAuthenticatedAthleteZones

getAuthenticatedAthleteZones