OpCode L: List Attendee's Course Status

OpCode L: List Attendee's Course Status

This opcode is used to list the attendee’s course status 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.
Completed Integer N Pass one (1) for only completed courses, 0 (zero) for all courses. Defaults to 0 (zero).
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.
StartDate Date N Date to filter course completion by.
EndDate Date N Date to filter course completion by.
ShowKey Integer N Filter courses by Show Key.
EventKey Integer N Filter courses by Event Key.

 

Return Outputs

This API returns the VTS Attendee’s course completion Status.

CSV/Text

ShowUserKey  Name  EmailAddress CompanyName  CourseKey   CourseTitle  Complete    Detail      Complete Test - must pass Duration - 1 minutes required  Specific Poll - Polling question(2)  Checkpoints - 10% required     Polls - 10% required
1416937     Andrew Jackson     ANDREW.JACKSON@WHITEHOUSE.GOV        5342  content     0      incomplete  100%  0:00:20                
1416937     Andrew Jackson     ANDREW.JACKSON@WHITEHOUSE.GOV        5751  Webcast v001 0      incomplete  100%  0:00:20          

XML

<Attendees>
 <Attendee EMailAddress="ANDREW.JACKSON@WHITEHOUSE.GOV" Name="Andrew Jackson" ShowUserKey="1416937">
  <Requirement>
   <Requirement CourseTitle="content" ShowTitle="Corey VX Event v001" ShowKey="7858" CourseKey="5342" Detail="incomplete">
    <Details>
     <Detail Type="Duration" Object="content" Required="0 minutes required" Complete="0"/>

    </Details>

   </Requirement>

   <Requirement CourseTitle="Webcast v001" ShowTitle="Webcast v001" ShowKey="9031" CourseKey="5751" Detail="incomplete">

    <Details>

     <Detail Type="Duration" Object="Webcast v001" Required="1 minutes required" Actual="00:00:20" Complete="0"/>

     <Detail Type="Polls" Object="Webcast v001" Required="10% required" Complete="0"/>

     <Detail Type="Specific Poll" Object="Polling question(2)" Complete="0"/>

     <Detail Type="Complete Test" Object="Test for 9031" Required="must pass" Complete="0"/>

     <Detail Type="Complete Test" Object="Test for CPE" Required="must pass" Actual="100%" Complete="1"/>

     <Detail Type="Checkpoints" Object="Webcast v001" Required="10% required" Complete="0"/>

    </Details>

   </Requirement>

  </Requirement>

 </Attendee>

</Attendees>

JSON

{"Status": 0,"Diag": "OK","ResultSet": [[{"ShowUserKey": 1416937,"Name": "Andrew Jackson","EmailAddress": "ANDREW.JACKSON@WHITEHOUSE.GOV","CompanyName": "","CourseKey": 5342,"CourseTitle": "content","Complete": 0,"Detail": "incomplete","Complete Test - must pass": "100%","Duration - 1 minutes required": "00:00:20","Specific Poll - Polling question(2)": "","Checkpoints - 10% required": "","Polls - 10% required": ""}, {"ShowUserKey": 1416937,"Name": "Andrew Jackson","EmailAddress": "ANDREW.JACKSON@WHITEHOUSE.GOV","CompanyName": "","CourseKey": 5751,"CourseTitle": "Webcast v001","Complete": 0,"Detail": "incomplete","Complete Test - must pass": "100%","Duration - 1 minutes required": "00:00:20","Specific Poll - Polling question(2)": "","Checkpoints - 10% required": "","Polls - 10% required": ""}]]}