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|
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.
|id||int||The unique identifier for the centre.
||x||x||eq, lt, gt|
||The reference assigned to the centre||x||x||eq, contains|
|href||string||The unique URL for the centre.|
||The centre name, this does not have to be unique|
|The address of the centre|
|Any additional centre address details required|
|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.
|The postcode for the centre|
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
- 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.
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/ TestSession?$filter=ref eq’XX’
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 (email@example.com).