Example JSON Request & Response - GET User

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

{

      "id": 17,

      "reference": "User1",

      "href": "https://...surpass.com/api/v2/User/17"

    },

    {

      "id": 18,

      "reference": "User2",

      "href": "https://...surpass.com/api/v2/User/18"

    }…


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

{

      "id": 618,

      "reference": "JamesL",

      "href": "https://...surpass.com/api/v2/User/618",

      "firstName": "James",

      "lastName": "Lomax",

      "ssoExternalId": null,

      "email": "testuser@btl.com",

      "jobTitle": "",

      "defaultLanguage": "English",

      "dateCreated": "2015-10-05T08:19:00.497",

      "retired": true,

      "expiryDate": "2027-07-21T00:00:00"

    }


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

{

      "id": 618,

      "reference": "JamesL",

      "href": "https://...surpass.com/api/v2/User/618",

      "firstName": "James",

      "lastName": "Lomax",

      "ssoExternalId": null,

      "email": "testuser@btl.com",

      "jobTitle": "",

      "defaultLanguage": "English",

      "dateCreated": "2015-10-05T08:19:00.497",

      "retired": true,      

      "expiryDate": "2027-07-21T00:00:00"

    }


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


{
      "id": 618,
      "reference": "JamesL",
      "href": "https://...surpass.com/api/v2/User/618",
      "firstName": "James",
      "lastName": "Lomax",
      "ssoExternalId": null,
      "email": "testuser@btl.com",
      "jobTitle": "",
      "defaultLanguage": "English",
      "dateCreated": "2015-10-05T08:19:00.497",

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

Feedback and Knowledge Base