Course Scope

API Documentation

Course Scope

The Course Scope API provides information about which franchise sites are subscribing to which courses and at what price specific to the franchise.

Endpoint:

Get /
GET /Course/scope

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 unique Identifier.

SiteID Int(Not Nullable)

ID of Franchise site, e.g.

“12966” relates to “Athens – Greece”

OwnerID Int(Not Nullable)

Identifier of the course owner

IsAllOwnedSites Boolean(Nullable)

Flag to check if the site is owned

Price Float(Not Nullable)

Cost

IsCustomPrice Boolean(Nullable)

Flag for custom cost

				
					{
  "totalPages": 3,
  "currentPage": 1,
  "scopes": [
    {
      "CourseID": "1035992364",
      "SiteID": 12966,
      "OwnerID": 151,
      "IsAllOwnedSites": false,
      "Price": 99.99,
      "IsCustomPrice": false
    }
  ]
}