A REST Convention

Query Parameters

Parameter

Type

Values

Mapping

Example

Parameter

Type

Values

Mapping

Example

expand

string

(repeating)

 

  • <name>: expand named OsidObject

  • OsidRecord.<name>: expand named OsidObject in OsidRecord

OsidObject.get<name>()

 

expand.all

boolean

(single)

default true

 

 

maxResults

cardinal

(single)

 

stop iteration after OsidObject.getNextOsidObjects(<cardinal>) returns maxResults

 

record.id

osid.id.Id

(repeating)

 

OsidObject.getOsidObjectRecord(<osid.id.Id>)

 

record.all

boolean

(single)

default true

 

 

session.id

osid.id.Id

(single)

 

key for an open OsidSession

 

skip

cardinal

(single)

 

OsidList.skip(<cardinal>)

 

session.view

string

  • federated

  • isolated

  • comparative

  • plenary

  • effective

  • ….

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

 

 

 

Copyright © 2014 Okapia.