Calling the GetResult Method in the Surpass Web API

Note: Version 2 of the Surpass API is now available. For any customers not already using API v1, please refer to the API v2 Developer Portal.

The GetResult web method in the Surpass API returns information regarding the test/result that was passed into the parameters of the call. This includes information such as the grade, candidate and centre; further information has been provided below.

GetResult


GET api/v1/TestResults/GetResult?keycode={keycode}

Input Parameters


The input parameters that are required for the GetResult web method are as follows:
Input ParameterTypeDescription
Keycode String, mandatory The keycode of the result you are trying to retrieve, this information is provided as part of the response from the GetResults web method.

Request


The GetResult web method can be called directly by browsing to the url, the keycode parameter will need to form part of the url that is sent.

An example of this call is as follows:

https://[YourSurpassEnvironment]/api/v1/TestResults/GetResult?keycode=7ULVLZD2

Required Permissions


To successfully call GetResult the user specified in the header of the request must have the 'View Results' permission in Surpass and be associated to the relevant centre and subject of the exam that is contained within the request.

Return

Depending on how the request was submitted the response will be returned in either JSON or XML format, the response will return high level information about the result that was requested as part of the input parameters.

If the call was unsuccessful then you will receive an error message, all error messages available in the Surpass API can be found here.

An example of the response in both formats can be found using the below links:  

JSON response 
XML Response

Next Article 

Feedback and Knowledge Base