GET https://api.legendonlineservices.co.uk/SportsCourses/Search

Returns list of sports courses given range of search parameters

Request Parameters

From Query Type Description
PageNumber Int32 Optional. Default '0'
FacilityGUID Guid Optional. See Locations Only 'Facility Guid' is allowed. Either this or SeasonId/SeasonTypeId is required.
DisciplineId Int32 Optional. See Disciplines
DisciplineIds [Int32] Optional. See Disciplines. A list of disciplines to search for (includes the DisciplineId property if also supplied)
LevelId Int32 Optional. See Levels
Days Optional.
Values
0 - Sunday
1 - Monday
2 - Tuesday
3 - Wednesday
4 - Thursday
5 - Friday
6 - Saturday
StartFromDate DateTime Optional.
StartBeforeDate DateTime Optional.
VisibleFrom DateTime Optional. Visible From Date
StartHour Int32 Optional. Between 0 to 23 (inclusive)
EndHour Int32 Optional. Between 0 to 23 (inclusive)
Name String Optional. A whitespace seperated list of keywords to search for in the course name
CategoryId Int32 Optional. See Categories
CategoryIds [Int32] Optional. See Categories. A list of categories to search for (includes the CategoryId property if also supplied)
ShortCode String Optional.
SeasonId Int32 Optional. Season Id for a course. See Seasons. Either this or FacilityGUID/SeasonTypeId is required.
SeasonTypeId Int32 Optional. Season Type Id for a course. See Seasons. Either this or FacilityGUID/SeasonId is required.
AgeMonths Int32 Optional. Courses for this age based on any age restrictions (if set)
IgnoreVisibilityRules Boolean Optional. Ignore any configured visibility rules against the course

Response - (Status 200 - OK)

CourseSearchResult

Name Type Description
TotalResultsCount Int32 Total Records in the query
[CourseSearchResultItem]
Name Type Description
Id Int32 CourseId
AvailableCapacity Int32 Places left to Book (approximate)
BookableDaysFrom Int32 Days before the course is ready to book - If 'null' then there are no restrictions
BookableFrom DateTime Date the course is bookable from
CategoryIds [Int32] List of category Ids assigned to the course
CourseInventoryId Int32 Whole course inventory Id
DaysOfWeek [Int32] Days of the week which the course sessions are configured to occur on
DisciplineId Int32 Discipline of the course. See Disciplines
DropInInventoryId Int32 For drop in sessions
EnabledOnline Boolean Whether course is available online
EndDate DateTime End date of the course
Instructor String Course instructor
LevelId Int32 Level of the course. See Levels
Location String Course accounting location
MaxAgeMonths Int32 Max Age restriction to book this course
MinAgeMonths Int32 Min Age restriction to book this course
Name String Course name
NextSessionStartDate DateTime Start date of the next session (if any future sessions exist)
NumberOnWaitlist Int32 Number of people on the waiting list for this course
RemainingSessions Int32 Sessions left
SeasonId Int32 Season of the course. See Seasons
SeasonTypeId Int32 Season type of the course. See Seasons
SessionDuration Int32 Duration of a session in Minutes
SessionInventoryId Int32 Inventory Id to use when booking on number of sessions
SessionTime Int32 Start Time of a session in minutes e.g 13:30 = 810
ShortCode String Course short code
StartDate DateTime Start date of the course
TotalCapacity Int32 Total places allowed to book on this course
TotalSessions Int32 Number of sessions
VisibleDaysFrom Int32 Days before the course is visible to user - If 'null' then there are no restrictions
VisibleFrom DateTime Date the course is visible from 




