Reads the assessment scales which are available for customers. If course filtering is used (by specifiying either the CourseId or CourseSyncKey in the request), then organisation level security is based on the course organisation.
If no CourseId or CourseSyncKey is specified, only global assessment scales are returned. If either of these optional parameters are specified, then all of the global AND course specific assessment scales are returned.
Input parameters
Name | Description | Type | Mandatory/Optional |
---|---|---|---|
SiteId | Site where action will be executed. | Integer | Optional |
VendorId | VendorId. Currently not used. | Text | Optional |
PageIndex | Index of the requested page. This defaults to 0. | Integer | Optional |
PageSize | Size of the requested page. The default and limit is 100. | Integer | Optional |
CourseId | . NOTE: You are not allowed to enter both CourseId and CourseSyncKey. | Integer | Optional |
CourseSyncKey | SyncKey of the course to get the course specific assessment scales. NOTE: You are not allowed to enter both CourseId and CourseSyncKey. | String | Optional |
Example request
<
soapenv
:Envelope
xmlns:soapenv
=
"http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem
=
"http://tempuri.org/"
>
<
soapenv
:Header/>
<
soapenv
:Body>
<
tem
:ReadAssessmentScales>
<
tem
:request>
<
tem
:PageIndex>0</
tem
:PageIndex>
<
tem
:PageSize>100</
tem
:PageSize>
<
tem
:CourseSyncKey>123</
tem
:CourseSyncKey>
</
tem
:request>
</
tem
:ReadAssessmentScales>
</
soapenv
:Body>
</
soapenv
:Envelope>
Output parameters
Name | Description | Type |
---|---|---|
AssessmentId | Identifier of the assessment scale | Integer |
Title | Name of the assessment | String |
Description | Description of the assessment | String |
Totals | Totals | Enum |
CourseId | Identifier of the course where this assessment is in | Integer |
CourseSyncKey | The course sync key of the course where this assessment is in | String |
AssessmentItemId | Identifier for the assessment item value | Integer |
Title | Assessment item title | String |
Description | Assessment item description | String |
FromAndIncludingPercentage | Percentage value | Double |
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>2012-12-12T10:43:05.456Z</
u
:Created>
<
u
:Expires>2012-12-12T10:48:05.456Z</
u
:Expires>
</
u
:Timestamp>
</
o
:Security>
</
s
:Header>
<
s
:Body>
<
ReadAssessmentScalesResponse
xmlns
=
"http://tempuri.org/"
>
<
ReadAssessmentScalesResult
xmlns:a
=
"http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.AssessmentScales"
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"
>5</
Total
>
<
a
:Assessments>
<
a
:Assessment>
<
a
:AssessmentId>5</
a
:AssessmentId>
<
a
:AssessmentItems>
<
a
:AssessmentItem>
<
a
:AssessmentItemId>126</
a
:AssessmentItemId>
<
a
:Description>Good (G): Always meets expected standards for behaviour and attitude to learning</
a
:Description>
<
a
:FromAndIncludingPercentage>66.66</
a
:FromAndIncludingPercentage>
<
a
:Title>G</
a
:Title>
</
a
:AssessmentItem>
<
a
:AssessmentItem>
<
a
:AssessmentItemId>127</
a
:AssessmentItemId>
<
a
:Description>Fair (F): Sometimes fails to meet expected standards for behaviour and/or attitude to learning</
a
:Description>
<
a
:FromAndIncludingPercentage>33.33</
a
:FromAndIncludingPercentage>
<
a
:Title>F</
a
:Title>
</
a
:AssessmentItem>
<
a
:AssessmentItem>
<
a
:AssessmentItemId>128</
a
:AssessmentItemId>
<
a
:Description>Poor (P): Frequently fails to meet expected standards for behaviour and/or attitude to learning</
a
:Description>
<
a
:FromAndIncludingPercentage>0</
a
:FromAndIncludingPercentage>
<
a
:Title>P</
a
:Title>
</
a
:AssessmentItem>
</
a
:AssessmentItems>
<
a
:CourseId>13</
a
:CourseId>
<
a
:CourseSyncKey>123</
a
:CourseSyncKey>
<
a
:Description>Assessment scale used for assessing behaviour</
a
:Description>
<
a
:Title>Behaviour assessment</
a
:Title>
<
a
:Totals>Average</
a
:Totals>
</
a
:Assessment>
</
a
:Assessments>
</
ReadAssessmentScalesResult
>
</
ReadAssessmentScalesResponse
>
</
s
:Body>
</
s
:Envelope>
Error states
In the following cases it will return an error:
- 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 requester supplied both a CourseId and CourseSyncKey.