Objective-C

GeoOp - Get all Jobs

See more GeoOp Examples

Gets all information about all jobs. Objective-C

#import <CkoJsonObject.h>
#import <CkoOAuth2.h>
#import <CkoRest.h>
#import <NSString.h>
#import <CkoDateTime.h>
#import <CkoDtObj.h>

BOOL success = NO;

// 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}
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
success = [jsonToken LoadFile: @"qa_data/tokens/geoop.json"];

// This example assumes we previously obtained an access token
CkoOAuth2 *oauth2 = [[CkoOAuth2 alloc] init];
oauth2.AccessToken = [jsonToken StringOf: @"access_token"];

CkoRest *rest = [[CkoRest alloc] init];

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

// GET /users HTTP/1.1
// Host: api.geoop.com
BOOL bAutoReconnect = YES;
success = [rest Connect: @"api.geoop.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// Provide the authentication credentials (i.e. the access token)
[rest SetAuthOAuth2: oauth2];

// Set the X-Version header.
[rest AddHeader: @"X-Version" value: @"1.0"];

NSString *responseBody = [rest FullRequestNoBody: @"GET" uriPath: @"/jobs"];
if (rest.LastMethodSuccess == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;

// If the response status code did not indicate success, then see what happened..
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",@"Request Header: ");
    NSLog(@"%@",rest.LastRequestHeader);
    NSLog(@"%@",@"----");
    NSLog(@"%@%d",@"Response StatusCode = ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@%@",@"Response StatusLine: ",rest.ResponseStatusText);
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",rest.ResponseHeader);
    [json Load: responseBody];
    NSLog(@"%@",[json Emit]);
    return;
}

[json Load: responseBody];
// Show the full JSON response.. (see below)
NSLog(@"%@",[json Emit]);

// These will be used for parsing date/time strings..
CkoDateTime *dtime = [[CkoDateTime alloc] init];
BOOL bLocalTime = YES;
CkoDtObj *dt = [[CkoDtObj alloc] init];

// Iterate over each job and get information..
int numRecords = [[json SizeOfArray: @"jobs"] intValue];
int i = 0;
while (i < numRecords) {

    json.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"job id: ",[json StringOf: @"jobs[i].id"]);
    NSLog(@"%@%@",@"client id: ",[json StringOf: @"jobs[i].client.id"]);
    NSLog(@"%@%@",@"account id: ",[json StringOf: @"jobs[i].account.id"]);
    NSLog(@"%@%@",@"address line1: ",[json StringOf: @"jobs[i].address.line1"]);

    [dtime SetFromTimestamp: [json StringOf: @"jobs[i].startTime"]];
    [dtime ToDtObj: bLocalTime dtObj: dt];

    NSLog(@"%@%d%@%d%@%d%@%d%@%d",@"created: ",[dt.Month intValue],@"/",[dt.Day intValue],@"/",[dt.Year intValue]
        ,@"  ",[dt.Hour intValue],@":",[dt.Minute intValue]);

    NSLog(@"%@",@"----");
    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
// 	  }
// 	}
//