Introduction
This API provides access to data held within Golden Records Online by means of various end points which are detailed below along with the methods for interacting with them.
See also our Swagger. Swagger
AchievementList
This end point handles the master list of achievements. Clubs Only
| API | Description |
|---|---|
| GET api/achievementslist?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all available achievements. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| POST api/achievementslist?achievement={achievement} |
Adds an achievement to the master list. |
| PUT api/achievementslist?achievement_id={achievement_id}&achievement={achievement} |
Edits and achievement. |
| DELETE api/achievementslist?achievement_id={achievement_id} |
Deletes the achievement described by achievement_id. |
Achievements
This end point handles Achievements
| API | Description |
|---|---|
| GET api/achievements?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all achievements. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| POST api/achievements |
No documentation available... |
| PUT api/achievements?achievement_id={achievement_id} |
No documentation available... |
| DELETE api/achievements?achievement_id={achievement_id} |
Deletes an achievement from the database. The achievement is defined by its unique id |
| GET api/Achievements?filter_id={filter_id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists achievements filtered by the provided id in GUID format. For example class_id will list all achievements with that class id. |
AgeGroups
This end point handles Age Groups. Clubs Only
| API | Description |
|---|---|
| GET api/age-groups?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all age groups. |
| POST api/age-groups |
Adds an age group to the master list. |
| PUT api/age-groups?age_group_id={age_group_id} |
Updates an age group in the database given the age_group_id of the category |
| DELETE api/age-groups?age_group_id={age_group_id} |
Deletes an age group from the database. The age group is defined by its age_group_id |
Classes
This end point handles bow classes.
| API | Description |
|---|---|
| GET api/classes?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all classes. |
| POST api/classes |
Adds a new bow class to the database. |
| PUT api/classes?class_id={class_id} |
Updates a bow class in the master list given the class_id of the bow class |
| DELETE api/classes?class_id={class_id} |
Deletes a single bow class from the database. The bow class is defined by its unique class_id |
Classifications
This end point handles classifications. UK Only
| API | Description |
|---|---|
| GET api/classifications?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all classifications. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/classifications?id={id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists all classifications filtered by the provided id in GUID format. For example class_id will list all classifications with that class id. |
ClubRecords
This end point handles club records.
| API | Description |
|---|---|
| GET api/clubrecords?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all club records. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/clubrecords?filter_id={filter_id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists club records filtered by the provided id in GUID format. For example class_id will list all club records with that class id. |
| POST api/clubrecords |
Adds a club record to the database. |
| PUT api/clubrecords?record_id={record_id} |
Updates a club record in the database given the unique record_id of the score record |
| DELETE api/clubrecords?record_id={record_id} |
Deletes a single club record from the database. The score record is defined by its record_id |
CurrentClassifications
This end point handles current classifications (classifications within the current season(s)) UK Only.
| API | Description |
|---|---|
| GET api/currentclassifications?pageNumber={pageNumber}&pageSize={pageSize} |
Lists current classifications. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/currentclassifications?id={id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists current classifications filtered by the provided id in GUID format. For example class_id will list all current classifications with that class id. |
CurrentHandicaps
This end point handles current handicaps (handicaps within the current season(s)). UK Only
| API | Description |
|---|---|
| GET api/currenthandicaps?pageNumber={pageNumber}&pageSize={pageSize} |
Lists current handicaps. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/currenthandicaps?id={id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists current handicaps filtered by the provided id in GUID format. For example class_id will list all current handicaps with that class id. |
Distances
This end point lists distances. Only for Club Members and Personal users.
| API | Description |
|---|---|
| GET api/Distances |
Lists all distances. |
Equipment
This end point lists archer equipment. Only for Club Members and Personal users
| API | Description |
|---|---|
| GET api/arrows |
Gets the list of arrows. |
| GET api/bows |
No documentation available... |
| POST api/bows?bow={bow} |
No documentation available... |
| POST api/arrows?arrows={arrows} |
No documentation available... |
| DELETE api/bows?bow={bow} |
No documentation available... |
| DELETE api/arrows?arrows={arrows} |
No documentation available... |
Faces
| API | Description |
|---|---|
| GET api/Faces |
Lists all faces. |
Handicaps
| API | Description |
|---|---|
| GET api/handicaps?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all handicaps. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/handicaps?id={id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists all handicaps filtered by the provided id in GUID format. For example class_id will list all handicaps with that class id. |
Lookups
| API | Description |
|---|---|
| GET api/lookups/rounds |
Lists all available round values used to retrieve handicaps and classifications |
| GET api/lookups/classes |
Lists all available class values used to retrieve handicaps and classifications |
| GET api/lookups/age_groups |
Lists all available category values used to retrieve classifications |
Members
| API | Description |
|---|---|
| GET api/members?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all members. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/members?id={id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists member data by the provided id in GUID format. For example class_id will list all member records with that class id. |
| POST api/members |
Adds a member to the database. |
| PUT api/members?member_id={member_id} |
Updates aa member in the database given the member_id of the member |
| DELETE api/members?member_id={member_id}&retain_club_records={retain_club_records} |
Deletes a member from the database. The member is defined by the member_id |
PersonalBests
| API | Description |
|---|---|
| GET api/personalbests?pageNumber={pageNumber}&pageSize={pageSize} |
Lists ranked member personal bests. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
Rounds
| API | Description |
|---|---|
| GET api/rounds?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all rounds. |
| POST api/rounds |
Adds a round to the master list. |
| PUT api/rounds?round_id={round_id} |
Updates a round in the master list given the round_id of the round |
| DELETE api/rounds?round_id={round_id} |
Deletes a single round from the database. The round is defined by its round_id |
Scores
| API | Description |
|---|---|
| GET api/scores?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all score records. Maximum 1000 records per page. Specify desired page {pageNumber}and number of records per page {pageSize}. Number of pages is returned in headers. |
| GET api/scores?id={id}&pageNumber={pageNumber}&pageSize={pageSize} |
Lists all score records filtered by the provided id in GUID format. For example class_id will list all score records with that class id. |
| POST api/scores |
Adds a score to the database. Score only can be submitted as application/json or application/xml To add a scoresheet: Include score as score object in request body as multi part form data. The file must be first. |
| PUT api/scores?record_id={record_id} |
Edits a score in the database given its record_id. Score only can be submitted as application/json or application/xml To replace a scoresheet: Include score as score object in request body as multi part form data. The file must be first. |
| DELETE api/scores?record_id={record_id} |
Deletes a single score record from the database. The score record is defined by its record_id |
Scoresheets
| API | Description |
|---|---|
| GET api/Scoresheets?record_id={record_id} |
Lists all scoresheets for the given id of a score record. |
| POST api/Scoresheets?record_id={record_id}&member_id={member_id} |
Uploads scoresheets and results (maximum 4 files). Replaces all previous uploads for this record id |
| PUT api/Scoresheets?record_id={record_id}&meta_id={meta_id}&member_id={member_id} |
Uploads single scoresheet to replace one with a given meta id |
| DELETE api/Scoresheets?record_id={record_id}&meta_id={meta_id} |
Deletes a single scoresheet. The scoreshseet is defined by meta id and the recordid |
Seasons
| API | Description |
|---|---|
| GET api/seasons?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all seasons. |
Settings
| API | Description |
|---|---|
| GET api/settings |
Lists settings |
Types
| API | Description |
|---|---|
| GET api/types?pageNumber={pageNumber}&pageSize={pageSize} |
Lists all archery types. |
| POST api/types?type={type} |
Adds an archery type to the database. |
| PUT api/types?type_id={type_id}&type={type} |
Updates an archery type in the database given the type_id of the type |
| DELETE api/types?type_id={type_id} |
Deletes a single archery type from the database. The type is defined by its unique type_id |