POST api/Courses/RetrieveCourses

Retrieves a list of applicable courses

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of mdl_course

Name	Type	Additional information
id	integer	None.
category	integer	None.
sortorder	integer	None.
fullname	string	None.
shortname	string	None.
idnumber	string	None.
summary	string	None.
summaryformat	integer	None.
format	string	None.
showgrades	integer	None.
newsitems	integer	None.
startdate	integer	None.
marker	integer	None.
maxbytes	integer	None.
legacyfiles	integer	None.
showreports	integer	None.
visible	integer	None.
visibleold	integer	None.
groupmode	integer	None.
groupmodeforce	integer	None.
defaultgroupingid	integer	None.
lang	string	None.
theme	string	None.
timecreated	integer	None.
timemodified	integer	None.
requested	integer	None.
enablecompletion	integer	None.
completionstartonenrol	integer	None.
completionprogressonview	integer	None.
completionnotify	integer	None.
audiencevisible	integer	None.
coursetype	integer	None.
icon	string	None.
calendartype	string	None.
cacherev	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "category": 2,
    "sortorder": 3,
    "fullname": "sample string 4",
    "shortname": "sample string 5",
    "idnumber": "sample string 6",
    "summary": "sample string 7",
    "summaryformat": 8,
    "format": "sample string 9",
    "showgrades": 10,
    "newsitems": 11,
    "startdate": 12,
    "marker": 13,
    "maxbytes": 14,
    "legacyfiles": 15,
    "showreports": 16,
    "visible": 17,
    "visibleold": 18,
    "groupmode": 19,
    "groupmodeforce": 20,
    "defaultgroupingid": 21,
    "lang": "sample string 22",
    "theme": "sample string 23",
    "timecreated": 24,
    "timemodified": 25,
    "requested": 26,
    "enablecompletion": 27,
    "completionstartonenrol": 28,
    "completionprogressonview": 29,
    "completionnotify": 30,
    "audiencevisible": 31,
    "coursetype": 32,
    "icon": "sample string 33",
    "calendartype": "sample string 34",
    "cacherev": 35
  },
  {
    "id": 1,
    "category": 2,
    "sortorder": 3,
    "fullname": "sample string 4",
    "shortname": "sample string 5",
    "idnumber": "sample string 6",
    "summary": "sample string 7",
    "summaryformat": 8,
    "format": "sample string 9",
    "showgrades": 10,
    "newsitems": 11,
    "startdate": 12,
    "marker": 13,
    "maxbytes": 14,
    "legacyfiles": 15,
    "showreports": 16,
    "visible": 17,
    "visibleold": 18,
    "groupmode": 19,
    "groupmodeforce": 20,
    "defaultgroupingid": 21,
    "lang": "sample string 22",
    "theme": "sample string 23",
    "timecreated": 24,
    "timemodified": 25,
    "requested": 26,
    "enablecompletion": 27,
    "completionstartonenrol": 28,
    "completionprogressonview": 29,
    "completionnotify": 30,
    "audiencevisible": 31,
    "coursetype": 32,
    "icon": "sample string 33",
    "calendartype": "sample string 34",
    "cacherev": 35
  }
]

application/xml, text/xml

Sample:

<ArrayOfmdl_course xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Totara.WEBAPI">
  <mdl_course>
    <audiencevisible>31</audiencevisible>
    <cacherev>35</cacherev>
    <calendartype>sample string 34</calendartype>
    <category>2</category>
    <completionnotify>30</completionnotify>
    <completionprogressonview>29</completionprogressonview>
    <completionstartonenrol>28</completionstartonenrol>
    <coursetype>32</coursetype>
    <defaultgroupingid>21</defaultgroupingid>
    <enablecompletion>27</enablecompletion>
    <format>sample string 9</format>
    <fullname>sample string 4</fullname>
    <groupmode>19</groupmode>
    <groupmodeforce>20</groupmodeforce>
    <icon>sample string 33</icon>
    <id>1</id>
    <idnumber>sample string 6</idnumber>
    <lang>sample string 22</lang>
    <legacyfiles>15</legacyfiles>
    <marker>13</marker>
    <maxbytes>14</maxbytes>
    <newsitems>11</newsitems>
    <requested>26</requested>
    <shortname>sample string 5</shortname>
    <showgrades>10</showgrades>
    <showreports>16</showreports>
    <sortorder>3</sortorder>
    <startdate>12</startdate>
    <summary>sample string 7</summary>
    <summaryformat>8</summaryformat>
    <theme>sample string 23</theme>
    <timecreated>24</timecreated>
    <timemodified>25</timemodified>
    <visible>17</visible>
    <visibleold>18</visibleold>
  </mdl_course>
  <mdl_course>
    <audiencevisible>31</audiencevisible>
    <cacherev>35</cacherev>
    <calendartype>sample string 34</calendartype>
    <category>2</category>
    <completionnotify>30</completionnotify>
    <completionprogressonview>29</completionprogressonview>
    <completionstartonenrol>28</completionstartonenrol>
    <coursetype>32</coursetype>
    <defaultgroupingid>21</defaultgroupingid>
    <enablecompletion>27</enablecompletion>
    <format>sample string 9</format>
    <fullname>sample string 4</fullname>
    <groupmode>19</groupmode>
    <groupmodeforce>20</groupmodeforce>
    <icon>sample string 33</icon>
    <id>1</id>
    <idnumber>sample string 6</idnumber>
    <lang>sample string 22</lang>
    <legacyfiles>15</legacyfiles>
    <marker>13</marker>
    <maxbytes>14</maxbytes>
    <newsitems>11</newsitems>
    <requested>26</requested>
    <shortname>sample string 5</shortname>
    <showgrades>10</showgrades>
    <showreports>16</showreports>
    <sortorder>3</sortorder>
    <startdate>12</startdate>
    <summary>sample string 7</summary>
    <summaryformat>8</summaryformat>
    <theme>sample string 23</theme>
    <timecreated>24</timecreated>
    <timemodified>25</timemodified>
    <visible>17</visible>
    <visibleold>18</visibleold>
  </mdl_course>
</ArrayOfmdl_course>