Example XML Request & Response - GET Candidate

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

<response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <count>13226</count>
  <top>10</top>
  <skip>0</skip>
  <pageCount>1323</pageCount>
  <nextPageLink>https://...surpass.com/api/v2/Candidate/?$skip=10</nextPageLink>
  <prevPageLink i:nil="true" />
  <response>
    <candidate>
      <reference>Candidate1</reference>
      <id>17</id>
      <href>https://...surpass.com/api/v2/Candidate/17</href>
    </candidate>
    <candidate>
      <reference>Candidate2</reference>
      <id>18</id>
      <href>https://...surpass.com/api/v2/Candidate/18</href>
    </candidate>
    <candidate>
      <reference>Candidate3</reference>
      <id>19</id>
      <href>https://...surpass.com/api/v2/Candidate/19</href>
    </candidate>
     ...
  </response>
  <errors i:nil="true" />
  <serverTimeZone>GMT Standard Time</serverTimeZone>
</response>

https://...surpass.com/api/v2/Candidate?candidateRef1

<response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <count i:nil="true" />
  <top i:nil="true" />
  <skip i:nil="true" />
  <pageCount i:nil="true" />
  <nextPageLink i:nil="true" />
  <prevPageLink i:nil="true" />
  <response>
    <candidate>
      <reference>candidateRef1</reference>
      <id>188</id>
      <href>https://...surpass.com/api/v2/Candidate/188</href>
      <firstName>Scott</firstName>
      <lastName>Flockton</lastName>
      <dateOfBirth>2000-08-05T00:00:00</dateOfBirth>
      <email>Email@btl.com</email>
      <tеl>1234</tеl>
      <uln>1234567890</uln>
      <reasonableAdjustments>false</reasonableAdjustments>
      <retired>false</retired>
      <expiryDate>2025-08-18T00:00:00</expiryDate>
      <isExternal>false</isExternal>
      <centres>
        <centre>
          <reference>BTL001</reference>
          <id>1</id>
          <href>https://...surpass.com/api/v2/Centre/1</href>
        </centre>
      </centres>
      <subjects>
        <subject>
          <reference>03082016</reference>
          <id>142</id>
          <href>https://...surpass.com/api/v2/Subject/142</href>
        </subject>
      </subjects>
    </candidate>
  </response>
  <errors i:nil="true" />
  <serverTimeZone>GMT Standard Time</serverTimeZone>
</response>

Feedback and Knowledge Base