javastrava.api.v3.rest

Interface ActivityAPI

public interface ActivityAPI

API declarations of activity service endpoints

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaComment	createComment(Integer id, String text)
StravaActivity	createManualActivity(StravaActivity activity)
StravaActivity	deleteActivity(Integer id)
StravaResponse	deleteComment(Integer activityId, Integer commentId)
StravaActivity	getActivity(Integer id, Boolean includeAllEfforts)
StravaResponse	giveKudos(Integer activityId)
StravaComment[]	listActivityComments(Integer id, Boolean markdown, Integer page, Integer perPage)
StravaAthlete[]	listActivityKudoers(Integer id, Integer page, Integer perPage)
StravaLap[]	listActivityLaps(Integer id)
StravaPhoto[]	listActivityPhotos(Integer id)
StravaActivityZone[]	listActivityZones(Integer id)
StravaActivity[]	listAuthenticatedAthleteActivities(Integer before, Integer after, Integer page, Integer perPage)
StravaActivity[]	listFriendsActivities(Integer page, Integer perPage)
StravaActivity[]	listRelatedActivities(Integer id, Integer page, Integer perPage)
StravaActivity	updateActivity(Integer id, StravaActivityUpdate activity)

Method Detail

getActivity

@GET(value="/activities/{id}")
StravaActivity getActivity(@Path(value="id")
                                                           Integer id,
                                                           @Query(value="include_all_efforts")
                                                           Boolean includeAllEfforts)
                                                    throws NotFoundException

Parameters:

id - The id of the activity to be returned

includeAllEfforts - (Optional) Used to include all segment efforts in the result (if omitted or false then only "important" efforts are returned).

Returns:

Returns a detailed representation if the activity is owned by the requesting athlete. Returns a summary representation for all other requests.

Throws:

NotFoundException - If the activity does not exist

createManualActivity

@POST(value="/activities")
StravaActivity createManualActivity(@Body
                                                                StravaActivity activity)
                                                         throws BadRequestException

Parameters:

activity - The activity to be created on Strava

Returns:

The activity as stored by Strava

Throws:

BadRequestException - If the activity is malformed and can't be uploaded

See Also:

ActivityService.createManualActivity(javastrava.api.v3.model.StravaActivity)

updateActivity

@PUT(value="/activities/{id}")
StravaActivity updateActivity(@Path(value="id")
                                                              Integer id,
                                                              @Body
                                                              StravaActivityUpdate activity)
                                                       throws NotFoundException

Parameters:

id - The id of the activity to update

activity - The activity details

Returns:

The activity as stored on Strava

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.updateActivity(Integer, StravaActivityUpdate)

deleteActivity

@DELETE(value="/activities/{id}")
StravaActivity deleteActivity(@Path(value="id")
                                                                 Integer id)
                                                          throws NotFoundException

Parameters:

id - Activity identifier

Returns:

Activity that has been successfully deleted from Strava

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.deleteActivity(java.lang.Integer)

listAuthenticatedAthleteActivities

@GET(value="/athlete/activities")
StravaActivity[] listAuthenticatedAthleteActivities(@Query(value="before")
                                                                                       Integer before,
                                                                                       @Query(value="after")
                                                                                       Integer after,
                                                                                       @Query(value="page")
                                                                                       Integer page,
                                                                                       @Query(value="per_page")
                                                                                       Integer perPage)

Parameters:

before - Unix epoch time in seconds - return activities before this time

after - Unix epoch time in seconds - return activities after this time

page - Page number to be returned

perPage - Page size to be returned

Returns:

List of Strava activities in the given time frame

See Also:

ActivityService.listAuthenticatedAthleteActivities(java.util.Calendar, java.util.Calendar, javastrava.util.Paging)

listFriendsActivities

@GET(value="/activities/following")
StravaActivity[] listFriendsActivities(@Query(value="page")
                                                                            Integer page,
                                                                            @Query(value="per_page")
                                                                            Integer perPage)

Parameters:

page - Page number to be returned

perPage - Page size to be returned

Returns:

List of Strava activities belonging to friends of the authenticated athlete

See Also:

ActivityService.listFriendsActivities(javastrava.util.Paging)

listActivityZones

