Read.AssessmentRecord.Summary
This method will provide possibility to read assessment from the Summary views data across courses and students.
Input parameters
Name | Description | Type | Mandatory/Optional |
SiteId | Site where action will be executed. | Integer | Optional |
VendorId | VendorId. Currently not used. | Text | Optional |
Date | Date to get all changes since. | UTC DateTime | Mandatory |
Columns | List of column to filter results by | Object | Optional |
ColumnExternalId | External ID of the column | Text | Optional |
CourseId | Itslearning internal ID of the course | Integer | Optional |
CourseSyncKey | SyncKeyID of the course where the element is to be updated. | Text | Optional |
PersonId | Itslearning internal ID of the person | Integer | Optional |
PersonSyncKey | Sync Key ID of the person to filter results by | Text | Optional |
CompletedOnly | If null: return all columns If true: return only columns with status and completed If false: return only columns with status, and not completed Default is null | NullableBool | Optional |
PageIndex | 0 based index of the page requested. Default 0 | Int | Optional |
PageSize | Size of the page to return. Default 100 | Int | Optional |
All input parameters are optional besides Date. All filters can be combined, so it possible to return for example list of results for specific column list from certain course for certain person with complete only status.
Example request
<
soapenv
:Envelope
xmlns:soapenv
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem
=
"http://tempuri.org/"
xmlns:its
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
xmlns:its1
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.AssessmentRecordSummary"
>
<
soapenv
:Header/>
<
soapenv
:Body>
<
tem
:ReadAssessmentRecordSummary>
<
tem
:request>
<
its
:PageIndex>0</
its
:PageIndex>
<
its
:PageSize>100</
its
:PageSize>
<
its1
:Columns>
<
its1
:ColumnExternalID>2dc741e6-0507-4694-85e5-ae3a000d71c7</
its1
:ColumnExternalID>
</
its1
:Columns>
<
its1
:CompletedOnly>true</
its1
:CompletedOnly>
<
its1
:CourseID>20</
its1
:CourseID>
<
its1
:Date>2012-12-20T08:50:06.440Z</
its1
:Date>
<
its1
:PersonID>15</
its1
:PersonID>
</
tem
:request>
</
tem
:ReadAssessmentRecordSummary>
</
soapenv
:Body>
</
soapenv
:Envelope>
Output parameters
Name | Description | Type |
CurrentPageIndex | Current page returned | Int |
PageSize | Size of the returned page | Int |
Total | Total number or results | Int |
AssessmentRecordSummaryResults | List of AssessmentRecordSummaryResult | Object |
AssessmentRecordSummaryResult | Single AssessmentRecordSummaryResult | Object |
CourseID | Itslearning internal ID of the course | Int |
CourseSyncKey | Sync Key ID of the person | Text |
PersonID | Itslearning internal of the course | Int |
PersonSyncKey | Sync Key ID of the person | Text |
ColumnExternalID | External ID of the column | Text |
ValuePercent | Value of the column if using percent | Double |
AssessmentScaleId | The assessment scale in use for columns using an assessment scale | Int |
AssessmentItemId | The actual assessment in the scale in use | Int |
AssessmentItemTitle | The title of the assessment item id (e.g. "A") | Text |
UpdatedDate | UTC date when this value was last updated | Date |
IsCompleted | Completed flag of the column | NullableBool |
The returned assessment can either be a ValuePercent (if column is using percent), or a combination of AssessmentScaleId, AssessmentItemId and AssessmentItemTitle.
Example response
<
s
:Envelope
xmlns:s
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:u
=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
>
<
s
:Header>
<
o
:Security
s:mustUnderstand
=
"1"
xmlns:o
=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
>
<
u
:Timestamp
u:Id
=
"_0"
>
<
u
:Created>2013-10-28T08:56:06.992Z</
u
:Created>
<
u
:Expires>2013-10-28T09:01:06.992Z</
u
:Expires>
</
u
:Timestamp>
</
o
:Security>
</
s
:Header>
<
s
:Body>
<
ReadAssessmentRecordSummaryResponse
xmlns
=
"http://tempuri.org/"
>
<
ReadAssessmentRecordSummaryResult
xmlns:a
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.AssessmentRecordSummary"
xmlns:i
=
"http://www.w3.org/2001/XMLSchema-instance"
>
<
CurrentPageIndex
xmlns
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
>0</
CurrentPageIndex
>
<
PageSize
xmlns
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
>100</
PageSize
>
<
Total
xmlns
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities"
>16</
Total
>
<
a
:AssessmentRecordSummaryResults>
<
a
:AssessmentRecordSummaryResult>
<
a
:CourseID>29</
a
:CourseID>
<
a
:CourseSyncKey>AssessmentRecordSummary1</
a
:CourseSyncKey>
<
a
:PersonID>113</
a
:PersonID>
<
a
:PersonSyncKey>Pupil1</
a
:PersonSyncKey>
<
a
:ColumnExternalID>f2b2191a-7bdc-4d2f-9d2d-453f455cac7a</
a
:ColumnExternalID>
<
a
:ValuePercent>66.67</
a
:ValuePercent>
<
a
:UpdatedDate>2013-06-27T13:40:02</
a
:UpdatedDate>
<
a
:IsCompleted
i:nil
=
"true"
/>
</
a
:AssessmentRecordSummaryResult>
<
a
:AssessmentRecordSummaryResult>
<
a
:CourseID>29</
a
:CourseID>
<
a
:CourseSyncKey>AssessmentRecordSummary1</
a
:CourseSyncKey>
<
a
:PersonID>113</
a
:PersonID>
<
a
:PersonSyncKey>Pupil1</
a
:PersonSyncKey>
<
a
:ColumnExternalID>33ec732f-734b-40a6-b391-5a8797d0af43</
a
:ColumnExternalID>
<
a
:AssessmentScaleId>1</
a
:AssessmentScaleId>
<
a
:AssessmentItemId>1</
a
:AssessmentItemId>
<
a
:AssessmentTitle>A</
a
:AssessmentTitle>
<
a
:UpdatedDate>2013-06-27T13:38:03</
a
:UpdatedDate>
<
a
:IsCompleted
i:nil
=
"true"
/>
</
a
:AssessmentRecordSummaryResult>
</
ReadAssessmentRecordSummaryResponse
>
</
s
:Body>
</
s
:Envelope>
Error states
- The requested course does not exist.
- The requested course has been deleted.
- The requested course exists, but belongs to an organisation the requester does not have access to.
- The requested person does not exist.
- The requested person has been deleted.
- The requested person has not belong to requested course.
- The requested assessment does not exist.
- The AssessmentRecord Summary is not enabled for this site
- The requester supplied both a CourseId and CourseSyncKey.
- The requester supplied both a PersonId and PersonSyncKey.
- Your security settings doesn't allow you to perform that operation. Please contact administration to grant you an access to {HieararchyName} organisation.