Module state

Module state 

Source
Expand description

§State Resource (/activities/state)

A place to store information about the state of an activity in a generic form called a “document”. The intent of this resource is to store / retrieve a specific agent’s data within a specific activity, potentially tied to a registration.

The semantics of the response are driven by the presence, or absence, of a stateId parameter. If it’s present, the GET and DELETE methods shall act upon a single defined document identified by that stateId. Otherwise, GET will return the identifiers of available state records, while DELETE will delete all state(s) in the context given through the other parameters.

IMPORTANT - This resource has concurrency controls associated w/ it.

Any deviation from section 4.1.6.2 State Resource (/activities/state) of the xAPI specification is a bug.