Below we have listed the operations, http verbs and an example URL for the TestProfile resource within the Surpass API.
|Operation||HTTP Verb||Example URL|
|Read (Individual by ID)||GET||https://...surpass.com/api/v2/TestProfile/1|
Within the table below we have provided all of the attributes included in the TestProfile resource. This includes the attribute name, data type, if the attribute is a unique identifier and if the attribute is mandatory when sending a POST request.
|Attribute Name||Type||Description||Unique Identifier||Mandatory for Create (POST)|
|Id||Int||The id of the Test Profile in the Database. Unable to POST||X|
|href||String||The link to call the TestProfile resource. Unable to POST.|
|profileName||String||The name of the Test Profile.||X|
|windowPosition||String||The position that the test driver will dock on the screen. 'Left', 'Central' or 'Right'.|
|providerLogocolor / name||String||The name of the Provider Logo associated with the profile|
|providerLogocolor / image||Byte||The image file in colour. Data attribute must be Base64 encoded and passed as a byte string.|
|providerLogomono / name||String|
|providerLogomono / image||Byte||The image file in monochrome. Data attribute must be Base64 encoded and passed as a byte string.|
|clientLogocolor / name||String||The name of the Client Logo associated with the profile.|
|clientLogocolor / image||Byte||The image file in colour. Data attribute must be Base64 encoded and passed as a byte string.|
|clientLogomono / name||String|
|clientLogomono / image||Byte||The image file in mono. Data attribute must be Base64 encoded and passed as a byte string.|
|headerFooterColours / ColourBackground||String||Input HTML colour code. Colour of the header and footer|
|headerFooterColours / ColourText||String||Input HTML colour code. Colour of the text in the header and footer.|
|finishButtonColours / ColourBackground||String||Input HTML colour code. Colour of the Finish button.|
|finishButtonColours / ColourText||String||Input HTML colour code. Colour of the Finish button text.|
|primaryButtonColours / ColourBackground||String||Input HTML colour code. Colour of the Primary buttons (Breadcrumb, Back/Next).|
|primaryButtonColours / ColourText||String||Input HTML colour code. Colour of the Primary buttons text.|
|candidateDetails / All||Boolean||The attributes that will appear on the Confirmation screen after the candidate enters their keycode.|
|candidateDetails / candidateFirstNameEnable||Boolean|
|candidateDetails / candidateLastNameEnable||Boolean|
|candidateDetails / candidateDateOfBirthEnable||Boolean|
|candidateDetais / candidateGenderEnable||Boolean|
|candidateDetails / candidateReferenceEnable||Boolean|
|scoreReportTemplate / name||String||Name of the custom Score Report.|
|scoreReportTemplate / scoreReportHtml||HTML||Input full HTML string for the score report.|
|contentManifestFile / name||String||The name of the Manifest File associated with the profile.|
|contentManifestFile / manifest||XML||The XML for the manifest file.|
- ID is the unique identifier for this resource in the Database.
- Default values in the UI will be maintained if attributes are omitted:
- Surpass images will be retained for client and provider logo if none are provided.
- Score report will be blank.
- First name and last name will be ticked in the candidate details screen.
- Default colours that are presented in the UI will be selected.
- Published setting will default to false.
GET Request and Return
The GET TestProfile 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 TestProfile 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 and response (JSON)
Example GET request and response (XML)
POST Request and Return
The POST TestProfile method requires the attributes listed above to be submitted as part of the body of the HTTPS request. This can be submitted in either JSON or XML format, the content-type used will need to be submitted as part of the header of the request. An example of the address, header and body of the request (for both formats) can be found below.
Example POST request and response (JSON)
Example POST request and response (XML)
To successfully call the TestProfile methods, the user specified in the header of the request must have the "Create Tests" permission.