javastrava.api.v3.rest

Interface ClubAPI

public interface ClubAPI

API definition of the endpoints for club services

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaClub	getClub(Integer id)
StravaClubMembershipResponse	join(Integer id)
StravaClubMembershipResponse	leave(Integer id)
StravaClub[]	listAuthenticatedAthleteClubs()
StravaAthlete[]	listClubMembers(Integer id, Integer page, Integer perPage)
StravaActivity[]	listRecentClubActivities(Integer id, Integer page, Integer perPage)

Method Detail

getClub

@GET(value="/clubs/{id}")
StravaClub getClub(@Path(value="id")
                                              Integer id)
                                       throws NotFoundException

Parameters:

id - Club identifier

Returns:

Club details

Throws:

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

See Also:

ClubService.getClub(java.lang.Integer)

listAuthenticatedAthleteClubs

@GET(value="/athlete/clubs")
StravaClub[] listAuthenticatedAthleteClubs()

Returns:

Array of clubs that the authenticated athlete belongs to

See Also:

ClubService.listAuthenticatedAthleteClubs()

listClubMembers

@GET(value="/clubs/{id}/members")
StravaAthlete[] listClubMembers(@Path(value="id")
                                                                   Integer id,
                                                                   @Query(value="page")
                                                                   Integer page,
                                                                   @Query(value="per_page")
                                                                   Integer perPage)
                                                            throws NotFoundException

Parameters:

id - CLub identifier

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

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

Returns:

Array of athletes who are members of the identified club

Throws:

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

See Also:

ClubService.listClubMembers(Integer, javastrava.util.Paging)

listRecentClubActivities

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

Parameters:

id - Club identifier

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

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

Returns:

Array of activities recently done by club members (maximum 200 will be returned)

Throws:

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

See Also:

ClubService.listRecentClubActivities(Integer, javastrava.util.Paging)

join

@POST(value="/clubs/{id}/join")
StravaClubMembershipResponse join(@Path(value="id")
                                                                   Integer id)
                                                            throws NotFoundException

Parameters:

id - The club the authenticated athlete wishes to join

Returns:

Membership response indicating success/failure

Throws:

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

See Also:

ClubService.joinClub(java.lang.Integer)

leave

@POST(value="/clubs/{id}/leave")
StravaClubMembershipResponse leave(@Path(value="id")
                                                                     Integer id)
                                                              throws NotFoundException

Parameters:

id - The club the authenticated athlete wishes to leave

Returns:

Membership response indicating success/failure

Throws:

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

See Also:

ClubService.leaveClub(java.lang.Integer)