TestProfile API

Test profiles allow you to customise the appearance of the Surpass test driver. This includes adding custom logos, defining colour schemes, and choosing what information and functionality is available to candidates during a test.

The TestProfile API resource is used to retrieve and create test profiles.

This article explains what calls can be made to the Surpass API using the TestProfile resource.

Import this API into your Postman Workspace

Retrieving test profile information

get /api/v2/TestProfile/{id}

Send a request to the endpoint to retrieve information for a specific test profile using its ID. No request body is required.

Parameters

Parameters are passed with the endpoint to influence the response. Header parameters are included in the request header. Path parameters are extensions of the endpoint, and query parameters follow ? after any path parameters.

Name

Parameter

Input

Description

authorization

header

MANDATORY

Basic {credentials}

Basic authentication details must be passed to authorise the user’s request, where {credentials} is a Base64 encoded username:password string.

accept

header

OPTIONAL

application/json or application/xml

Determines data format of the response, which can be either JSON or XML.

path

OPTIONAL

/api/v2/TestProfile/{id}

Returns information for the specified test profile, where {id} is the test profile’s unique identifier.

Sample response

If successful, the HTTP status code will be 200 and the response body will contain the information in either JSON or XML format as requested.

{
    "count": null,
    "top": null,
    "skip": null,
    "pageCount": null,
    "nextPageLink": null,
    "prevPageLink": null,
    "response": [
        {
            "profileName": "Default",
            "published": true,
            "showAlertsInFrontOfAllWindows": false,
            "warningIntervals": "30,15,5",
            "deleted": false,
            "windowPosition": "Central",
            "headerFooterColours": {
                "ColourBackground": "#3D505A",
                "ColourText": "#FFFFFF"
            },
            "finishButtonColours": {
                "ColourBackground": "#F7D78C",
                "ColourText": "#3D505A"
            },
            "primaryButtonColours": {
                "ColourBackground": "#2B9ED8",
                "ColourText": "#FFFFFF"
            },
            "secondaryButtonColours": {
                "ColourBackground": "#3D505A",
                "ColourText": "#FFFFFF"
            },
            "candidateDetails": {
                "All": false,
                "candidateFirstNameEnable": true,
                "candidateLastNameEnable": true,
                "candidateDateOfBirthEnable": false,
                "candidateGenderEnable": false,
                "candidateReferenceEnable": false
            },
            "clientLogo": {
                "color": null,
                "monochrome": null
            },
            "providerLogo": {
                "color": {
                    "imageId": 1,
                    "imageURL": "https://{your Surpass instance}.surpass.com/files/tempFiles/01192022/testProfiles/images/1.png",
                    "imageName": "ProviderLogoColour.png",
                    "tempImagePath": null,
                    "altText": "Surpass: The Assessment Platform"
                },
                "monochrome": {
                    "imageId": 2,
                    "imageURL": "https://{your Surpass instance}.surpass.com/files/tempFiles/01192022/testProfiles/images/2.png",
                    "imageName": "ProviderLogoMonochrome.png",
                    "tempImagePath": null,
                    "altText": "Surpass: The Assessment Platform"
                }
            },
            "scoreReportTemplate": null,
            "contentManifestFile": null,
            "supportingInfoFile": null,
            "deliveryPresentation": {
                "finishButtonShown": true,
                "sectionReviewButtonShown": true,
                "flagButtonShown": true,
                "preferencesButtonShown": true,
                "questionTitleDisplayMode": "Name",
                "SectionInformationShown": true,
                "ItemSetNumberingEnabled": false,
                "ItemSetHeaderShown": false,
                "TextForItemSetName": "",
                "TextForItemName": "",
                "sourceMaterialBrowserNavigationShown": true,
                "enableCheckboxesInDelivery": false,
                "allowSourceMaterialClose": false,
                "allowHighlighter": true,
                "allowStrikethrough": true
            },
            "candidateReview": {
                "correctItemsEnable": true,
                "incorrectItemsEnable": true,
                "unattemptedItemsEnable": true,
                "candidateResponseEnable": true,
                "correctAnswersEnable": true,
                "candidateFeedbackEnable": true
            },
            "id": 1,
            "href": "https://{your Surpass instance}.surpass.com/api/v2/TestProfile/1"
        }
    ],
    "errors": null,
    "serverTimeZone": "GMT Standard Time"
}

