Pomoc do API służącego do importu paczek w standardzie SCORM z portalu nauczyciel.pl

1. Funkcja: http://nauczyciel.pl/api.php/scormapi/login

opis:

Ta funkcja umożliwia zalogowanie się do portalu nauczyciel.pl. Czynność logowania jest niezbędna w celu dokonania importu dowolnych zasobów z sekcji portalu nauczyciel.pl jako paczki SCORM.

parametry wejściowe:

name - nazwa (login) użytkownika
pass - hasło użytkownika

link wywołujący funkcje:

http://nauczyciel.pl/api.php/scormapi/login?name=name&pass=pass

dane zwracane w przypadku wystąpienia błędów:

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

element: error
atrybut: id - id błędu
atrybut: message - komunikat błędu

dane zwracane w przypadku braku błędów:

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

element: user
atrybut: id - id użytkownika (wymagany w większości funkcji jako parametr uid)

element: authorization
atrybut: key - klucz autoryzacyjny (wymagany w większości funkcji jako parametr akey)

2. Funkcja: http://nauczyciel.pl/api.php/scormapi/get_sections

opis:

Ta funkcja zwraca sekcje portalu nauczyciel.pl. Aktualnie dostępne są trzy sekcje: Moje prezentacje, Moje zadania i Ulubione.

parametry wejściowe:

nie są wymagane

link wywołujący funkcje:

http://nauczyciel.pl/api.php/scormapi/get_sections

dane zwracane w przypadku wystąpienia błędów:

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

element: error
atrybut: id - id błędu
atrybut: message - komunikat błędu

dane zwracane w przypadku braku błędów:

<?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 - id sekcji (wymagany w większości funkcji jako parametr sid)
element: section:name
cdata: nazwa sekcji

3. Funkcja: http://nauczyciel.pl/api.php/scormapi/get_section_list

opis:

Ta funkcja zwraca kategorie i elementy (items) wybranej sekcji (prezentacje, zadania lub ulubione).

parametry wejściowe:

uid - id użytkownika
akey - klucz autoryzacyjny
sid - id sekcji
cid (opcjonalny) - id kategorii

link wywołujący funkcje:

http://nauczyciel.pl/api.php/scormapi/get_section_list?uid=uid&akey=akey&sid=sid

lub

http://nauczyciel.pl/api.php/scormapi/get_section_list?uid=uid&akey=akey&sid=sid&cid=cid

dane zwracane w przypadku wystąpienia błędów:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='1' message='Required uid (user id) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='2' message='Required akey (authorization key) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='3' message='Required sid (section id) parameter not specified.'/>
</data>
lub 
<?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
atrybut: id - id błędu
atrybut: message - komunikat błędu

dane zwracane w przypadku braku błędów: 
<?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
atrybut: id - id sekcji (wymagany w większości funkcji jako parametr sid)

element: category
atrybut: default - domyślna kategoria; 1 - domyślna; 0 - nie domyślna (kategoria użytkownika)
atrybut: selected - wybrana kategoria; 1 - wybrana; 0 - nie wybrana
atrybut: id - id kategorii (wymagany w większości funkcji jako opcjonalny parametr cid)
atrybut: count - liczba zasobów w kategorii
element: category:name
cdata: nazwa kategorii

element: item (prezentacje, zadania lub ulubione)
atrybut: id - id elementu (itemu) (wymagany w funkcji create_scorm jako parametr iid)
atrybut: created - data utworzenia
atrybut: count - liczba zasobów (w prezentacji lub zadaniu) lub nie podane (w ulubionych)
atrybut: type - typ zasobu (w ulubionych) lub nie podane (w prezentacji lub zadaniu)
element: item:name
cdata: nazwa elementu (itemu)

4. Funkcja: http://nauczyciel.pl/api.php/scormapi/create_scorm

opis:

Ta funkcja tworzy paczke SCORM i zwraca link do pliku zip

parametry wejściowe:

uid - id użytkownika
akey - klucz autoryzacyjny
sid - id sekcji
iid - id elementów (itemów) oddzielonych przecinkami

link wywołujący funkcje:

http://nauczyciel.pl/api.php/scormapi/create_scorm?uid=uid&akey=akey&sid=sid&iid=iid1,iid2,...,iidN

dane zwracane w przypadku wystąpienia błędów:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='1' message='Required uid (user id) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='2' message='Required akey (authorization key) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='3' message='Required sid (section id) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='4' message='Required iid (items id) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='5' message='Required uid (user id) or akey (authorization key) parameter is incorrect.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='6' message='You can export Playlist after having purchased all the resources included.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='7' message='You can export Assignment after having purchased all the resources included.'/>
</data>
lub 
<?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
atrybut: id - id błędu
atrybut: message - komunikat błędu

dane zwracane w przypadku braku błędów: 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <scorm><![CDATA[http://nauczyciel.pl/upload/nauczyciel.pl_playlist_00000000-111111.zip]]></scorm>
</data>

element: scorm
cdata: link do utworzonej paczki SCORM (plik zip)

5. Funkcja: http://nauczyciel.pl/api.php/scormapi/preview

opis:

Ta funkcja umożliwia podgląd prezentacji, zadań i ulubionych zasobów z portalu nauczyciel.pl.

parametry wejściowe:

uid - id użytkownika
sid - id sekcji
iid - id elementu (itemu)

link wywołujący funkcje:

http://nauczyciel.pl/api.php/scormapi/preview?uid=uid&sid=sid&iid=iid

dane zwracane w przypadku wystąpienia błędów:

<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='1' message='Required uid (user id) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='3' message='Required sid (section id) parameter not specified.'/>
</data>
lub 
<?xml version='1.0' encoding='UTF-8'?>
<data>
  <error id='4' message='Required iid (item id) parameter not specified.'/>
</data>

element: error
atrybut: id - id błędu
atrybut: message - komunikat błędu

dane zwracane w przypadku braku błędów:

Podgląd w przeglądarce internetowej wybranego elementu (itemu) (prezentacja, zadanie lub ulubione)