Assessment Player Client API

Client Side Wrapper around the Assessment Player Server API

Functions

| method name | in parameters | description | |-------------|---------------|-------------| | GetAllAssessments | none | returns all published assessments | | GetAssessmentById | id number | returns a published assessment by id | | GetAssessment | LtiModel object | POST that returns a published assessment with potentially pooled items | | GetAssessmentByTitle | title string | returns a published assessment by title | | PublishAssessment | model AssessmentModel | publishes the assessment to the player API | | GetAccessToken | externalId number | gets an access token from itemlogic - temporary | | GetAssessmentProgress | key string | gets assessment progress with composite key | | SaveAssessmentProgress | model ProgressModel | saves assessment progress | | SubmitAssessmentV2 | model SubmitModel | saves assessment progress |

Models

AssessmentModel

| name | type | description | |------|-------------|------| | CourseTemplateId | string | course template id that the assessment is linked to | | Description | string | description of assessment | | ExternalId | number | external id of the assessment | | Id | number | id of the assessment | | IsActive | boolean | is assessment active | | ItemBankManifestId | number | grade level to search for | | Items | List<string> | can supply a list of authorities | | Randomize | boolean | are assessment questions randomized | | Title | string | title of assessment |

ProgressModel

| name | type | description | |------|-------------|------| | Key | string | composite string make up of assessmentId, studentId, ltiToken | | Value | string | JSON string of an object dictionary of assessment progress |

SubmitModel

| name | type | description | |------|-------------|------| | Items | List<ItemInfo> | List of items in the assessment with their corresponding selected responses | | LtiModel | object | Lti object |

ItemInfo

| name | type | description | |------|-------------|------| | Key | string | questionId | | Response | List<Response> | List of responses to the item |

Response

| name | type | description | |------|-------------|------| | Response | List<string> | A list of the string idendifiers for the answer selected for the item |