Chilkat Online Tools

Swift3 / Squadcast API V3 / Get User By ID

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.setRequestHeader("Authorization", value: "")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://api.squadcast.com/v3users/:userID", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

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

    // {
    //   "data": {
    //     "id": "5d81d9187000fb6b9def7e31",
    //     "first_name": "Manigandan",
    //     "last_name": "Dharmalingam",
    //     "email": "manigandan@squadcast.com",
    //     "contact": {
    //       "dial_code": "+91",
    //       "phone_number": "9578628779"
    //     },
    //     "secondary_emails": [
    //     ],
    //     "email_verified": true,
    //     "time_zone": "Asia/Calcutta",
    //     "title": "",
    //     "bio": "",
    //     "notification_rules": [
    //       {
    //         "type": "Email",
    //         "time": 0
    //       },
    //       {
    //         "type": "Push",
    //         "time": 0
    //       },
    //       {
    //         "type": "SMS",
    //         "time": 1
    //       },
    //       {
    //         "type": "Phone",
    //         "time": 2
    //       }
    //     ],
    //     "user_image": false
    //   }
    // }

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

    var v_type: String?
    var time: Int

    var Id: String? = jResp.string(of: "data.id")
    var First_name: String? = jResp.string(of: "data.first_name")
    var Last_name: String? = jResp.string(of: "data.last_name")
    var v_Email: String? = jResp.string(of: "data.email")
    var Dial_code: String? = jResp.string(of: "data.contact.dial_code")
    var Phone_number: String? = jResp.string(of: "data.contact.phone_number")
    var Email_verified: Bool = jResp.bool(of: "data.email_verified")
    var Time_zone: String? = jResp.string(of: "data.time_zone")
    var Title: String? = jResp.string(of: "data.title")
    var Bio: String? = jResp.string(of: "data.bio")
    var User_image: Bool = jResp.bool(of: "data.user_image")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data.secondary_emails").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "data.notification_rules").intValue
    while i < count_i {
        jResp.i = i
        v_type = jResp.string(of: "data.notification_rules[i].type")
        time = jResp.int(of: "data.notification_rules[i].time").intValue
        i = i + 1
    }


}

Curl Command

curl -X GET
	-H "Authorization: "
https://api.squadcast.com/v3users/:userID

Postman Collection Item JSON

{
  "name": "Get User By ID",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      }
    ],
    "url": {
      "raw": "{{baseUrl}}users/:userID",
      "host": [
        "{{baseUrl}}users"
      ],
      "path": [
        ":userID"
      ],
      "variable": [
        {
          "key": "userID",
          "value": "<string>",
          "type": "string",
          "description": "(Required) user id"
        }
      ]
    },
    "description": "Returns a users details of the given `userID` in the request param.\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/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "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/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": {\n  \"id\": \"5d81d9187000fb6b9def7e31\",\n  \"first_name\": \"Manigandan\",\n  \"last_name\": \"Dharmalingam\",\n  \"email\": \"manigandan@squadcast.com\",\n  \"contact\": {\n   \"dial_code\": \"+91\",\n   \"phone_number\": \"9578628779\"\n  },\n  \"secondary_emails\": [],\n  \"email_verified\": true,\n  \"time_zone\": \"Asia/Calcutta\",\n  \"title\": \"\",\n  \"bio\": \"\",\n  \"notification_rules\": [\n   {\n    \"type\": \"Email\",\n    \"time\": 0\n   },\n   {\n    \"type\": \"Push\",\n    \"time\": 0\n   },\n   {\n    \"type\": \"SMS\",\n    \"time\": 1\n   },\n   {\n    \"type\": \"Phone\",\n    \"time\": 2\n   }\n  ],\n  \"user_image\": false\n }\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "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}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "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}"
    }
  ]
}