Response schema

The response schema contains a description of every property that can be returned for this endpoint.

count integer

Details how many test profiles there are in total. This is null because the information retrieved is for a specific test profile.

top integer

Details number of test profiles returned in the response. This is null because the information retrieved is for a specific test profile.

skip integer

Details how many test profiles were skipped to display those in the response. This is null because the information retrieved is for a specific test profile.

pageCount integer

Details how many pages of test profiles there are. This is null because the information retrieved is for a specific test profile.

nextPageLink string

The endpoint to call the next page of test profile. This is null because the information retrieved is for a specific test profile.

prevPageLink string

The endpoint to call the previous page of test profiles. This is null because the information retrieved is for a specific test profile.

response array

Contains the rest of the response.

profileName string

The test profile’s name.

published Boolean

Determines whether the test profile is published. If true, the test profile is available to be added to a test.

showAlertsInFrontOfAllWindows Boolean

Determines whether the Show alerts in front of all windows setting is enabled. If true, time remaining alerts are shown to candidates in front of all windows, such as when a candidate is viewing source material.

warningIntervals string

Determines the intervals for the Time Remaining Alerts (HTML only) setting. The default values are 30, 15, and 5 minutes. Values are separated by a comma, for example 30,15,5.

deleted Boolean

Determines whether the test profile is deleted.

windowPosition enumeration

Determines the Delivery Engine Position setting; the position of test content on candidates’ screens. The available options are Left, Central, or Right.

headerFooterColours object

Contains the colour information for the test driver’s header and footer.

headerFooterColours/ColourBackground string

The hex colour code for the header and footer’s background colour.

headerFooterColours/ColourText string

The hex colour code for the header and footer’s text colour.

finishButtonColours object

Contains the colour information for the test driver’s Start Test and Finish Test buttons.

finishButtonColours/ColourBackground string

The hex colour code for the Start Test and Finish Test buttons.

finishButtonColours/ColourText string

The hex colour code for the Start Test and Finish Test buttons’ text colour. This also changes the colour of the Agree to Terms window before the test begins.

primaryButtonColours object

Contains the colour information for the test driver’s OK, Confirm, Next, Back, Flag, and Introduction buttons and breadcrumbs for unattempted items.

primaryButtonColours/ColourBackground string

The hex colour code for the OK, Confirm, Next, Back, Flag, and Introduction buttons and breadcrumbs for unattempted items.

primaryButtonColours/ColourText string

The hex colour code for the OK, Confirm, Next, Back, Flag, and Introduction buttons and breadcrumbs for unattempted items’ text colour.

secondaryButtonColours object

Contains the colour information for the test driver’s System Check and Preferences buttons on the keycode screen and breadcrumbs for attempted items.

secondaryButtonColours/ColourBackground string

The hex colour code for the System Check and Preferences buttons on the keycode screen and breadcrumbs for attempted items.

secondaryButtonColours/ColourText string

The hex colour code for the System Check and Preferences buttons on the keycode screen and breadcrumbs for attempted items’ text colour.

candidateDetails object

Contains the information for which candidate details are displayed to the candidate.

candidateDetails/All Boolean

If true, displays all of the candidate’s details.

candidateDetails/candidateFirstNameEnable Boolean

If true, displays the candidate’s first name.

candidateDetails/candidateLastNameEnable Boolean

If true, displays the candidate’s last name.

candidateDetails/candidateDateOfBirthEnable Boolean

If true, displays the candidate’s date of birth.

candidateDetails/candidateGenderEnable Boolean

If true, displays the candidate’s gender.

candidateDetails/candidateReferenceEnable Boolean

If true, displays the candidate’s unique reference code.

clientLogo object

Contains the Client Logo settings’ information.

clientLogo/color object

