2.4. Agents Resource
Requirements
| ID | Requirement |
|---|---|
| XAPI-00236 | An LRS's Agents API accepts GET requests with response 200 OK, Person Object |
| XAPI-00237 | A Person Object's "objectType" property is a String and is "Person" The LRS must return a valid “objectType” string. |
| XAPI-00238 | A Person Object's "name" property is an Array of Strings. The LRS must return a “name” property with a valid Array of Strings, if present. |
| XAPI-00239 | A Person Object's "mbox" property is an Array of IRIs. The LRS must return an “mbox” property with a valid array of IRIs, if present. |
| XAPI-00240 | A Person Object's "mbox_sha1sum" property is an Array of Strings. The LRS must return a Person Object which has a “mbox_sha1sum” and is valid array of strings, if present. |
| XAPI-00241 | A Person Object's "openid" property is an Array of Strings The LRS must return a “openid” value which is valid array of strings, if present. |
| XAPI-00242 | A Person Object's "account" property is an Array of Account Objects The LRS must return a Person Object with a “name” value which is a valid array of account objects, if present. |
| XAPI-00243 | An LRS's Agents API rejects a GET request without "agent" as a parameter with error code 400 Bad Request |
| XAPI-00244 | A Person Object's "mbox" entries have the form "mailto:emailaddress". The LRS must return a Person Object which has a “mbox” value with the form "mailto:emailaddress" |
| XAPI-00245 | An LRS has an Agents API with endpoint "base IRI" + /agents" |
| XAPI-00246 | The Agents Resource MUST have an endpoint which accepts GET requests and returns a special, Person Object where each attribute has an array value and it is legal to include multiple identifying properties. |
| XAPI-00247 | If an LRS does not have any additional information about an Agent to return from the Agents Resource, the LRS MUST still return a Person when queried, but that Person Object will only include the information associated with the requested Agent. |
| XAPI-00248 | An LRS's Agents API upon processing a successful GET request returns a Person Object based on matched data from the "agent" parameter and code 200 OK |
| XAPI-00249 | An LRS's Agents API rejects a GET request with "agent" as a parameter if it is not a valid (in structure) Agent with error code 400 Bad Request |