Dart

GeoOp - Get all Jobs

See more GeoOp Examples

Gets all information about all jobs. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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}
  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/geoop.json');

  // This example assumes we previously obtained an access token
  final oauth2 = CkOAuth2();
  oauth2.accessToken = jsonToken.stringOf('access_token');

  final rest = CkRest();

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

  // GET /users HTTP/1.1
  // Host: api.geoop.com
  final bAutoReconnect = true;
  try {
    rest.connect('api.geoop.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Provide the authentication credentials (i.e. the access token)
  rest.setAuthOAuth2(oauth2);

  // Set the X-Version header.
  rest.addHeader('X-Version', '1.0');

  final String responseBody;
  try {
    responseBody = rest.fullRequestNoBody('GET', '/jobs');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final json = CkJsonObject();
  json.emitCompact = false;

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

  json.load(responseBody);
  // Show the full JSON response.. (see below)
  print(json.emit());

  // These will be used for parsing date/time strings..
  final dtime = CkDateTime();
  final bLocalTime = true;
  final dt = CkDtObj();

  // Iterate over each job and get information..
  final numRecords = json.sizeOfArray('jobs');
  var i = 0;
  while (i < numRecords) {

    json.i = i;
    print('job id: ${json.stringOf('jobs[i].id')}');
    print('client id: ${json.stringOf('jobs[i].client.id')}');
    print('account id: ${json.stringOf('jobs[i].account.id')}');
    print('address line1: ${json.stringOf('jobs[i].address.line1')}');

    dtime.setFromTimestamp(json.stringOf('jobs[i].startTime'));
    dtime.toDtObj(bLocalTime, dt);

    print('created: ${dt.month}/${dt.day}/${dt.year}  ${dt.hour}:${dt.minute}');

    print('----');
    i++;
  }

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