Contains the colour version of the client logo’s information.

clientLogo/color/imageId integer

The logo’s unique identifier.

clientLogo/color/imageURL string

The file path for where the image is stored, for example https://{your Surpass instance}.surpass.com/files/tempFiles/01192022/testProfiles/images/{id}.png where {id} is the logo’s unique identifier.

clientLogo/color/imageName string

The logo’s name, including the filetype extension, which must be one of GIF, JPEG, or PNG.

clientLogo/color/tempImagePath string

NOTE: This is a retired property that has no bearing on the test profile.

clientLogo/color/altText string

The logo’s alt text.

clientLogo/monochrome object

Contains the monochrome version of the client logo’s information.

clientLogo/monochrome/imageId integer

The logo’s unique identifier.

clientLogo/monochrome/imageURL string

clientLogo/monochrome/imageName string

The logo’s name, including the filetype extension, which must be a transparent GIF.

clientLogo/monochrome/tempImagePath string

NOTE: This is a retired property that has no bearing on the test profile.

clientLogo/monochrome/altText string

The logo’s alt text.

providerLogo object

Contains the Provider Logo settings’ information.

providerLogo/color object

Contains the colour version of the provider logo’s information.

providerLogo/color/imageId integer

The logo’s unique identifier.

providerLogo/color/imageURL string

providerLogo/color/imageName string

The logo’s name, including the filetype extension, which must be one of GIF, JPEG, or PNG.

providerLogo/color/tempImagePath string

NOTE: This is a retired property that has no bearing on the test profile.

providerLogo/color/altText string

The logo’s alt text.

providerLogo/monochrome object

Contains the monochrome version of the provider logo’s information.

providerLogo/monochrome/imageId integer

The logo’s unique identifier.

providerLogo/monochrome/imageURL string

providerLogo/monochrome/imageName string

The logo’s name, including the filetype extension, which must be a transparent GIF.

providerLogo/monochrome/tempImagePath string

NOTE: This is a retired property that has no bearing on the test profile.

providerLogo/color/altText string

The logo’s alt text.

scoreReportTemplate object

Contains the Score Report template’s information.

NOTE: These settings only apply if Test Feedback options are not enabled in Test Form Details. For more information, read About test form settings.

scoreReportTemplate/id integer

The template’s unique identifier.

scoreReportTemplate/fileUrl string

The file path for where the template is stored, for example https://{your Surpass instance}.surpass.com/files/tempFiles/01192022/testProfiles/images/{id}.png where {id} is the template image’s unique identifier.

scoreReportTemplate/fileName string

The template’s name, including the filetype extension, which must be an HTML file.

scoreReportTemplate/tempFilePath string

NOTE: This is a retired property that has no bearing on the test profile.

contentManifestFile object

Contains the Manifest File information, which allows you to upload a custom XML file to your test profile.

contentManifestFile/id integer

The manifest file’s unique identifier.

contentManifestFile/fileUrl string

The file path for where the file is stored, for example https://{your Surpass instance}.surpass.com/files/tempFiles/01192022/testProfiles/images/{id}.png where {id} is the manifest file’s unique identifier.

contentManifestFile/fileName string

The manifest file’s name, including the filetype extension, which must be an XML file.

supportingInfoFile object

Contains the Supporting Information File information, which is a JSON file that can be uploaded in the UI.

supportingInfoFile/id integer

The supporting information file’s unique identifier.

supportingInfoFile/fileUrl string

supportingInfoFile/fileName string

The supporting information file’s name, including the filetype extension, which must be a JSON file.

deliveryPresentation object

Contains the Delivery Presentation settings’ information.

deliveryPresentation/finishButtonShown Boolean

Determines whether the Finish Test button is shown or hidden from the candidate. If false, the button is hidden and candidates must wait until the test timer expires.

deliveryPresentation/sectionReviewButtonShown Boolean

Determines whether the Section Review button is shown or hidden from the candidate. If true, candidates can view detailed information on the status of items.

deliveryPresentation/flagButtonShown Boolean

Determines whether the Flag button is shown or hidden from the candidate. If true, candidates can highlight items that require further attention.

