Class Event

API Documentation

Class Event

The Class Event API provides scheduled classes related to the courses, including identifiers showing which franchises are selling and delivering the classes.

Endpoint:

Get /
/Class/Event

Request Parameters

Page Int (Optional)

Specifies the page number of results to retrieve. Default is 1

Limit Int (Optional)

Specifies the maximum number of results per page. Default is 10.

Response

CourseId Int(Not Nullable)

The Id of the course

ClassId Int(Not Nullable)

The Id of the class (Unique Identifier)

OwnerId Int(Not Nullable)

ID of Franchise GROUP that owns the class e.g. “151” relates to Siathas Greece Group

SiteId Int(Not Nullable)

ID of Franchise site, e.g. “12966” relates to “Athens – Greece”

SiteCode String(Nullable)

char text code for Site, e.g. “ATS” relates to “Athens – Greece”

SiteName String(Not Nullable)

Readable name of class Site

Core Object(Not Nullable)

Details of the core category, type,
etc

Name String(Not Nullable)

Name of class event, e.g the course title, “Excel 2019 – Part 1”

StartDateTime DateTime(Not Nullable)

when class starts, e.g. 2024-06- 03T18:00:00 (SQL datetime format, both date and time)

EndDateTime DateTime(Not Nullable)

when class ends, e.g. 2024-06- 06T20:00:00

StartDate DateTime(Not Nullable)

date component, no time, e.g. 2024-06-03

EndDate DateTime(Not Nullable)

date component, no time, e.g. 2024-06-06

StartTime DateTime(Not Nullable)

class start time, time component only, e.g. 18:00

EndTime DateTime(Not Nullable)

class end time, time component only, e.g. 20:00

MPL VarChar (Nullable)

MasterProductList code, e.g.

“NH91078S-OLL”

CMSClassNumber VarChar (Not Nullable)

dentifier used in LMS that includes site codes and modality, e.g. “ATS- NCO_LMS_1836498_OLL”

Cancelled Boolean(Nullable)

The class is cancelled or still active

Price Float(Nullable)

Cost

ModalityID Int(Nullable)

integer that indicates delivery method ex: 2

Modality String(Nullable)

text version of delivery method,

e.g. “OLL” (online Live)

GTR Boolean(Nullable)

Boolean flag – is this class Guaranteed to Run or not.

HostingSiteId Int(Nullable)

franchise Site ID where class is

being hosted from, e.g. “7934”

HostingSiteCode Int(Nullable)

3-letter code for hosting site, e.g.

“NCO”

FranchiseID Int(Nullable)

Identifier for overall franchise

				
					{
  "totalPages": 5,
  "currentPage": 1,
  "events": [
    {
      "CourseID": "1035992364",
      "ClassID": "2012966000038552300",
      "OwnerID": 151,
      "SiteID": 12966,
      "SiteCode": "ATS",
      "SiteName": "Athens",
      "Core": "...",
      "Name": "Excel 2019 - Part 1",
      "StartDateTime": "2024-06-03T18:00:00",
      "EndDateTime": "2024-06-06T20:00:00",
      "StartDate": "2024-06-03",
      "EndDate": "2024-06-06",
      "StartTime": "18:00",
      "EndTime": "20:00",
      "MPL": "NH91078S-OLL",
      "CMSClassNumber": "ATS-NCO_LMS_1836498_OLL",
      "Cancelled": false,
      "Price": "...",
      "ModalityID": 2,
      "Modality": "OLL",
      "GTR": true,
      "HostingSiteID": 7934,
      "HostingSiteCode": "NCO",
      "FranchiseID": "..."
    }
  ]
}