...
| Info | ||
|---|---|---|
| ||
self: The current page being viewed first: The first page in the data set last: The last page in the data set. If this matches the value in first, the data set has been returned in full in the list option. next: The next page in the data set, following the current page, self prev: The previous page in the data set, preceding the current page, self list: The data range of the current self request page |
Example
...
Response
A request to verify enrollment of user 200 in course 300, where the user is enrolled in the course. The call http://your-domain.com/course_enrollment.json?uid=200&nid=300 will return the following:
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
stdClass Object
(
[self] => http://your-domain.com/course_enrollment?page=1
[first] => http://your-domain.com/course_enrollment?page=0
[last] => http://your-domain.com/course_enrollment?page=3
[prev] => http://your-domain.com/course_enrollment?page=0
[next] => http://your-domain.com/course_enrollment?page=2
[list] => Array
(
[0] => stdClass Object{ ... }
[1] => stdClass Object{ ... }
[2] => stdClass Object{ ... }
...
)
)
|
Create (POST)
Creation requests return an array of basic information about the new created entity. The HTTP status code returned will be 201 CREATED for successful requests.
| Info | ||
|---|---|---|
| ||
uri: The web URI id: The entity id resource: The entity type uuid: The unique universal id |
Example Responses
A user creation call.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
stdClass Object ( [uri] => http://74.localhost/user/200 [id] => 200 [resource] => user [uuid] => 2fd044c5-ff4a-4bfe-8472-9b9b56eb0fc6 ) |
...
|
| Info | ||
|---|---|---|
| ||
| See the full request at Creating a user via web service |
Update (PUT)
Delete (DELETE)
Delete requests do not return any data. All information is display via HTTP request status codes.
| Info | ||
|---|---|---|
| ||
None |