deliveryPresentation/preferencesButtonShown Boolean

Determines whether the Preferences button is shown or hidden from the candidate. If true, candidates can choose the text colour and colour scheme of the test.

deliveryPresentation/questionTitleDisplayMode enumeration

Determines whether the Question Information Options setting is set to show item name (Name) or a numerical question counter (Counter) in the test header.

deliveryPresentation/sectionInformationShown Boolean

Determines whether the Section Information setting is set to show (true) or hide (false) section information in the test header.

deliveryPresentation/ItemSetNumberingEnabled Boolean

Determines whether the Item Set Numbering setting is enabled. If true, items in an item set appear together in navigation breadcrumbs in a decimal format.

deliveryPresentation/ItemSetHeaderShown Boolean

Determines whether the Item Set Header setting is set to show (true) or hide (false) the item set header. This appears at the top of each item set to help candidates identify items within the set.

deliveryPresentation/TextForItemSetName string

If deliveryPresentation/itemSetHeaderShown is set to true, you can configure the visible Item Set Label (for example, ‘Case study’).

deliveryPresentation/TextForItemName string

If deliveryPresentation/itemSetHeaderShown is set to true, you can configure the visible Item Label (for example, ‘Scenario’).

deliveryPresentation/sourceMaterialBrowserNavigationShown Boolean

Determines whether the HTML Browser Navigation setting is enabled. If true, HTML source material has a home screen, forward and backward navigation, and refresh.

deliveryPresentation/enableCheckboxesInDelivery Boolean

Determines whether the Checkboxes setting is set to show (true) or hide (false) checkboxes in delivery for Multiple Choice, Multiple Response, and Either/Or items, and Multiple Choice and Multiple Response survey items.

deliveryPresentation/allowSourceMaterialClose Boolean

Determines whether the Close Docked Source Material setting is enabled. If true, the Close button in the Surpass PDF viewer is available to candidates.

NOTE: The Close button is only available in tests delivered in HTML SecureClient. For more information, read About the Surpass PDF Viewer.

deliveryPresentation/allowHighlighter Boolean

Determines whether candidates can use the highlighting tool (true) or not (false). For more information on the highlighting tool, read Using the highlighting tool in the test driver.

deliveryPresentation/allowStrikethrough Boolean

Determines whether candidates can use the strikethrough tool (true) or not (false). For more information on the strikethrough tool, read Using the strikethrough tool in the test driver.

candidateReview object

Contains the Candidate Review settings’ information.

NOTE: This is a retired object that has no bearing on Candidate Review sessions.

candidateReview/correctItemsEnable Boolean

Determines whether the Correct Items setting is set to show (true) or hide (false) items that the candidate answered correctly.

candidateReview/IncorrectItemsEnable Boolean

Determines whether the Incorrect Items setting is set to show (true) or hide (false) items that the candidate answered incorrectly.

candidateReview/unattemptedItemsEnable Boolean

Determines whether the Unattempted Items setting is set to show (true) or hide (false) items that the candidate did not attempt.

candidateReview/candidateResponseEnable Boolean

Determines whether the Candidate’s Response setting is set to show (true) or hide (false) the candidate’s response to an item.

candidateReview/correctAnswersEnable Boolean

Determines whether the Correct Answers setting is set to show (true) or hide (false) the item’s correct answer.

candidateReview/candidateFeedbackEnable Boolean

Determines whether the Candidate Feedback setting is set to show (true) or hide (false) candidate feedback.

id integer

The test profile’s unique identifier.

href string

The endpoint to call the test profile’s information, such as /api/v2/TestProfile/{id} where {id} is the test profile’s unique identifier.

errors string

Information about any errors that occurred during the request.

serverTimeZone enumeration

The timezone of the server sending the response.

Creating a test profile

post /api/v2/TestProfile

Send a request to the endpoint to create a test profile.

Parameters

