C#

GeoOp - Get all Jobs

See more GeoOp Examples

Gets all information about all jobs. C#

bool success = false;

//  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}
Chilkat.JsonObject jsonToken = new Chilkat.JsonObject();
success = jsonToken.LoadFile("qa_data/tokens/geoop.json");

//  This example assumes we previously obtained an access token
Chilkat.OAuth2 oauth2 = new Chilkat.OAuth2();
oauth2.AccessToken = jsonToken.StringOf("access_token");

Chilkat.Rest rest = new Chilkat.Rest();

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

//  GET /users HTTP/1.1
//  Host: api.geoop.com
bool bAutoReconnect = true;
success = rest.Connect("api.geoop.com",443,true,bAutoReconnect);
if (success == false) {
    Debug.WriteLine(rest.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");

string responseBody = rest.FullRequestNoBody("GET","/jobs");
if (rest.LastMethodSuccess == false) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.EmitCompact = false;

//  If the response status code did not indicate success, then see what happened..
if (rest.ResponseStatusCode != 200) {
    Debug.WriteLine("Request Header: ");
    Debug.WriteLine(rest.LastRequestHeader);
    Debug.WriteLine("----");
    Debug.WriteLine("Response StatusCode = " + Convert.ToString(rest.ResponseStatusCode));
    Debug.WriteLine("Response StatusLine: " + rest.ResponseStatusText);
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(rest.ResponseHeader);
    json.Load(responseBody);
    Debug.WriteLine(json.Emit());
    return;
}

json.Load(responseBody);
//  Show the full JSON response.. (see below)
Debug.WriteLine(json.Emit());

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

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

    json.I = i;
    Debug.WriteLine("job id: " + json.StringOf("jobs[i].id"));
    Debug.WriteLine("client id: " + json.StringOf("jobs[i].client.id"));
    Debug.WriteLine("account id: " + json.StringOf("jobs[i].account.id"));
    Debug.WriteLine("address line1: " + json.StringOf("jobs[i].address.line1"));

    dtime.SetFromTimestamp(json.StringOf("jobs[i].startTime"));
    dtime.ToDtObj(bLocalTime,dt);

    Debug.WriteLine("created: " + Convert.ToString(dt.Month) + "/" + Convert.ToString(dt.Day) + "/" + Convert.ToString(dt.Year) + "  " + Convert.ToString(dt.Hour)
         + ":" + Convert.ToString(dt.Minute));

    Debug.WriteLine("----");
    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
//  	  }
//  	}
//