As part of the Result, AnalyticsResult and HistoricalResult API resources the response informs the consumer of the scale score achieved by the candidate (if it has been applied) and a URL to the full scale score mapping that was applied to the result. Within the Surpass API we have the concept of two separate resources, scale score mapping and analytics scale score mapping. Both resources provide the same purpose but query different Surpass databases, AnalyticsScaleScoreMapping relates to the scale score provided in the AnalyticsResult and HistorcialResult resources and ScaleScoreMapping relates to the Result resource.
Below we have listed the operations, HTTP verbs and an example URL for the scale score mapping resources within the Surpass API.
|Operation||HTTP Verb||Example URL|
Properties for the scale score mapping resources
Within the table below we have provided all of the attributes included in the scale score mapping resources. This includes the property name, data type and description.
|id||int||The unique id of the scale score mapping in the relevant database|
|href||string||The URL to get the scale score mapping that has been applied to a number of results.|
|mappings||collection||A collection of all of the raw score values mapped to the scale score.|
|mappings / rawScore||int||The raw score that could be achieved|
|mappings / scaleScore||int||The scale score that has been mapped to the raw score.|
The GET ScaleScoreMapping resource can be called directly by browsing to the URL. Below we have provided examples of JSON and XML responses that would be returned from the Surpass API when requesting the GET method for the ScaleScoreMapping resource. It is important to remember that the return information will be included within the response object that forms part of the standard GET response; this is detailed in the page Using the Surpass API.
To successfully call the GET ScaleScoreMapping method, the user specified in the header of the request must have the 'View Reports' permission in Surpass at a site level.