{
  "Data": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "ShortCode": "sample string 3",
      "StartDate": "2025-04-25T14:16:01.6688233+01:00",
      "EndDate": "2025-04-25T14:16:01.6688233+01:00",
      "SessionTime": 4,
      "SessionDuration": 1,
      "AvailableCapacity": 5,
      "TotalSessions": 6,
      "Location": "sample string 7",
      "Instructor": "sample string 8",
      "MaxAgeMonths": 1,
      "MinAgeMonths": 1,
      "RemainingSessions": 9,
      "TotalCapacity": 10,
      "EnabledOnline": true,
      "BookableDaysFrom": 1,
      "VisibleDaysFrom": 1,
      "CourseInventoryId": 1,
      "SessionInventoryId": 1,
      "DropInInventoryId": 1,
      "NumberOnWaitlist": 1,
      "DaysOfWeek": [
        1,
        2,
        3
      ],
      "SeasonTypeId": 1,
      "SeasonId": 1,
      "DisciplineId": 1,
      "LevelId": 1,
      "NextSessionStartDate": "2025-04-25T14:16:01.6688233+01:00",
      "VisibleFrom": "2025-04-25T14:16:01.6688233+01:00",
      "BookableFrom": "2025-04-25T14:16:01.6688233+01:00",
      "CategoryIds": [
        1,
        2,
        3
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ShortCode": "sample string 3",
      "StartDate": "2025-04-25T14:16:01.6688233+01:00",
      "EndDate": "2025-04-25T14:16:01.6688233+01:00",
      "SessionTime": 4,
      "SessionDuration": 1,
      "AvailableCapacity": 5,
      "TotalSessions": 6,
      "Location": "sample string 7",
      "Instructor": "sample string 8",
      "MaxAgeMonths": 1,
      "MinAgeMonths": 1,
      "RemainingSessions": 9,
      "TotalCapacity": 10,
      "EnabledOnline": true,
      "BookableDaysFrom": 1,
      "VisibleDaysFrom": 1,
      "CourseInventoryId": 1,
      "SessionInventoryId": 1,
      "DropInInventoryId": 1,
      "NumberOnWaitlist": 1,
      "DaysOfWeek": [
        1,
        2,
        3
      ],
      "SeasonTypeId": 1,
      "SeasonId": 1,
      "DisciplineId": 1,
      "LevelId": 1,
      "NextSessionStartDate": "2025-04-25T14:16:01.6688233+01:00",
      "VisibleFrom": "2025-04-25T14:16:01.6688233+01:00",
      "BookableFrom": "2025-04-25T14:16:01.6688233+01:00",
      "CategoryIds": [
        1,
        2,
        3
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "ShortCode": "sample string 3",
      "StartDate": "2025-04-25T14:16:01.6688233+01:00",
      "EndDate": "2025-04-25T14:16:01.6688233+01:00",
      "SessionTime": 4,
      "SessionDuration": 1,
      "AvailableCapacity": 5,
      "TotalSessions": 6,
      "Location": "sample string 7",
      "Instructor": "sample string 8",
      "MaxAgeMonths": 1,
      "MinAgeMonths": 1,
      "RemainingSessions": 9,
      "TotalCapacity": 10,
      "EnabledOnline": true,
      "BookableDaysFrom": 1,
      "VisibleDaysFrom": 1,
      "CourseInventoryId": 1,
      "SessionInventoryId": 1,
      "DropInInventoryId": 1,
      "NumberOnWaitlist": 1,
      "DaysOfWeek": [
        1,
        2,
        3
      ],
      "SeasonTypeId": 1,
      "SeasonId": 1,
      "DisciplineId": 1,
      "LevelId": 1,
      "NextSessionStartDate": "2025-04-25T14:16:01.6688233+01:00",
      "VisibleFrom": "2025-04-25T14:16:01.6688233+01:00",
      "BookableFrom": "2025-04-25T14:16:01.6688233+01:00",
      "CategoryIds": [
        1,
        2,
        3
      ]
    }
  ],
  "TotalResultsCount": 1
}

Remarks

Only returns courses which are 'Published'
Page Size is 50
One of FacilityGUID, SeasonTypeId or SeasonId must be provided

Bundle(s)
SportsCourses