GET api/settings
Lists settings
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
UserSettings| Name | Description | Type | Additional information |
|---|---|---|---|
| apply_age_limits |
Gets if apply age limits to Club records. Clubs only. |
boolean |
None. |
| club_competitions_qualifies_for_records |
Gets if club competitions qualifies for club records. Clubs only. |
boolean |
None. |
| club_name |
Gets the name of the club. |
string |
None. |
| user_name |
Gets the name of the user. |
string |
None. |
| editing_allowed |
Gets if editing of scores allowed. |
boolean |
None. |
| exclude_2020_outdoor_season |
Gets if exclude the 2020 outdoor season is set. Clubs only. |
boolean |
None. |
| maintain_separate_club_records |
Gets if maintain separate club records is set. Clubs only |
boolean |
None. |
| practice_qualifies_for_records |
Gets if practice qualifies for club records. Clubs only |
boolean |
None. |
| score_xs |
Gets if score Xs is set. |
boolean |
None. |
| scores_must_be_approved |
Gets if scores must be approved by the Club. |
boolean |
None. |
| scoresheet_required |
Gets if a scoresheet is required by the club. |
boolean |
None. |
| season_name_style |
Gets the season name style. |
SeasonOptions |
None. |
| strict_rules |
Gets if Archery GB strict rules is set. |
boolean |
None. |
| submission_allowed |
Gets if score submission is allowed by the club. |
boolean |
None. |
| use_age_groups_for_clubrecords |
Gets if use age groups for splitting club records is set. |
boolean |
None. |
| user_1_alias |
Gets the alias for the first user defined field. |
string |
None. |
| user_2_alias |
Gets the alias for the second user defined field. |
string |
None. |
Response Formats
application/json, text/json
{
"apply_age_limits": true,
"club_competitions_qualifies_for_records": true,
"club_name": "sample string 3",
"user_name": "sample string 4",
"editing_allowed": true,
"exclude_2020_outdoor_season": true,
"maintain_separate_club_records": true,
"practice_qualifies_for_records": true,
"score_xs": true,
"scores_must_be_approved": true,
"scoresheet_required": true,
"season_name_style": 1,
"strict_rules": true,
"submission_allowed": true,
"use_age_groups_for_clubrecords": true,
"user_1_alias": "sample string 15",
"user_2_alias": "sample string 16"
}
multipart/form-data
{"apply_age_limits":true,"club_competitions_qualifies_for_records":true,"club_name":"sample string 3","user_name":"sample string 4","editing_allowed":true,"exclude_2020_outdoor_season":true,"maintain_separate_club_records":true,"practice_qualifies_for_records":true,"score_xs":true,"scores_must_be_approved":true,"scoresheet_required":true,"season_name_style":1,"strict_rules":true,"submission_allowed":true,"use_age_groups_for_clubrecords":true,"user_1_alias":"sample string 15","user_2_alias":"sample string 16"}
application/xml, text/xml
<UserSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Archery_Records_API.Models"> <apply_age_limits>true</apply_age_limits> <club_competitions_qualifies_for_records>true</club_competitions_qualifies_for_records> <club_name>sample string 3</club_name> <editing_allowed>true</editing_allowed> <exclude_2020_outdoor_season>true</exclude_2020_outdoor_season> <maintain_separate_club_records>true</maintain_separate_club_records> <practice_qualifies_for_records>true</practice_qualifies_for_records> <score_xs>true</score_xs> <scores_must_be_approved>true</scores_must_be_approved> <scoresheet_required>true</scoresheet_required> <season_name_style>Indoor_Outdoor</season_name_style> <strict_rules>true</strict_rules> <submission_allowed>true</submission_allowed> <use_age_groups_for_clubrecords>true</use_age_groups_for_clubrecords> <user_1_alias>sample string 15</user_1_alias> <user_2_alias>sample string 16</user_2_alias> <user_name>sample string 4</user_name> </UserSettings>