Chilkat Online Tools

phpAx / Squadcast API V3 / Get User By ID

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$http->SetRequestHeader('Authorization','');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://api.squadcast.com/v3users/:userID',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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

$Id = $jResp->stringOf('data.id');
$First_name = $jResp->stringOf('data.first_name');
$Last_name = $jResp->stringOf('data.last_name');
$v_Email = $jResp->stringOf('data.email');
$Dial_code = $jResp->stringOf('data.contact.dial_code');
$Phone_number = $jResp->stringOf('data.contact.phone_number');
$Email_verified = $jResp->BoolOf('data.email_verified');
$Time_zone = $jResp->stringOf('data.time_zone');
$Title = $jResp->stringOf('data.title');
$Bio = $jResp->stringOf('data.bio');
$User_image = $jResp->BoolOf('data.user_image');
$i = 0;
$count_i = $jResp->SizeOfArray('data.secondary_emails');
while ($i < $count_i) {
    $jResp->I = $i;
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('data.notification_rules');
while ($i < $count_i) {
    $jResp->I = $i;
    $v_type = $jResp->stringOf('data.notification_rules[i].type');
    $time = $jResp->IntOf('data.notification_rules[i].time');
    $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}"
    }
  ]
}