Name	Parameter	Input	Description
authorization	header MANDATORY	`Basic {credentials}`	Basic authentication details must be passed to authorise the user’s request, where `{credentials}` is a Base64 encoded `username:password` string.
content-type	header MANDATORY	`application/json` or `application/xml`	Determines data format of the request, which can be either JSON or XML.
content-length	header MANDATORY	`{number}`	Determines the number of characters passed in the body of the request, where `{number}` is a numerical figure. This is usually automatically calculated when the request is sent.
accept	header OPTIONAL	`application/json` or `application/xml`	Determines data format of the response, which can be either JSON or XML.

Sample request

The following request contains the minimum required request body to create a test profile.

{
    "profileName": "Geography Test - Test Profile"
}

EXAMPLE: In this sample request, a test profile called ‘Geography Test – Test Profile’ is created.

Request body schema

The request body schema contains a description of every property that can be passed with this endpoint.

profileName string mandatory

The test profile’s name.

published Boolean optional

Determines whether the test profile is published. If true, the test profile is available to be added to a test. Defaults to false if omitted.

showAlertsInFrontOfAllWindows Boolean optional

warningIntervals string optional

Determines the intervals for the Time Remaining Alerts (HTML only) setting. The default values are 30, 15, and 5 minutes. Values are separated by a comma, for example 30,15,5 (the default values if omitted).

windowPosition enumeration optional

Determines the Delivery Engine Position setting; the position of test content on candidates’ screens. The available options are Left, Central, or Right. Defaults to Central if omitted.

providerLogoColor object optional

Contains the colour Provider Logo settings’ information. Defaults to the Surpass logo if omitted.

providerLogoColor/name string

The logo’s name, including the filetype extension, which must be one of GIF, JPEG, or PNG.

providerLogoColor/image string

The logo’s file data in encoded Base64 format. Logos must be less than 100 kb and they are resized to 180 x 60px.

providerLogocolor/altText string

The logo’s alt text.

providerLogoMono object optional

Contains the monochrome Provider Logo settings’ information. Defaults to the Surpass logo if omitted.

providerLogoMono/name string

The logo’s name, including the filetype extension, which must a transparent GIF.

providerLogoMono/image string

The logo’s file data in encoded Base64 format. Logos must be less than 100 kb and they are resized to 180 x 60px.

providerLogoMono/altText string

The logo’s alt text.

clientLogoColor object optional

Contains the colour Client Logo settings’ information. Defaults to the Surpass logo if omitted.

clientLogoColor/name string

The logo’s name, including the filetype extension, which must be one of GIF, JPEG, or PNG.

clientLogoColor/image string

The logo’s file data in encoded Base64 format. Logos must be less than 100 kb and they are resized to 180 x 60px.

clientLogocolor/altText string

The logo’s alt text.

clientLogoMono object optional

Contains the monochrome Client Logo settings’ information. Defaults to the Surpass logo if omitted.

clientLogoMono/name string

The logo’s name, including the filetype extension, which must a transparent GIF.

clientLogoMono/image string

The logo’s file data in encoded Base64 format. Logos must be less than 100 kb and they are resized to 180 x 60px.

clientLogoMono/altText string

The logo’s alt text.

headerFooterColours object optional

Contains the colour information for the test driver’s header and footer.

headerFooterColours/ColourBackground string

The hex colour code for the header and footer’s background colour. Defaults to #3D505A if omitted.

headerFooterColours/ColourText string

The hex colour code for the header and footer’s text colour. Defaults to #FFFFFF if omitted.

finishButtonColours object optional

Contains the colour information for the test driver’s Start Test and Finish Test buttons.

finishButtonColours/ColourBackground string

The hex colour code for the Start Test and Finish Test buttons. Defaults to #F7D78C if omitted.

finishButtonColours/ColourText string

The hex colour code for the Start Test and Finish Test buttons’ text colour. This also changes the colour of the Agree to Terms window before the test begins. Defaults to #3D505A if omitted.

primaryButtonColours object optional

Contains the colour information for the test driver’s OK, Confirm, Next, Back, Flag, and Introduction buttons and breadcrumbs for unattempted items.

primaryButtonColours/ColourBackground string