@GET(value="/activities/{id}/zones")
StravaActivityZone[] listActivityZones(@Path(value="id")
                                                                             Integer id)
                                                                      throws NotFoundException

Parameters:

id - The activity identifier

Returns:

Array of activity zones for the activity

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.listActivityZones(java.lang.Integer)

listActivityLaps

@GET(value="/activities/{id}/laps")
StravaLap[] listActivityLaps(@Path(value="id")
                                                                  Integer id)
                                                           throws NotFoundException

Parameters:

id - The activity identifier

Returns:

Array of laps belonging to the activity

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.listActivityLaps(java.lang.Integer)

listActivityComments

@GET(value="/activities/{id}/comments")
StravaComment[] listActivityComments(@Path(value="id")
                                                                              Integer id,
                                                                              @Query(value="markdown")
                                                                              Boolean markdown,
                                                                              @Query(value="page")
                                                                              Integer page,
                                                                              @Query(value="per_page")
                                                                              Integer perPage)
                                                                       throws NotFoundException

Parameters:

id - Activity identifier

markdown - Whether or not to return comments including markdown

page - Page number to be returned

perPage - Page size to be returned

Returns:

Array of comments belonging to the activity

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.listActivityComments(Integer, Boolean, javastrava.util.Paging)

listActivityKudoers

@GET(value="/activities/{id}/kudos")
StravaAthlete[] listActivityKudoers(@Path(value="id")
                                                                          Integer id,
                                                                          @Query(value="page")
                                                                          Integer page,
                                                                          @Query(value="per_page")
                                                                          Integer perPage)
                                                                   throws NotFoundException

Parameters:

id - Activity identifier

page - Page number to be returned

perPage - Page size to be returned

Returns:

Array of athletes who have kudoed the activity

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.listActivityKudoers(Integer, javastrava.util.Paging)

listActivityPhotos

@GET(value="/activities/{id}/photos")
StravaPhoto[] listActivityPhotos(@Path(value="id")
                                                                        Integer id)
                                                                 throws NotFoundException

Parameters:

id - Activity identifier

Returns:

Array of photos attached to the activity

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.listActivityPhotos(java.lang.Integer)

listRelatedActivities

@GET(value="/activities/{id}/related")
StravaActivity[] listRelatedActivities(@Path(value="id")
                                                                               Integer id,
                                                                               @Query(value="page")
                                                                               Integer page,
                                                                               @Query(value="per_page")
                                                                               Integer perPage)
                                                                        throws NotFoundException

Parameters:

id - Activity identifier

page - Page number to be returned

perPage - Page size to be returned

Returns:

Array of activities that Strava judges was 'done with' the activity identified by the id

Throws:

NotFoundException - If the activity doesn't exist

See Also:

ActivityService.listRelatedActivities(java.lang.Integer, javastrava.util.Paging)

createComment

@POST(value="/activities/{id}/comments")
StravaComment createComment(@Path(value="id")
                                                                      Integer id,
                                                                      @Query(value="text")
                                                                      String text)
                                                               throws BadRequestException,
                                                                      NotFoundException

Parameters:

id - Activity identifier

text - Text of the comment to create

Returns:

The comment as posted

Throws:

NotFoundException - If the activity does not exist

BadRequestException - If the comment text is null or the empty string

See Also:

ActivityService.createComment(Integer, String)

deleteComment

@DELETE(value="/activities/{activityId}/comments/{commentId}")
StravaResponse deleteComment(@Path(value="activityId")
                                                                                             Integer activityId,
                                                                                             @Path(value="commentId")
                                                                                             Integer commentId)
                                                                                      throws NotFoundException

Parameters:

activityId - Id of the activity the comment was posted to

commentId - Id of the comment

Returns:

Strava response

Throws:

NotFoundException - If the comment does not exist

See Also:

ActivityService.deleteComment(Integer, Integer)

giveKudos

@POST(value="/activities/{id}/kudos")
StravaResponse giveKudos(@Path(value="id")
                                                                Integer activityId)
                                                         throws NotFoundException

Parameters:

activityId - Activity to be kudoed

Returns:

Strava response

Throws:

NotFoundException - if the activity does not exist

See Also:

ActivityService.giveKudos(Integer)