Chilkat Online Tools

Xojo / Squadcast API V3 / Get User Roles

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.SetRequestHeader "Authorization",""

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.squadcast.com/v3/users/roles",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": [
//     {
//       "id": "5a425b383c36823b3ed91fa1",
//       "name": "Account Owner",
//       "limit": 1,
//       "order": 3
//     },
//     {
//       "id": "5a425b383c36823b3ed91fa2",
//       "name": "Admin",
//       "limit": -1,
//       "order": 2
//     },
//     {
//       "id": "5a425b383c36823b3ed91fa3",
//       "name": "User",
//       "limit": -1,
//       "order": 1
//     },
//     {
//       "id": "5a425b383c36823b3ed91fa4",
//       "name": "Stakeholder",
//       "limit": -1,
//       "order": 0
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Dim id As String
Dim name As String
Dim limit As Int32
Dim order As Int32

Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("data")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("data[i].id")
    name = jResp.StringOf("data[i].name")
    limit = jResp.IntOf("data[i].limit")
    order = jResp.IntOf("data[i].order")
    i = i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: "
https://api.squadcast.com/v3/users/roles

Postman Collection Item JSON

{
  "name": "Get User Roles",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/users/roles",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "users",
        "roles"
      ]
    },
    "description": "Returns all available user roles.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope."
  },
  "response": [
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            "roles"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            "roles"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": [\n  {\n   \"id\": \"5a425b383c36823b3ed91fa1\",\n   \"name\": \"Account Owner\",\n   \"limit\": 1,\n   \"order\": 3\n  },\n  {\n   \"id\": \"5a425b383c36823b3ed91fa2\",\n   \"name\": \"Admin\",\n   \"limit\": -1,\n   \"order\": 2\n  },\n  {\n   \"id\": \"5a425b383c36823b3ed91fa3\",\n   \"name\": \"User\",\n   \"limit\": -1,\n   \"order\": 1\n  },\n  {\n   \"id\": \"5a425b383c36823b3ed91fa4\",\n   \"name\": \"Stakeholder\",\n   \"limit\": -1,\n   \"order\": 0\n  }\n ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            "roles"
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            "roles"
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    }
  ]
}