The hex colour code for the OK, Confirm, Next, Back, Flag, and Introduction buttons and breadcrumbs for unattempted items. Defaults to #2B9ED8 if omitted.

primaryButtonColours/ColourText string

The hex colour code for the OK, Confirm, Next, Back, Flag, and Introduction buttons and breadcrumbs for unattempted items’ text colour. Defaults to #FFFFFF if omitted.

secondaryButtonColours object optional

Contains the colour information for the test driver’s System Check and Preferences buttons on the keycode screen and breadcrumbs for attempted items.

secondaryButtonColours/ColourBackground string

The hex colour code for the System Check and Preferences buttons on the keycode screen and breadcrumbs for attempted items. Defaults to #3D505A if omitted.

secondaryButtonColours/ColourText string

The hex colour code for the System Check and Preferences buttons on the keycode screen and breadcrumbs for attempted items’ text colour. Defaults to #FFFFFF if omitted.

candidateDetails object optional

Contains the information for which candidate details are displayed to the candidate.

candidateDetails/All Boolean

If true, displays all of the candidate’s details. Defaults to false if omitted.

candidateDetails/candidateFirstNameEnable Boolean

If true, displays the candidate’s first name. Defaults to true if omitted.

candidateDetails/candidateLastNameEnable Boolean

If true, displays the candidate’s last name. Defaults to true if omitted.

candidateDetails/candidateDateOfBirthEnable Boolean

If true, displays the candidate’s date of birth. Defaults to false if omitted.

candidateDetails/candidateGenderEnable Boolean

If true, displays the candidate’s gender. Defaults to false if omitted.

candidateDetails/candidateReferenceEnable Boolean

If true, displays the candidate’s unique reference code. Defaults to false if omitted.

scoreReportTemplate object optional

Contains the Score Report template’s information. Defaults to null if omitted.

NOTE: These settings only apply if Test Feedback options are not enabled in Test Form Details. For more information, read About test form settings.

scoreReportTemplate/name string

The template’s name, including the filetype extension, which must be an HTML file.

scoreReportTemplate/scoreReportHtml string

The template in HTML format.

contentManifestFile object optional

Contains the Manifest File information, which allows you to upload a custom XML file to your test profile. Defaults to null if omitted.

contentManifestFile/name string

The manifest file’s name, including the filetype extension, which must be an XML file.

contentManifestFile/manifest string

The manifest file’s file data in encoded Base64 format.

supportingInfoFile object optional

Contains the Supporting Information File information, which is a JSON file that can also be uploaded in the UI. Defaults to null if omitted.

EXAMPLE: If you are extracting information about a test session from the Surpass API for test centre administrators, you might want to upload a file containing candidate check-in steps.

supportingInfoFile/name string

The supporting information file’s name, including the filetype extension, which must be a JSON file.

supportingInfoFile/supportingInfo string

The supporting information file’s file data in encoded Base64 format.

deliveryPresentation object optional

Contains the Delivery Presentation settings’ information.

deliveryPresentation/finishButtonShown Boolean

Determines whether the Finish Test button is shown or hidden from the candidate. If false, the button is hidden and candidates must wait until the test timer expires. Defaults to true if omitted.

deliveryPresentation/sectionReviewButtonShown Boolean

Determines whether the Section Review button is shown or hidden from the candidate. If true, candidates can view detailed information on the status of items. Defaults to true if omitted.

deliveryPresentation/flagButtonShown Boolean

Determines whether the Flag button is shown or hidden from the candidate. If true, candidates can highlight items that require further attention. Defaults to true if omitted.

deliveryPresentation/preferencesButtonShown Boolean

Determines whether the Preferences button is shown or hidden from the candidate. If true, candidates can choose the text colour and colour scheme of the test. Defaults to true if omitted.

deliveryPresentation/questionTitleDisplayMode enumeration

Determines whether the Question Information Options setting is set to show item name (Name) or a numerical question counter (Counter) in the test header. Defaults to Name if omitted.

deliveryPresentation/sectionInformationShown Boolean

