Competitions

GET 
https://myswimmingclub.uk/api/competitions

Get information about all competitions.

Request

Header Parameters

X-Tenant integerrequired

The Tenant ID you are making the request for. You can find your Tenant ID by going to the /about page in the membership system. If you already have an access token for a user, you can find their Tenant ID by making a request to the /api/userinfo endpoint.

Responses

200

Paginated set of Competition

application/json

Schema

Schema

data object[]required
Array [
idintegerrequired
namestringrequired
Name of the competition.
venue_idintegerrequired
Id of the venue.
venue object
idintegerrequired
namestringrequired
Name of the venue.
descriptionstringrequired
longitudestringrequired
latitudestringrequired
websitestring | nullnullablerequired
phonestring | nullnullablerequired
google_maps_urlstring | nullnullablerequired
google_maps_place_idstring | nullnullablerequired
plus_code_globalstring | nullnullablerequired
plus_code_compoundstring | nullnullablerequired
vicinitystring | nullnullablerequired
formatted_addressstring | nullnullablerequired
address_componentsundefined[]required
html_attributionsundefined[]required
created_atdate-timenullablerequired
updated_atdate-timenullablerequired
sessions object[]
Array [
idintegerrequired
competition_idintegerrequired
namestringrequired
Name of the competition.
start_timedate-timerequired
end_timedate-timerequired
venue_idinteger | nullnullablerequired
Id of the venue for this session. When this field is not null, the default venue of the competition is overridden.
When this field is null, use the venue defined on the parent competition object.
venue object
Venue for this session. When this field is not null, the default venue of the competition is overridden.
When this field is null, use the venue defined on the parent competition object.
idintegerrequired
namestringrequired
Name of the venue.
descriptionstringrequired
longitudestringrequired
latitudestringrequired
websitestring | nullnullablerequired
phonestring | nullnullablerequired
google_maps_urlstring | nullnullablerequired
google_maps_place_idstring | nullnullablerequired
plus_code_globalstring | nullnullablerequired
plus_code_compoundstring | nullnullablerequired
vicinitystring | nullnullablerequired
formatted_addressstring | nullnullablerequired
address_componentsundefined[]required
html_attributionsundefined[]required
created_atdate-timenullablerequired
updated_atdate-timenullablerequired
events object[]
Array [
idintegerrequired
namestringrequired
Name of the event.
categoryCompetitionCategory (string)required
Competition category for the event
Possible values: [open, male, female, mixed, boy, girl]
distanceintegerrequired
strokeStroke (string)required
Possible values: [individual_medley, medley, freestyle, backstroke, breaststroke, butterfly, custom]
unitsDistanceUnits (string)required
metres Metres
yards Yards
feet Feet
Possible values: [metres, yards, feet]
agesundefined[]required
event_code objectrequired
anyOf
EventCode
integer
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 29, 37]
MOD2
event_numberinteger | nullnullablerequired
entry_feeintegerrequired
processing_feeintegerrequired
entrant_typeCompetitionEntrantType (string)required
I Individual event
T Team event
Possible values: [I, T]
roundCompetitionRound (string)required
H Heats
F Final
C Consolation (or 'B') Final
S Semi Final
Possible values: [H, F, C, S]
created_atdate-timenullablerequired
updated_atdate-timenullablerequired
]
created_atdate-timenullablerequired
updated_atdate-timenullablerequired
]
statusCompetitionStatus (string)required
draft Draft
published Published
paused Paused. Pause entries temporarily.
closed Closed
cancelled Cancelled
Possible values: [draft, published, paused, closed, cancelled]
publicbooleanrequired
processing_feeintegerrequired
default_entry_feeintegerrequired
files object[]
Array [
idstringrequired
public_namestringrequired
The name of the file to display in the UI.
competition_idintegerrequired
sequenceintegerrequired
The order in which to display files in the UI.
original_namestringrequired
The original name of the file when uploaded.
mime_typestringrequired
sizeintegerrequired
Size of the file in bytes.
publicbooleanrequired
Whether this file is downloadable by unauthenticated users.
download_linkstringrequired
The download link for the file. Please note the SCDS Membership software currently only supports downloads from the membership system. Using this link from any other website won't work.
created_atdate-timenullablerequired
updated_atdate-timenullablerequired
]
member_list_generatedboolean
Whether lists of members have been generated for sessions at this competition. The system uses these lists when generating registers.
created_atdate-timenullablerequired
updated_atdate-timenullablerequired
]
meta objectrequired
current_pageintegerrequired
frominteger | nullnullablerequired
last_pageintegerrequired
links object[]required
Generated paginator links.
Array [
urlstring | nullnullablerequired
labelstringrequired
activebooleanrequired
]
pathstring | nullnullablerequired
Base path for paginator generated URLs.
per_pageintegerrequired
Number of items shown per page.
tointeger | nullnullablerequired
Number of the last item in the slice.
totalintegerrequired
Total number of items being paginated.
links objectrequired
firststring | nullnullablerequired
laststring | nullnullablerequired
prevstring | nullnullablerequired
nextstring | nullnullablerequired

Example (auto)

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "venue_id": 0,
      "venue": {
        "id": 0,
        "name": "string",
        "description": "string",
        "longitude": "string",
        "latitude": "string",
        "address_components": [
          null
        ],
        "html_attributions": [
          null
        ]
      },
      "sessions": [
        {
          "id": 0,
          "competition_id": 0,
          "name": "string",
          "start_time": "2024-07-29T15:51:28.071Z",
          "end_time": "2024-07-29T15:51:28.071Z",
          "venue": {
            "id": 0,
            "name": "string",
            "description": "string",
            "longitude": "string",
            "latitude": "string",
            "address_components": [
              null
            ],
            "html_attributions": [
              null
            ]
          },
          "events": [
            {
              "id": 0,
              "name": "string",
              "category": "open",
              "distance": 0,
              "stroke": "individual_medley",
              "units": "metres",
              "ages": [
                null
              ],
              "event_code": 1,
              "entry_fee": 0,
              "processing_fee": 0,
              "entrant_type": "I",
              "round": "H"
            }
          ]
        }
      ],
      "status": "draft",
      "public": true,
      "processing_fee": 0,
      "default_entry_fee": 0,
      "files": [
        {
          "id": "string",
          "public_name": "string",
          "competition_id": 0,
          "sequence": 0,
          "original_name": "string",
          "mime_type": "string",
          "size": 0,
          "public": true,
          "download_link": "string"
        }
      ],
      "member_list_generated": true
    }
  ],
  "meta": {
    "current_page": 0,
    "last_page": 0,
    "links": [
      {
        "label": "string",
        "active": true
      }
    ],
    "per_page": 0,
    "total": 0
  },
  "links": {}
}

401

Unauthenticated

application/json

Schema

Schema

messagestringrequired

Error overview.

Example (auto)

{
  "message": "string"
}

403

Authorization error

application/json

Schema

Schema

messagestringrequired

Error overview.

Example (auto)

{
  "message": "string"
}

Authorization: http

name: httptype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://myswimmingclub.uk/api/competitions");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://myswimmingclub.uk/api

Auth

Bearer Token

Parameters

X-Tenant — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!