(PHP Extension) GeoOp - Get all Jobs

Gets all information about all jobs.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?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 assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This example also assumes an OAuth2 access token was previously fetched.
// and saved in a JSON file.  

// First get our previously obtained access token.
// {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":999236}
$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/geoop.json');

// This example assumes we previously obtained an access token
$oauth2 = new CkOAuth2();
$oauth2->put_AccessToken($jsonToken->stringOf('access_token'));

$rest = new CkRest();

// Connect to GeoOp and send the following GET request:

// GET /users HTTP/1.1
// Host: api.geoop.com
$bAutoReconnect = true;
$success = $rest->Connect('api.geoop.com',443,true,$bAutoReconnect);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// Provide the authentication credentials (i.e. the access token)
$rest->SetAuthOAuth2($oauth2);

// Set the X-Version header.
$rest->AddHeader('X-Version','1.0');

$responseBody = $rest->fullRequestNoBody('GET','/jobs');
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$json = new CkJsonObject();
$json->put_EmitCompact(false);

// If the response status code did not indicate success, then see what happened..
if ($rest->get_ResponseStatusCode() != 200) {
    print 'Request Header: ' . "\n";
    print $rest->lastRequestHeader() . "\n";
    print '----' . "\n";
    print 'Response StatusCode = ' . $rest->get_ResponseStatusCode() . "\n";
    print 'Response StatusLine: ' . $rest->responseStatusText() . "\n";
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    $json->Load($responseBody);
    print $json->emit() . "\n";
    exit;
}

$json->Load($responseBody);
// Show the full JSON response.. (see below)
print $json->emit() . "\n";

// These will be used for parsing date/time strings..
$dtime = new CkDateTime();
$bLocalTime = true;

// Iterate over each job and get information..
$numRecords = $json->SizeOfArray('jobs');
$i = 0;
while ($i < $numRecords) {

    $json->put_I($i);
    print 'job id: ' . $json->stringOf('jobs[i].id') . "\n";
    print 'client id: ' . $json->stringOf('jobs[i].client.id') . "\n";
    print 'account id: ' . $json->stringOf('jobs[i].account.id') . "\n";
    print 'address line1: ' . $json->stringOf('jobs[i].address.line1') . "\n";

    $dtime->SetFromTimestamp($json->stringOf('jobs[i].startTime'));
    // dt is a CkDtObj
    $dt = $dtime->GetDtObj($bLocalTime);
    print 'created: ' . $dt->get_Month() . '/' . $dt->get_Day() . '/' . $dt->get_Year() . '  ' . $dt->get_Hour()
         . ':' . $dt->get_Minute() . "\n";

    print '----' . "\n";
    $i = $i + 1;
}

// A sample jobs listing response:
// 
// 	{
// 	  "result": "success",
// 	  "jobs": [
// 	    {
// 	      "id": 17580761,
// 	      "reference": "1000",
// 	      "startTime": "2016-10-26T02:10:00+00:00",
// 	      "endTime": "2016-10-28T02:40:00+00:00",
// 	      "priority": 2,
// 	      "title": "[ Demo Job ]",
// 	      "description": "",
// 	      "jobNumber": null,
// 	      "deleted": false,
// 	      "type": "demo",
// 	      "created": "2015-09-03T02:11:32+00:00",
// 	      "modified": "2016-10-26T12:05:09+00:00",
// 	      "client": {
// 	        "id": 9555868
// 	      },
// 	      "billingClient": null,
// 	      "status": {
// 	        "id": 675900
// 	      },
// 	      "account": {
// 	        "id": 39409
// 	      },
// 	      "address": {
// 	        "line1": "21462 New York Avenue NW",
// 	        "line2": null,
// 	        "city": "Washington",
// 	        "postcode": "20005",
// 	        "latitude": 38.903959,
// 	        "longitude": -77.02137
// 	      },
// 	      "metadata": {
// 	        "visitsCount": 3,
// 	        "assignedVisitsCount": 3,
// 	        "unassignedVisitsCount": 0,
// 	        "partsCount": 1,
// 	        "chargesCount": 1,
// 	        "timersCount": 0,
// 	        "notesCount": 0,
// 	        "parcelsCount": 0,
// 	        "paymentsCount": 0,
// 	        "documentsCount": 1
// 	      }
// 	    },
// 	    {
// 	      "id": 17639295,
// 	      "reference": "1000",
// 	      "startTime": "2016-10-31T12:00:00+00:00",
// 	      "endTime": "2016-10-31T12:30:00+00:00",
// 	      "priority": 2,
// 	      "title": "Deliver Donuts",
// 	      "description": "Deliver donuts to the cafe.",
// 	      "jobNumber": "21122",
// 	      "deleted": false,
// 	      "type": "normal",
// 	      "created": "2016-10-31T12:07:14+00:00",
// 	      "modified": "2016-10-31T12:07:14+00:00",
// 	      "client": {
// 	        "id": 9555868
// 	      },
// 	      "billingClient": null,
// 	      "status": {
// 	        "id": 675900
// 	      },
// 	      "account": {
// 	        "id": 39409
// 	      },
// 	      "address": {
// 	        "line1": "1732 Pennsylvania Avenue NW",
// 	        "line2": null,
// 	        "city": "Washington",
// 	        "postcode": "20006",
// 	        "latitude": 38.8990534,
// 	        "longitude": -77.0401866
// 	      },
// 	      "metadata": {
// 	        "visitsCount": 1,
// 	        "assignedVisitsCount": 0,
// 	        "unassignedVisitsCount": 1,
// 	        "partsCount": 0,
// 	        "chargesCount": 0,
// 	        "timersCount": 0,
// 	        "notesCount": 0,
// 	        "parcelsCount": 0,
// 	        "paymentsCount": 0,
// 	        "documentsCount": 0
// 	      }
// 	    }
// 	  ],
// 	  "metadata": {
// 	    "page": 1,
// 	    "pagesCount": 1,
// 	    "recordsPerPage": 20,
// 	    "recordsCount": 2
// 	  }
// 	}
// 

?>