POST api/Users/RetrieveUsers

Returns a list of users from the LMS Database

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of mdl_user
NameDescriptionTypeAdditional information
id

integer

None.

auth

string

None.

confirmed

integer

None.

policyagreed

integer

None.

deleted

integer

None.

suspended

integer

None.

mnethostid

integer

None.

username

string

None.

password

string

None.

idnumber

string

None.

firstname

string

None.

lastname

string

None.

email

string

None.

emailstop

integer

None.

icq

string

None.

skype

string

None.

yahoo

string

None.

aim

string

None.

msn

string

None.

phone1

string

None.

phone2

string

None.

institution

string

None.

department

string

None.

address

string

None.

city

string

None.

country

string

None.

lang

string

None.

theme

string

None.

timezone

string

None.

firstaccess

integer

None.

lastaccess

integer

None.

lastlogin

integer

None.

currentlogin

integer

None.

lastip

string

None.

secret

string

None.

picture

integer

None.

url

string

None.

description

string

None.

descriptionformat

integer

None.

mailformat

integer

None.

maildigest

integer

None.

maildisplay

integer

None.

autosubscribe

integer

None.

trackforums

integer

None.

timecreated

integer

None.

timemodified

integer

None.

trustbitmask

integer

None.

imagealt

string

None.

totarasync

integer

None.

lastnamephonetic

string

None.

firstnamephonetic

string

None.

middlename

string

None.

alternatename

string

None.

calendartype

string

None.

cpa_date_created_timestamp

integer

None.

cpa_date_created

date

None.

cpa_learner_journal_url

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "auth": "sample string 2",
    "confirmed": 3,
    "policyagreed": 4,
    "deleted": 5,
    "suspended": 6,
    "mnethostid": 7,
    "username": "sample string 8",
    "password": "sample string 9",
    "idnumber": "sample string 10",
    "firstname": "sample string 11",
    "lastname": "sample string 12",
    "email": "sample string 13",
    "emailstop": 14,
    "icq": "sample string 15",
    "skype": "sample string 16",
    "yahoo": "sample string 17",
    "aim": "sample string 18",
    "msn": "sample string 19",
    "phone1": "sample string 20",
    "phone2": "sample string 21",
    "institution": "sample string 22",
    "department": "sample string 23",
    "address": "sample string 24",
    "city": "sample string 25",
    "country": "sample string 26",
    "lang": "sample string 27",
    "theme": "sample string 28",
    "timezone": "sample string 29",
    "firstaccess": 30,
    "lastaccess": 31,
    "lastlogin": 32,
    "currentlogin": 33,
    "lastip": "sample string 34",
    "secret": "sample string 35",
    "picture": 36,
    "url": "sample string 37",
    "description": "sample string 38",
    "descriptionformat": 39,
    "mailformat": 40,
    "maildigest": 41,
    "maildisplay": 42,
    "autosubscribe": 43,
    "trackforums": 44,
    "timecreated": 45,
    "timemodified": 46,
    "trustbitmask": 47,
    "imagealt": "sample string 48",
    "totarasync": 49,
    "lastnamephonetic": "sample string 50",
    "firstnamephonetic": "sample string 51",
    "middlename": "sample string 52",
    "alternatename": "sample string 53",
    "calendartype": "sample string 54",
    "cpa_date_created_timestamp": 1,
    "cpa_date_created": "2024-03-29T05:35:40.2944936+00:00",
    "cpa_learner_journal_url": "sample string 55"
  },
  {
    "id": 1,
    "auth": "sample string 2",
    "confirmed": 3,
    "policyagreed": 4,
    "deleted": 5,
    "suspended": 6,
    "mnethostid": 7,
    "username": "sample string 8",
    "password": "sample string 9",
    "idnumber": "sample string 10",
    "firstname": "sample string 11",
    "lastname": "sample string 12",
    "email": "sample string 13",
    "emailstop": 14,
    "icq": "sample string 15",
    "skype": "sample string 16",
    "yahoo": "sample string 17",
    "aim": "sample string 18",
    "msn": "sample string 19",
    "phone1": "sample string 20",
    "phone2": "sample string 21",
    "institution": "sample string 22",
    "department": "sample string 23",
    "address": "sample string 24",
    "city": "sample string 25",
    "country": "sample string 26",
    "lang": "sample string 27",
    "theme": "sample string 28",
    "timezone": "sample string 29",
    "firstaccess": 30,
    "lastaccess": 31,
    "lastlogin": 32,
    "currentlogin": 33,
    "lastip": "sample string 34",
    "secret": "sample string 35",
    "picture": 36,
    "url": "sample string 37",
    "description": "sample string 38",
    "descriptionformat": 39,
    "mailformat": 40,
    "maildigest": 41,
    "maildisplay": 42,
    "autosubscribe": 43,
    "trackforums": 44,
    "timecreated": 45,
    "timemodified": 46,
    "trustbitmask": 47,
    "imagealt": "sample string 48",
    "totarasync": 49,
    "lastnamephonetic": "sample string 50",
    "firstnamephonetic": "sample string 51",
    "middlename": "sample string 52",
    "alternatename": "sample string 53",
    "calendartype": "sample string 54",
    "cpa_date_created_timestamp": 1,
    "cpa_date_created": "2024-03-29T05:35:40.2944936+00:00",
    "cpa_learner_journal_url": "sample string 55"
  }
]

