When enrolling a user via a web service call, we first want to verify if the user is already enrolled in the course. After confirming they do not have an enrollment in the intended course, we will can send a request to create an a new enrollment record.
In this example, the course node id (nid) we 're looking want to enroll the user in is 300 and the Drupal user ID (uid) is 200.
...
The verification request will return an array of information, including any records found to match the given criteria. The response array is structured to handle paginated requests, and includes a 'list' of the records currently on this page. Due to the fact that the verification request above included the uid and nid parameters, if an enrollment exists, there will be only one record in the response list, as a user cannot have multiple enrollment records per course in EthosCE. The example above shows a response where user 200 does have an enrollment in course node 310. If no record is present, the 'list' array will be empty.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
stdClass Object
(
[self] => http://your-domain.com/course_enrollment?uid=200&nid=310 // The current page the list value displaying information
[first] => http://your-domain.com/course_enrollment?uid=200&nid=310&page=0
[last] => http://your-domain.com/course_enrollment?uid=200&nid=310&page=0
[list] => Array
(
[0] => stdClass Object
(
[eid] => 185
[nid] => stdClass Object
(
[uri] => http://your-domain.com/node/310
[id] => 310
[resource] => node
[uuid] => 9aabcf09-58c3-4679-85b3-c5f7ddc93ac6
)
[uid] => stdClass Object
(
[uri] => http://your-domain.com/user/200
[id] => 200
[resource] => user
[uuid] => ba5bc8af-25d7-48de-bb54-87ae70ac33b5
)
[enrollmenttype] =>
[status] => 1
[created] => 1459800985
[timestamp] => 1459800985
[enroll_end] => 0
[code] =>
[user_type] =>
[data] =>
[feed_nid] =>
)
)
) |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
stdClass Object
(
[self] => http://your-domain.com/course_enrollment?uid=200&nid=310 // The current page the list value displaying information
[first] => http://your-domain.com/course_enrollment?uid=200&nid=310&page=0
[last] => http://your-domain.com/course_enrollment?uid=200&nid=310&page=0
[list] => []
) |
Continuing from section #1:
...