A REST Convention
Query Parameters
Parameter | Type | Values | Mapping | Example |
---|---|---|---|---|
expand | string (repeating) |
| OsidObject.get<name>() |
|
expand.all | boolean (single) | default true |
|
|
maxResults | cardinal (single) |
| stop iteration after OsidObject.getNextOsidObjects(<cardinal>) returns maxResults |
|
record.id | (repeating) |
| OsidObject.getOsidObjectRecord(<osid.id.Id>) |
|
record.all | boolean (single) | default true |
|
|
session.id | (single) |
| key for an open OsidSession |
|
skip | cardinal (single) |
| OsidList.skip(<cardinal>) |
|
session.view | string |
| OsidSession.use<string>View() |
|
session.view.genus | string (single) | osid.id.Id | OsidSession.useGenusView(<osid.id.Id>) |
|
session.view.derivedGenus | string (single) | osid.id.Id | OsidSession.useDerivedGenusView(<osid.id.Id>) |
|
session.view.noGenus |
|
| OsidSession.useNoGenusView() |
|
strict | string (single) |
|
|
|
suppress | string (repeating) | <name> |
|
|
suppress.all | boolean (single) | default false |
|
|