Chilkat Online Tools

Foxpro / Squadcast API V3 / Get User Roles

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcName
LOCAL lnLimit
LOCAL lnOrder
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.SetRequestHeader("Authorization","")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.squadcast.com/v3/users/roles",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data[i].id")
    lcName = loJResp.StringOf("data[i].name")
    lnLimit = loJResp.IntOf("data[i].limit")
    lnOrder = loJResp.IntOf("data[i].order")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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}"
    }
  ]
}