To request the client information the request URL should be built as follows:
Client information can only be requested for an individual keycode or id. If this information is required for more than one candidate test session then separate requests would need to be sent to the Surpass API specifying each keycode or id in the request.
Properties for client information on individual results
The table below provides all properties that are returned when requesting client information for a particular result. This includes the property name, type and description.
|id||int||The unique id of the result the client information applies to|
|href||string||The URL to the client information for a particular test|
|reference||string||The keycode for the result the client information applies to|
|value||XML||XML response of the system and software specification, machine identification, SecureClient version and running services of all of the test delivery machines used to take a particular test|
The "value" property returned in the response of the method is in XML format and returns different information depending on the type of delivery that was used i.e Web Delivery or SecureClient. This can be identified in the "systemConfiguration" node of the XML response :
<systemConfiguration source=\"1\" web=\"0\">
Where 1 identifies the delivery method used, "source" relates to the SecureClient and "web" to web delivery.
Information returned from the SecureClient is as follows:
- .Net version and service pack installed
- Flash version
- SecureClient version
- Operating system and service pack
- Processor information
- Installed, usable and free physical memory
- Hard disk space available
- Video and sound card information
- Time zone set on the machine
- Identification - IP and MAC Addresses
- Windows services running
- Windows services that were stopped
- If the browser has audio, video, printing and accessibility support required for Surpass
- Operating system
- Screen resolution and DPI
- Browser information
Below we have provided examples of JSON and XML responses that would be returned from the Surpass API when requesting client information form the Surpass API.
To successfully call this method, the user specified in the header of the request must have the 'View Results' permission for the Subject and Centre associated to the result.