GET api/CourseSchedule?type={type}&keyword={keyword}&instructorID={instructorID}&instructor={instructor}&categorycode={categorycode}&topiccode={topiccode}&govbody={govbody}&pricelow={pricelow}&pricehigh={pricehigh}&creditslow={creditslow}&creditshigh={creditshigh}&classdatestart={classdatestart}&classdateend={classdateend}&passeligible={passeligible}&bcpeeligible={bcpeeligible}&sstype={sstype}&releasedatestart={releasedatestart}&revisionage={revisionage}&take={take}&skip={skip}&sort={sort}&desc={desc}

Gets a list of Course Schedule objects based upon the filter parameters. Queries only ACTIVE Products and Events from aoCourse.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
type

Pipe separated list of the following: SS|WC|LIVE

string

None.

keyword

Keywords will search the Title, Course Description, Learning Objectives,

string

None.

instructorID

Pipe separated list of Instructor GUIDs: 023B78A1-CE00-4308-BB23-9DB714C811DF|etc...

string

None.

instructor

Example: Vern

string

None.

categorycode

Pipe separated list of NASBA Category Codes: ACT|AUD|COM|etc...

string

None.

topiccode

Pipe separated list of Marketing Topics: MACT|MAUD|MFTU_C|etc...

string

None.

govbody

Pipe separated list of Governing body flags: IRS|CTEC|CAFRAUD|CFP

string

None.

pricelow

Example: 19.00

decimal number

None.

pricehigh

Example: 99.00

decimal number

None.

creditslow

Examples: 1, 2, 3, 4, 5, 6...

integer

None.

creditshigh

Examples: 1, 2, 3, 4, 5, 6...

integer

None.

classdatestart

Example: 1/1/2017

date

None.

classdateend

Example: 12/31/2017

date

None.

passeligible

If Pass is Eligible: 1 for true, 0 for false, (blank) to ignore

integer

None.

bcpeeligible

If Bonus CPE is Eligible: 1 for true, 0 for false, (blank) to ignore

integer

None.

sstype

Limits the results to Self-Study only with sub-format: ONL or HC or VID

string

None.

releasedatestart

Example: 12/31/2017

date

None.

revisionage

Value is in days, returns results for revision date less than number of days

integer

None.

take

Start index of the query

integer

None.

skip

Start index of the query

integer

None.

sort

Sort the data by the following options: Title, Credits, Price, Instructor, ClassDate, ReleaseDate

string

None.

desc

Sort descending: 0 = false (default), 1 = true

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of aoCourseSchedule
NameDescriptionTypeAdditional information
ProductCode

string

None.

CoursePage

string

None.

Title

string

None.

Location

string

None.

EventDate

date

None.

EventTime

string

None.

Type

string

None.

Instructor

string

None.

InstructorPage

string

None.

Category

string

None.

Credits

integer

None.

InstructorID

globally unique identifier

None.

CategoryCode

string

None.

Price

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ProductCode": "sample string 1",
    "CoursePage": "sample string 2",
    "Title": "sample string 3",
    "Location": "sample string 4",
    "EventDate": "2017-09-24T08:04:12.4091195-04:00",
    "EventTime": "sample string 5",
    "Type": "sample string 6",
    "Instructor": "sample string 7",
    "InstructorPage": "sample string 8",
    "Category": "sample string 9",
    "Credits": 1,
    "InstructorID": "273d8e99-ad49-4a11-9be2-bcf8a758a802",
    "CategoryCode": "sample string 10",
    "Price": 1.0
  },
  {
    "ProductCode": "sample string 1",
    "CoursePage": "sample string 2",
    "Title": "sample string 3",
    "Location": "sample string 4",
    "EventDate": "2017-09-24T08:04:12.4091195-04:00",
    "EventTime": "sample string 5",
    "Type": "sample string 6",
    "Instructor": "sample string 7",
    "InstructorPage": "sample string 8",
    "Category": "sample string 9",
    "Credits": 1,
    "InstructorID": "273d8e99-ad49-4a11-9be2-bcf8a758a802",
    "CategoryCode": "sample string 10",
    "Price": 1.0
  }
]