Determines whether the Section Information setting is set to show (true) or hide (false) section information in the test header. Defaults to true if omitted.

deliveryPresentation/ItemSetNumberingEnabled Boolean

Determines whether the Item Set Numbering setting is enabled. If true, items in an item set appear together in navigation breadcrumbs in a decimal format. Defaults to false if omitted.

deliveryPresentation/ItemSetHeaderShown Boolean

deliveryPresentation/TextForItemSetName string

If deliveryPresentation/itemSetHeaderShown is set to true, you can configure the visible Item Set Label (for example, ‘Case study’).

deliveryPresentation/TextForItemName string

If deliveryPresentation/itemSetHeaderShown is set to true, you can configure the visible Item Label (for example, ‘Scenario’).

deliveryPresentation/sourceMaterialBrowserNavigationShown Boolean

Determines whether the HTML Browser Navigation setting is enabled. If true, HTML source material has a home screen, forward and backward navigation, and refresh. Defaults to true if omitted.

deliveryPresentation/enableCheckboxesInDelivery Boolean

deliveryPresentation/allowSourceMaterialClose Boolean

Determines whether the Close Docked Source Material setting is enabled. If true, the Close button in the Surpass PDF viewer is available to candidates. Defaults to false if omitted.

NOTE: The Close button is only available in tests delivered in HTML SecureClient. For more information, read About the Surpass PDF Viewer.

deliveryPresentation/allowHighlighter Boolean

Determines whether candidates can use the highlighting tool (true) or not (false). For more information on the highlighting tool, read Using the highlighting tool in the test driver. Defaults to true if omitted.

deliveryPresentation/allowStrikethrough Boolean

Determines whether candidates can use the strikethrough tool (true) or not (false). For more information on the strikethrough tool, read Using the strikethrough tool in the test driver. Defaults to true if omitted.

candidateReview object optional

Contains the Candidate Review settings’ information.

NOTE: This is a retired object that has no bearing on Candidate Review sessions and should therefore not be used.

candidateReview/correctItemsEnable Boolean

Determines whether the Correct Items setting is set to show (true) or hide (false) items that the candidate answered correctly. Defaults to true if omitted.

candidateReview/IncorrectItemsEnable Boolean

Determines whether the Incorrect Items setting is set to show (true) or hide (false) items that the candidate answered incorrectly. Defaults to true if omitted.

candidateReview/unattemptedItemsEnable Boolean

Determines whether the Unattempted Items setting is set to show (true) or hide (false) items that the candidate did not attempt. Defaults to true if omitted.

candidateReview/candidateResponseEnable Boolean

Determines whether the Candidate’s Response setting is set to show (true) or hide (false) the candidate’s response to an item. Defaults to true if omitted.

candidateReview/correctAnswersEnable Boolean

Determines whether the Correct Answers setting is set to show (true) or hide (false) the item’s correct answer. Defaults to true if omitted.

candidateReview/candidateFeedbackEnable Boolean

Determines whether the Candidate Feedback setting is set to show (true) or hide (false) candidate feedback. Defaults to true if omitted.

Sample response

If successful, the HTTP status code will be 200 and the response body will contain the new test profile’s details.

{
    "id": 1,
    "href": "https://{your Surpass instance}.surpass.com/api/v2/TestProfile/1",
    "errors": null,
}

Error Codes

Refer to the following table for information on error codes that may be encountered when using this resource.

Name	Code	Description
InternalServer	1	Internal server error.
Unauthorized	3	The request has been sent by an unauthorised user.
IncorrectFieldFormat	4	A field in the request has not been completed in the correct format.
InaccessibleOperation	5	The request has been sent by a user with invalid permissions.
InaccessibleData	6	The request has been sent by a user with invalid permissions.
MissingBody	7	There is an issue with the request body.
InvalidInputParameters	15	There is an issue with the path or query parameters.
InvalidId	16	The ID number used in the request is invalid.

TestProfile API

In This Article

Retrieving test profile information

Parameters

Sample response

Response schema

Creating a test profile

Parameters

Sample request

Request body schema

Sample response

Error Codes

Further reading

About the site