SummaryResult Resource

Within the Surpass API, a result is all of the information regarding a candidate's completed exam session. The summary result resource provides high level detail about the result so the response is lighter and the information returned is more relevant to the client.

SummaryResult Resource

Below we have listed the operations, HTTP verbs and an example URL for the summary result resource within the Surpass API.
Operation HTTP Verb Example URL
List GET https://...surpass.com/api/v2/SummaryResult/
Read (Individual by ID) GET https://...surpass.com/api/v2/SummaryResult/{id}
Read (Individual by Keycode) GET https://...surpass.com/api/v2/SummaryResult/{keycode}
Attributes for the SummaryResult Resource

Within the table below we have provided all of the attributes included in the SummaryResult resource. This includes the attribute name, data type, if the attribute is orderable when requesting the GET method, and if the attribute is available to filter when requesting the GET method.
Attribute Name Type Description Order (GET) Filter (GET) Available Operators (GET)
id int Unique identifier for this result.
reference String The reference for this resource is the keycode that was used. eq
href String The URL to request this specific resource.
subject Resource The subject the test belongs to. To filter on this please read the section Filtering results on Resource objects. X eq
test Resource The test that was delivered. To filter on this please read the section Filtering results on Resource objects. X eq
testForm Resource The test form that was delivered. To filter on this please read the section Filtering results on Resource objects. X eq
centre Resource The centre the test was delivered at. To filter on this please read the section Filtering results on Resource objects. X eq
candidate Resource The candidate that took the test. To filter on this please read the section Filtering results on Resource objects. X eq
mark Int The mark achieved for the entire test.
availableMarks Int The total number of marks available for the test.
grade String The grade that the candidate achieved for this test.
startedDate DateTime The date/time the test was started.
submittedDate DateTime The date/time the test was submitted X le, ge
warehousedDate DateTime The date the test was warehoused in Test Administration. This is the date the test was marked, moderated and released to results. X le, ge
markedExternally Boolean Refers to if the test is marked outside of Surpass.
Additional Notes
  • ID is the unique identifier for this resource in the Database.
  • Resource reference is the reference allocated to the resource within Surpass.
  • The DateTime value is only able to parse by C#.
  • When filtering summary results you can use the same attribute twice for date fields such as "warehousedDate". This allows you to search between two dates. The format for this request would be as follows: 
    https://...surpass.com/api/v2/SummaryResult?$filter=warehousedDate ge ‘08/06/2015T00:00:00’ and warehousedDate le ‘09/06/2015T00:00:00’
  • Tests that have been scheduled through the Surpass API with the markedExternally attribute passed as True will not be returned when calling the GET method for the SummaryResult resource unless specifically requested in the URL. For example: 
    https://...surpass.com/api/v2/SummaryResult?$top=10&$skip=0&$filter=subject/reference eq 'JLTS'&markedExternally=true



GET SummaryResult Request and Return


The SummaryResult resource can be called directly by browsing to the URL. Any parameters such as markedExternally, $filter, $skip and $top would need to form part of the URL that is sent. 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 SummaryResult 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.

Example GET request & response (JSON)
Example GET request & response (XML)


Filtering results on Resource objects
   
The GET SummaryResult method allows you to filter on resource objects contained within the summary result resource. Within a standard summary result response, subjects, centres, tests, test forms and candidates for that exam session are returned. When filtering on these attributes, we need to additionally specify what attribute we are searching on within that resource so this is built differently to other attributes contained within the SummaryResult resource. Below we have provided some examples of how these requests are built:

https://...surpass.com/api/v2/SummaryResult?$filter=subject/reference eq 'subject ref 1' and centre/reference eq 'centre ref 1’
https://...surpass.com/api/v2/SummaryResult?$filter=subject/id eq 21 and centre/id eq 25


Required Permissions

To successfully call the GET SummaryResult method 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 contained within the request.

Feedback and Knowledge Base