application/xml, text/xml

Sample:
<ArrayOfmdl_user xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Totara.WEBAPI">
  <mdl_user>
    <address>sample string 24</address>
    <aim>sample string 18</aim>
    <alternatename>sample string 53</alternatename>
    <auth>sample string 2</auth>
    <autosubscribe>43</autosubscribe>
    <calendartype>sample string 54</calendartype>
    <city>sample string 25</city>
    <confirmed>3</confirmed>
    <country>sample string 26</country>
    <cpa_date_created>2024-03-29T05:35:40.2944936+00:00</cpa_date_created>
    <cpa_date_created_timestamp>1</cpa_date_created_timestamp>
    <cpa_learner_journal_url>sample string 55</cpa_learner_journal_url>
    <currentlogin>33</currentlogin>
    <deleted>5</deleted>
    <department>sample string 23</department>
    <description>sample string 38</description>
    <descriptionformat>39</descriptionformat>
    <email>sample string 13</email>
    <emailstop>14</emailstop>
    <firstaccess>30</firstaccess>
    <firstname>sample string 11</firstname>
    <firstnamephonetic>sample string 51</firstnamephonetic>
    <icq>sample string 15</icq>
    <id>1</id>
    <idnumber>sample string 10</idnumber>
    <imagealt>sample string 48</imagealt>
    <institution>sample string 22</institution>
    <lang>sample string 27</lang>
    <lastaccess>31</lastaccess>
    <lastip>sample string 34</lastip>
    <lastlogin>32</lastlogin>
    <lastname>sample string 12</lastname>
    <lastnamephonetic>sample string 50</lastnamephonetic>
    <maildigest>41</maildigest>
    <maildisplay>42</maildisplay>
    <mailformat>40</mailformat>
    <middlename>sample string 52</middlename>
    <mnethostid>7</mnethostid>
    <msn>sample string 19</msn>
    <password>sample string 9</password>
    <phone1>sample string 20</phone1>
    <phone2>sample string 21</phone2>
    <picture>36</picture>
    <policyagreed>4</policyagreed>
    <secret>sample string 35</secret>
    <skype>sample string 16</skype>
    <suspended>6</suspended>
    <theme>sample string 28</theme>
    <timecreated>45</timecreated>
    <timemodified>46</timemodified>
    <timezone>sample string 29</timezone>
    <totarasync>49</totarasync>
    <trackforums>44</trackforums>
    <trustbitmask>47</trustbitmask>
    <url>sample string 37</url>
    <username>sample string 8</username>
    <yahoo>sample string 17</yahoo>
  </mdl_user>
  <mdl_user>
    <address>sample string 24</address>
    <aim>sample string 18</aim>
    <alternatename>sample string 53</alternatename>
    <auth>sample string 2</auth>
    <autosubscribe>43</autosubscribe>
    <calendartype>sample string 54</calendartype>
    <city>sample string 25</city>
    <confirmed>3</confirmed>
    <country>sample string 26</country>
    <cpa_date_created>2024-03-29T05:35:40.2944936+00:00</cpa_date_created>
    <cpa_date_created_timestamp>1</cpa_date_created_timestamp>
    <cpa_learner_journal_url>sample string 55</cpa_learner_journal_url>
    <currentlogin>33</currentlogin>
    <deleted>5</deleted>
    <department>sample string 23</department>
    <description>sample string 38</description>
    <descriptionformat>39</descriptionformat>
    <email>sample string 13</email>
    <emailstop>14</emailstop>
    <firstaccess>30</firstaccess>
    <firstname>sample string 11</firstname>
    <firstnamephonetic>sample string 51</firstnamephonetic>
    <icq>sample string 15</icq>
    <id>1</id>
    <idnumber>sample string 10</idnumber>
    <imagealt>sample string 48</imagealt>
    <institution>sample string 22</institution>
    <lang>sample string 27</lang>
    <lastaccess>31</lastaccess>
    <lastip>sample string 34</lastip>
    <lastlogin>32</lastlogin>
    <lastname>sample string 12</lastname>
    <lastnamephonetic>sample string 50</lastnamephonetic>
    <maildigest>41</maildigest>
    <maildisplay>42</maildisplay>
    <mailformat>40</mailformat>
    <middlename>sample string 52</middlename>
    <mnethostid>7</mnethostid>
    <msn>sample string 19</msn>
    <password>sample string 9</password>
    <phone1>sample string 20</phone1>
    <phone2>sample string 21</phone2>
    <picture>36</picture>
    <policyagreed>4</policyagreed>
    <secret>sample string 35</secret>
    <skype>sample string 16</skype>
    <suspended>6</suspended>
    <theme>sample string 28</theme>
    <timecreated>45</timecreated>
    <timemodified>46</timemodified>
    <timezone>sample string 29</timezone>
    <totarasync>49</totarasync>
    <trackforums>44</trackforums>
    <trustbitmask>47</trustbitmask>
    <url>sample string 37</url>
    <username>sample string 8</username>
    <yahoo>sample string 17</yahoo>
  </mdl_user>
</ArrayOfmdl_user>