Example JSON Request & Response - GET Candidate

https://...surpass.com/api/v2/Candidate?$top={top}&$skip={skip}&$filter={filter}&$orderby={orderby}

{
  "count": 13226,
  "top": 10,
  "skip": 0,
  "pageCount": 1323,
  "nextPageLink": "https://...surpass.com:443/api/v2/Candidate/?$skip=10",
  "prevPageLink": null,
  "response": [
    {
      "id": 17,
      "reference": "Candidate1",
      "href": "https://...surpass.com/api/v2/Candidate/17"
    },
    {
      "id": 18,
      "reference": "Candidate2",
      "href": "https://...surpass.com/api/v2/Candidate/18"
    },
    {
      "id": 19,
      "reference": "Candidate3",
      "href": "https://...surpass.com/api/v2/Candidate/19"
    }...
  ],
  "errors": null,
  "serverTimeZone": "GMT Standard Time"
}

https://...surpass.com/api/v2/Candidate?reference=CandidateRef

{
  "count": null,
  "top": null,
  "skip": null,
  "pageCount": null,
  "nextPageLink": null,
  "prevPageLink": null,
  "response": [
    {
      "id": 188,
      "reference": "sample string 2",
      "href": "https://...surpass.com/api/v2/Candidate/188",
      "firstName": "Scott",
      "lastName": "Flockton",
      "dateOfBirth": "2000-08-05T00:00:00",
      "email": "Email@btl.com",
      "tеl": "1234",
      "uln": "1234567890",
      "reasonableAdjustments": false,
      "retired": false,
      "expiryDate": "2025-08-18T00:00:00",
      "isExternal": false,
      "centres": [
        {
          "id": 1,
          "reference": "BTL001",
          "href": "https://...surpass.com/api/v2/Centre/1"
        }
      ],
      "subjects": [
        {
          "id": 142,
          "reference": "03082016",
          "href": "https://...surpass.com/api/v2/Subject/142"
        }
      ]
    }
  ],
  "errors": null,
  "serverTimeZone": "GMT Standard Time"
}

Feedback and Knowledge Base