Chilkat Online Tools

DescribeUsers phpExt Example

Amazon WorkDocs

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$rest = new CkRest();

$authAws = new CkAuthAws();
$authAws->put_AccessKey('AWS_ACCESS_KEY');
$authAws->put_SecretKey('AWS_SECRET_KEY');

// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
$authAws->put_Region('us-west-2');
$authAws->put_ServiceName('workdocs');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://workdocs.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('workdocs.us-west-2.amazonaws.com',443,true,true);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\n";
    exit;
}

$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','DescribeUsers');

$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestNoBodySb('GET','/api/v1/users',$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print 'response status code = ' . $respStatusCode . "\n";
if ($respStatusCode != 200) {
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    print 'Response Body:' . "\n";
    print $sbResponseBody->getAsString() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);

// The following code parses the JSON response.
// A sample JSON response is shown below the sample code.

// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$Marker = $jResp->stringOf('Marker');
$TotalNumberOfUsers = $jResp->IntOf('TotalNumberOfUsers');
$i = 0;
$count_i = $jResp->SizeOfArray('Users');
while ($i < $count_i) {
    $jResp->put_I($i);
    $CreatedTimestamp = $jResp->IntOf('Users[i].CreatedTimestamp');
    $EmailAddress = $jResp->stringOf('Users[i].EmailAddress');
    $GivenName = $jResp->stringOf('Users[i].GivenName');
    $Id = $jResp->stringOf('Users[i].Id');
    $Locale = $jResp->stringOf('Users[i].Locale');
    $ModifiedTimestamp = $jResp->IntOf('Users[i].ModifiedTimestamp');
    $OrganizationId = $jResp->stringOf('Users[i].OrganizationId');
    $RecycleBinFolderId = $jResp->stringOf('Users[i].RecycleBinFolderId');
    $RootFolderId = $jResp->stringOf('Users[i].RootFolderId');
    $Status = $jResp->stringOf('Users[i].Status');
    $StorageAllocatedInBytes = $jResp->IntOf('Users[i].Storage.StorageRule.StorageAllocatedInBytes');
    $StorageType = $jResp->stringOf('Users[i].Storage.StorageRule.StorageType');
    $StorageUtilizedInBytes = $jResp->IntOf('Users[i].Storage.StorageUtilizedInBytes');
    $Surname = $jResp->stringOf('Users[i].Surname');
    $TimeZoneId = $jResp->stringOf('Users[i].TimeZoneId');
    $v_Type = $jResp->stringOf('Users[i].Type');
    $Username = $jResp->stringOf('Users[i].Username');
    $i = $i + 1;
}

// A sample JSON response body parsed by the above code:

// {
//   "Marker": "string",
//   "TotalNumberOfUsers": number,
//   "Users": [
//     {
//       "CreatedTimestamp": number,
//       "EmailAddress": "string",
//       "GivenName": "string",
//       "Id": "string",
//       "Locale": "string",
//       "ModifiedTimestamp": number,
//       "OrganizationId": "string",
//       "RecycleBinFolderId": "string",
//       "RootFolderId": "string",
//       "Status": "string",
//       "Storage": {
//         "StorageRule": {
//           "StorageAllocatedInBytes": number,
//           "StorageType": "string"
//         },
//         "StorageUtilizedInBytes": number
//       },
//       "Surname": "string",
//       "TimeZoneId": "string",
//       "Type": "string",
//       "Username": "string"
//     }
//   ]
// }

?>