Example XML Request & Response - GET User

https://...surpass.com/api/v2/User/

<response>

    <User>

     <id>17</id>

     <reference>User1</reference>

     <href>https://...surpass.com/api/v2/User/17</href>

    </User>

    <User>

     <id>18</id>

     <reference>User2</reference>

     <href>https://...surpass.com/api/v2/User/18</href>

    </User>

</response> 


https://...surpass.com/api/v2/User/618

<user>

      <reference>JamesL</reference>

      <id>618</id>

      <href>https://...surpass.com/api/v2/User/618</href>

      <firstName>James</firstName>

      <lastName>Lomax</lastName>

      <ssoExternalId i:nil="true" />

      <email>testuser@btl.com</email>

      <jobTitle></jobTitle>

      <defaultLanguage>English</defaultLanguage>

      <dateCreated>2015-10-05T08:19:00.497</dateCreated>

      <retired>true</retired>

      <expiryDate>2027-07-21T00:00:00</expiryDate>

    </user>


https://...surpass.com/api/v2/User?reference=JLTC

<user>

      <reference>JamesL</reference>

      <id>618</id>

      <href>https://...surpass.com/api/v2/User/618</href>

      <firstName>James</firstName>

      <lastName>Lomax</lastName>

      <ssoExternalId i:nil="true" />

      <email>testuser@btl.com</email>

      <jobTitle></jobTitle>

      <defaultLanguage>English</defaultLanguage>

      <dateCreated>2015-10-05T08:19:00.497</dateCreated>

      <retired>true</retired>

      <expiryDate>2027-07-21T00:00:00</expiryDate>

    </user>


https://...surpass.com/api/v2/User/618?showPermissions=true

<response>
    <user>
      <reference>JamesL</reference>
      <id>618</id>
      <href>https://...surpass.com/api/v2/User/618</href>
      <firstName>James</firstName>
      <lastName>Lomax</lastName>
      <ssoExternalId i:nil="true" />
      <email>testuser@btl.com</email>
      <jobTitle></jobTitle>
      <defaultLanguage>English</defaultLanguage>
      <dateCreated>2015-10-05T08:19:00.497</dateCreated>

      <retired>true</retired>
      <expiryDate>2027-07-21T00:00:00</expiryDate>
      <userPermissions>
        <userPermission>
          <id>12624</id>
          <href>https://...surpass.com/api/v2/UserPermission/12624</href>
          <permission>
            <id>2</id>
            <assignable>true</assignable>
          </permission>
        </userPermission>
        <userPermission>
          <id>12677</id>
          <href>https://...surpass.com/api/v2/UserPermission/12677</href>
          <centre>
            <reference>JLTC</reference>
            <id>388</id>
            <href>https://...surpass.com/api/v2/Centre/388</href>
          </centre>
          <subject>
            <reference>JLTS</reference>
            <id>1427</id>
            <href>https://...surpass.com/api/v2/Subject/1427</href>
          </subject>
          <permission>
            <id>5</id>
            <assignable>true</assignable>
          </permission>
        </userPermission>
        <userPermission>
          <id>17231</id>
          <href>https://...surpass.com/api/v2/UserPermission/17231</href>
          <centre>
            <reference>JLTC</reference>
            <id>388</id>
            <href>https://...surpass.com/api/v2/Centre/388</href>
          </centre>
          <subject>
            <reference>JLTS2</reference>
            <id>1527</id>
            <href>https://...surpass.com/api/v2/Subject/1527</href>
          </subject>
          <permission>
            <id>5</id>
            <assignable>true</assignable>
          </permission>
        </userPermission>
        <userPermission>
          <id>20724</id>
          <href>https://...surpass.com/api/v2/UserPermission/20724</href>
          <centre>
            <reference>BTL001</reference>
            <id>404</id>
            <href>https://...surpass.com/api/v2/Centre/404</href>
          </centre>
          <subject>
            <reference>LQual</reference>
            <id>1993</id>
            <href>https://...surpass.com/api/v2/Subject/1993</href>
          </subject>
          <permission>
            <id>5</id>
            <assignable>true</assignable>
          </permission>
        </userPermission>
      </userPermissions>
    </user>
  </response>

Feedback and Knowledge Base