Example JSON Request & Response - GET Test

https://...surpass.com/api/v2/Test?$filter=status eq 'live' and subject/reference eq 'Subject Reference'

{
  "count": 2,
  "top": 10,
  "skip": 0,
  "pageCount": 1,
  "nextPageLink": null,
  "prevPageLink": null,
  "response": [
    {
      "id": 19,
      "reference": "Test Ref 1",
      "href": "https://...surpass.com/api/v2/Test/19"
    },
    {
      "id": 679,
      "reference": "Test Ref 2",
      "href": "https://...surpass.com/api/v2/Test/679"
    }
  ],
  "errors": null,
  "serverTimeZone": "GMT Standard Time"
}

https://...surpass.com/api/v2/Test/19

{
  "count": null,
  "top": null,
  "skip": null,
  "pageCount": null,
  "nextPageLink": null,
  "prevPageLink": null,
  "response": [
    {
      "subject": {
        "id": 22,
        "reference": "Subject Reference",
        "href": "https://...surpass.com/api/v2/Subject/22"
      },
      "name": "Test",
      "reference": "Test Reference 1",
      "status": "Live",
      "certifiedAccessible": false,
      "useAsTemplate": false,
      "ExamType": "ComputerBasedTest",
      "allowTimeExtensionWhileInProgress": false,
      "attemptAutoSubmit": true,
      "resultsUploadGracePeriod": 14,
      "requiresSecureClient": false,
      "secureClientMode": "Locked",
      "requiresInvigilation": false,
      "certifiedForTabletDelivery": false,
      "numberOfResits": 0,
      "validFromDate": "2014-02-19T00:00:00",
      "expiryDate": "2024-02-20T00:00:00",
      "testWindowStartTime": "00:00",
      "testWindowEndTime": "23:59",
      "randomiseTestForms": true,
      "allowTestFormRecycling": true,
      "deliveryOptions": "DeliverDifferentExamsToAllCandidates",
      "testDistribution": "Online",
      "markingType": "StandardMarking",
      "candidateDetails": {
        "required": true,
        "duration": null
      },
      "NDA": {
        "required": true,
        "duration": null,
        "confirmationText": "By ticking this box you confirm that the above details are correct and you will adhere to the Awarding Organisation's code of conduct."
      },
      "progressBar": {
        "required": true,
        "mode": "MarksBased"
      },
      "testStyle": "CustomBranding",
      "styleProfile": {
        "testProfile": {
          "id": 1
        },
        "displayReport": false,
        "displayReportPrintButton": false
      },
      "defaultNavigationLanguage": "English",
      "allowLanguageOverride": true,
      "showPageRequiresScrollingAlert": false,
      "easyPvalue": 0.700,
      "maxEasyPvalue": 0.900,
      "hardPvalue": 0.300,
      "minHardPvalue": 0.100,
      "minimumResitTime": 0,
      "generateTestStatistics": true,
      "allowPackagingOfCandidateResponses": true,
      "automaticallyShowToCentre": false,
      "autoCreatePIN": true,
      "strictControlReasonableAdjustments": false,
      "enableCandidateLogging": false,
      "scoreBoundaries": {
        "type": "Percentage",
        "boundaries": [
          {
            "modifer": "lt",
            "value": 40,
            "description": "Not met",
            "higherBoundary": true
          },
          {
            "modifer": "lt",
            "value": 40,
            "description": "Not met",
            "higherBoundary": false
          },
          {
            "modifer": "gt",
            "value": 40,
            "description": "Close to met",
            "higherBoundary": true
          },
          {
            "modifer": "gt",
            "value": 40,
            "description": "Met",
            "higherBoundary": false
          },
          {
            "modifer": "gt",
            "value": 45,
            "description": "Met",
            "higherBoundary": true
          },
          {
            "modifer": "gt",
            "value": 80,
            "description": "Exceeded",
            "higherBoundary": true
          }
        ]
      }
    }
  ],
  "errors": null,
  "serverTimeZone": "GMT Standard Time"
}

https://...surpass.com/api/v2/Test/Test 01/TestForms

{
  "count": 2,
  "top": 10,
  "skip": 0,
  "pageCount": 1,
  "nextPageLink": null,
  "prevPageLink": null,
  "response": [
    {
      "id": 416,
      "reference": "Test Form 01",
      "href": "https://...surpass.com/api/v2/TestForm/416",
      "status": "Live",
      "valid": true
    },
    {
      "id": 629,
      "reference": "Test Form 02",
      "href": "https://...surpass.com/api/v2/TestForm/629",
      "status": "Live",
      "valid": true
    }
  ],
  "errors": null,
  "serverTimeZone": "GMT Standard Time"
}


Feedback and Knowledge Base