SurpassLocal: Centre Resource

Centres might be defined as the faculty or department, or it might be a delivery centre where candidates go to sit tests; this depends on how you have setup your Surpass solution. Subjects, candidates and users can all be associated to a centre, however centres currently only store name, reference and certain configuration settings within Surpass; associations are made at the subject, candidate and user level.  

Centre Resource

Below we have listed the operations, http verbs and an example URL for the Centre resource within the SurpassLocal API. 

Operation HTTP Verb Example URL
List GET https://...surpass.com/api/v1/Centre
Read (ID) GET https://...surpass.com/api/v1/Centre/ID
Read (reference) GET https://...surpass.com/api/v1/Centre/Reference

Attributes for the Centre Resource

Within the table below we have provided all of the attributes included in the centre resource. This includes the attribute name, data type, if the attribute is orderable when requesting the GET method, if the attribute is orderable when requesting the GET method, and if the attribute is available to filter when requesting the GET method. 

Property Name Type Description Order
(GET)
Filter
(GET)
Available Operators
(GET)
id int The unique identifier for the centre.
x x eq, lt, gt
reference string
The reference assigned to the centre x x eq, contains
href string The unique URL for the centre.
name string
The centre name, this does not have to be unique


addressLine1 string
100 chars
The address of the centre

addressLine2 string
100 chars
Any additional centre address details required

town string
100 chars
The town the centre is based in

county resource The county the centre is based in, this is a resource in the surpass API and requires an ID which can be found by requesting the GET county method. 

country resource The country the centre is based in, this is a resource in the surpass API and requires an ID which can be found by requesting the GET county method.  


postCode string
12 chars
The postcode for the centre

Additional Notes

  • randomiseTestForms will enforce randomised test forms when a test is being scheduled by users with the relevant permissions as opposed to the user manually selecting a test form to schedule.

  • hideSubjectsIncludedInSubjectGroups will prevent any subjects that are included in a Subject Group from appearing as a selectable subject in Test Creation.


GET Request and Return

The GET Centre resource can be called directly by browsing to the URL, any required parameters such as $filter, $orderBy, $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 Centre 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 understanding the Surpass API.

Example GET request & response (JSON)

Example GET request & response (XML)


Filtering results on Resource objects

The GET Centre method allows you to filter on resource objects contained within the Centre resource. You can add $filter, £orderBy, $skip and $stop to the URL that you send.

The ID and reference are supported fields when using filter and orderBy.

See the following examples:

https://...surpass.com/api/v1/TestSession/?$filter=id eq’XX’
https://...surpass.com/api/v1/TestSession/ TestSession?$filter=ref eq’XX’


Required Permissions

To successfully call the Centre methods in the SurpassLocal Centre Resource, the user validating the requests must exist within BTL's CMS system. If you require a password reminder or a new account to be created, send a request to the BTL Service Desk (support@btl.com).


Feedback and Knowledge Base