Untitled Document

API help for importing SCORM packages from yTeach

1. Function: http://yteach.co.uk/api.php/scormapi/login

description:

This function allows you to login to yTeach portal. Login action is necessery if you want to import any kind of yTeach sections as SCORM packages.

input parameters:

name - user name
pass - user password

execution link:

http://yteach.co.uk/api.php/scormapi/login?name=name&pass=pass

output if errors:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='0' message='Username or password is incorrect.'/>
</data>

element: error
attribute: id - error id
attribute: message - error message

output if correct:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <user id='123'/>
  <authorization key='123456'/>
</data>

element: user
attribute: id - user id (required in most functions as uid parameter)

element: authorization
attribute: key - authorization key (required in most functions as akey parameter)

2. Function: http://yteach.co.uk/api.php/scormapi/get_sections

description:

This function returns sections. Currently there are three sections: My playlists , My class assignments and My bookmarks.

input parameters:

no input parameters required

execution link:

http://yteach.co.uk/api.php/scormapi/get_sections

output if errors:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='0' message='Username or password is incorrect.'/>
</data>

output if correct:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <sections>
    <section id='0'>
      <name><![CDATA[My playlists]]></name>
    </section>
    <section id='1'>
      <name><![CDATA[My class assignments]]></name>
    </section>
    <section id='2'>
      <name><![CDATA[My bookmarks]]></name>
    </section>
  </sections>
</data>

element: section
attribute: id - section id (required in most functions as sid parameter)
element: section:name
cdata: section name

3. Function: http://yteach.co.uk/api.php/scormapi/get_section_list

description:

This function returns section categories and items (playlists, assignments or bookmarks).

input parameters:

uid - user id
akey - authorization key
sid - section id
cid (optional) - category id

execution link:

http://yteach.co.uk/api.php/scormapi/get_section_list?uid=uid&akey=akey&sid=sid

http://yteach.co.uk/api.php/scormapi/get_section_list?uid=uid&akey=akey&sid=sid&cid=cid

output if errors:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='1' message='Required uid (user id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='2' message='Required akey (authorization key) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='3' message='Required sid (section id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='5' message='Required uid (user id) or akey (authorization key) parameter is incorrect.'/>
</data>

element: error
attribute: id - error id
attribute: message - error message

output if correct:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <section id='0'/>
  <categories>
    <category default='1' selected='1' id='-1' count='10'>
      <name><![CDATA[All]]></name>
    </category>
    <category default='1' selected='0' id='-2' count='0'>
      <name><![CDATA[Published]]></name>
    </category>
    <category default='1' selected='0' id='-3' count='1'>
      <name><![CDATA[My favourites]]></name>
    </category>
    <category default='0' selected='0' id='15' count='2'>
      <name><![CDATA[My category]]></name>
    </category>
  </categories>
  <items>
    <item id='1' created='2008-01-01' count='1' type='Exercise 1'>
      <name><![CDATA[Sample 1]]></name>
    </item>
    <item id='2' created='2008-01-02' count='2' type='Exercise 2'>
      <name><![CDATA[Sample 2]]></name>
    </item>
    <item id='3' created='2008-01-03' count='3' type='Exercise 3'>
      <name><![CDATA[Sample 3]]></name>
    </item>
  </items>
</data>

element: section
attribute: id - section id (required in most functions as sid parameter)

element: category
attribute: default - default category; 1 - default; 0 - not default (user category)
attribute: selected - selected category; 1 - selected; 0 - not selected
attribute: id - category id (required in this function as optional cid parameter)
attribute: count - total items in category
element: category:name
cdata: category name

element: item (playlist, assignemnt or resource)
attribute: id - item id (required in create_scorm function as iid parameter)
attribute: created - creation date
attribute: count - total resources (in a playlist or an assignment) or not specified (in a bookmark)
attribute: type - resource type (in a bookmark) or not specified (in a playlist or an assignment)
element: item:name
cdata: item name

4. Function: http://yteach.co.uk/api.php/scormapi/create_scorm

description:

This function creates SCORM package and returns URL to zip file

input parameters:

uid - user id
akey - authorization key
sid - section id
iid - comma separated items id

execution link:

http://yteach.co.uk/api.php/scormapi/create_scorm?uid=uid&akey=akey&sid=sid&iid=iid1,iid2,...,iidN

output if errors:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='1' message='Required uid (user id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='2' message='Required akey (authorization key) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='3' message='Required sid (section id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='4' message='Required iid (items id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='5' message='Required uid (user id) or akey (authorization key) parameter is incorrect.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='6' message='You can export Playlist after having purchased all the resources included.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='7' message='You can export Assignment after having purchased all the resources included.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='8' message='You can export bookmarked resources after having purchased all of them.'/>
</data>

element: error
attribute: id - error id
attribute: message - error message

output if correct:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <scorm><![CDATA[http://yteach.co.uk/upload/yTeach_playlist_00000000-111111.zip]]></scorm>
</data>

element: scorm
cdata: URL to created SCORM package (zip file)

5. Function: http://yteach.co.uk/api.php/scormapi/preview

description:

This function allows to preview yTeach lesson plans, assignments and bookmarks.

input parameters:

uid - user id
sid - section id
iid - item id

execution link:

http://yteach.co.uk/api.php/scormapi/preview?uid=uid&sid=sid&iid=iid

output if errors:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='1' message='Required uid (user id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='3' message='Required sid (section id) parameter not specified.'/>
</data>

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='4' message='Required iid (item id) parameter not specified.'/>
</data>

element: error
attribute: id - error id
attribute: message - error message

output if correct:

Html preview of the selected item (playlist, assignment or bookmark)