Chilkat Online Tools

PureBasic / Squadcast API V3 / Get User Roles

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"Authorization","")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.squadcast.com/v3/users/roles",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

    id.s
    name.s
    limit.i
    order.i

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        name = CkJsonObject::ckStringOf(jResp,"data[i].name")
        limit = CkJsonObject::ckIntOf(jResp,"data[i].limit")
        order = CkJsonObject::ckIntOf(jResp,"data[i].order")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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