OpCode C: List Courses

This opcode is used to list courses from the VTS system.

Calling the API

The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.

The format of the call is:https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50800&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCode={Opcode&{Additional, opcode-specific parameters in name=value format…}

Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.

Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50800. All other parameters may appear in any sequence.

API Parameter	Type/Size	Req.	Comment
APIUserAuthCode	Varchar 80	Y	Your API authorization code as supplied by Notified.
APIUserCredentials	Varchar 80	Y	Your API user credentials as supplied by Notified.
OpCode	Varchar 20	Y	Should be L to invoke this function.
JSON	Integer	N	Pass one (1) for JSON formatted output. Defaults to 1 (one).
CSV	Integer	N	Pass one (1) for CSV formatted output. Defaults to 0 (zero). Overrides JSON.
XML	Integer	N	Pass one (1) for XML formatted output. Defaults to 0 (zero). Overrides JSON and CSV.
ShowKey	Integer	N	Filter courses by Show Key.
EventKey	Integer	N	Filter courses by Event Key.

Return Outputs

This API returns the VTS UDF Group Key

CSV/Text

ShowKey,CourseKey,CourseTitle,RequiredCourseKey,RequiredCourseTitle,LinkedEventKey,LinkedEventDesc,EnrollmentType,CanTestOut,CourseActive,TestCount

9031,5751,Webcast v001,0,,74056,Webcast v001,Automatic,No,1,0

9031,5752,Test for CPE,5751,Webcast v001,0,,Automatic,No,1,1

XML

<Courses>

  <Course>

    <ShowKey>9031</ShowKey>

    <CourseKey>5751</CourseKey>

    <CourseTitle>Webcast v001</CourseTitle>

    <RequiredCourseKey>0</RequiredCourseKey>

    <RequiredCourseTitle/>

    <LinkedEventKey>74056</LinkedEventKey>

    <LinkedEventDesc>Webcast v001</LinkedEventDesc>

    <EnrollmentType>Automatic</EnrollmentType>

    <CanTestOut>No</CanTestOut>

    <CourseActive>1</CourseActive>

    <TestCount>0</TestCount>

  </Course>

  <Course>

    <ShowKey>9031</ShowKey>

    <CourseKey>5752</CourseKey>

    <CourseTitle>Test for CPE</CourseTitle>

    <RequiredCourseKey>5751</RequiredCourseKey>

    <RequiredCourseTitle>Webcast v001</RequiredCourseTitle>

    <LinkedEventKey>0</LinkedEventKey>

    <LinkedEventDesc/>

    <EnrollmentType>Automatic</EnrollmentType>

    <CanTestOut>No</CanTestOut>

    <CourseActive>1</CourseActive>

    <TestCount>1</TestCount>

  </Course>

</Courses>

JSON

[{"ShowKey": 9031,"CourseKey": 5751,"CourseTitle": "Webcast v001","RequiredCourseKey": 0,"RequiredCourseTitle": "","LinkedEventKey": 74056,"LinkedEventDesc": "Webcast v001","EnrollmentType": "Automatic","CanTestOut": "No","CourseActive": true,"TestCount": 0}, {"ShowKey": 9031,"CourseKey": 5752,"CourseTitle": "Test for CPE","RequiredCourseKey": 5751,"RequiredCourseTitle": "Webcast v001","LinkedEventKey": 0,"LinkedEventDesc": "","EnrollmentType": "Automatic","CanTestOut": "No","CourseActive": true,"TestCount": 1}, {"ShowKey": 9031,"CourseKey": 5885,"CourseTitle": "Test for 9031","RequiredCourseKey": 0,"RequiredCourseTitle": "","LinkedEventKey": 0,"LinkedEventDesc": "","EnrollmentType": "Automatic","CanTestOut": "No","CourseActive": true,"TestCount": 1}]