Delphi DLL

GeoOp - Create Job

See more GeoOp Examples

Create a new job. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, OAuth2, Rest, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
jsonToken: HCkJsonObject;
oauth2: HCkOAuth2;
rest: HCkRest;
bAutoReconnect: Boolean;
jsonJob: HCkJsonObject;
responseBody: PWideChar;
json: HCkJsonObject;

begin
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}
jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/geoop.json');

// This example assumes we previously obtained an access token
oauth2 := CkOAuth2_Create();
CkOAuth2_putAccessToken(oauth2,CkJsonObject__stringOf(jsonToken,'access_token'));

rest := CkRest_Create();

// Connect to GeoOp..
// Note: The same REST object, once connected, can be used for many requests.
// The bAutoReconnect argument allows it to automatically reconnect as required for any subsequent request.

bAutoReconnect := True;
success := CkRest_Connect(rest,'api.geoop.com',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

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

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

// To create a new user, we must build and send the following JSON:

// 	{
// 	  "jobs": [
// 	    {
// 	      "priority": 2,
// 	      "title": "Deliver More Donuts",
// 	      "description": "Deliver more donuts to the cafe.",
// 	      "client": {
// 	        "id": 9571218
// 	      },
// 	      "account": {
// 	        "id": 39409
// 	      },
// 	      "status": {
// 	        "id": 675900
// 	      },
// 	      "address": {
// 	        "line1": "1732 Pennsylvania Avenue NW",
// 	        "city": "Washington",
// 	        "postcode": "20006",
// 	      }
// 	    }
// 	  ]
// 	}
// 

jsonJob := CkJsonObject_Create();
CkJsonObject_UpdateInt(jsonJob,'jobs[0].priority',2);
CkJsonObject_UpdateString(jsonJob,'jobs[0].title','Deliver More Donuts');
CkJsonObject_UpdateString(jsonJob,'jobs[0].description','Deliver more donuts to the cafe.');
CkJsonObject_UpdateInt(jsonJob,'jobs[0].client.id',9571218);
CkJsonObject_UpdateInt(jsonJob,'jobs[0].account.id',39409);
CkJsonObject_UpdateInt(jsonJob,'jobs[0].status.id',675900);
CkJsonObject_UpdateString(jsonJob,'jobs[0].address.line1','1732 Pennsylvania Avenue NW');
CkJsonObject_UpdateString(jsonJob,'jobs[0].address.city','Washington');
CkJsonObject_UpdateString(jsonJob,'jobs[0].address.postcode','20006');

// Examine the JSON we're about to send...
CkJsonObject_putEmitCompact(jsonJob,False);
Memo1.Lines.Add(CkJsonObject__emit(jsonJob));

CkRest_AddHeader(rest,'Content-Type','application/json');

CkJsonObject_putEmitCompact(jsonJob,True);
responseBody := CkRest__fullRequestString(rest,'POST','/jobs',CkJsonObject__emit(jsonJob));
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);

// If the response status code did not indicate success, then see what happened..
if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add('Request Header: ');
    Memo1.Lines.Add(CkRest__lastRequestHeader(rest));
    Memo1.Lines.Add('----');
    Memo1.Lines.Add('Response StatusCode = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('Response StatusLine: ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    CkJsonObject_Load(json,responseBody);
    Memo1.Lines.Add(CkJsonObject__emit(json));
    Exit;
  end;

CkJsonObject_Load(json,responseBody);
// Show the full JSON response..
Memo1.Lines.Add(CkJsonObject__emit(json));

// The success JSON looks like this:

// 	{
// 	  "result": "success",
// 	  "jobs": [
// 	    {
// 	      "id": 17639811,
// 	      "reference": "1001",
// 	      "startTime": null,
// 	      "endTime": null,
// 	      "priority": 2,
// 	      "title": "Deliver More Donuts",
// 	      "description": "Deliver more donuts to the cafe.",
// 	      "jobNumber": null,
// 	      "deleted": false,
// 	      "type": "normal",
// 	      "created": "2016-10-31T13:36:47+00:00",
// 	      "modified": "2016-10-31T13:36:47+00:00",
// 	      "client": {
// 	        "id": 9571218
// 	      },
// 	      "billingClient": null,
// 	      "status": {
// 	        "id": 675900
// 	      },
// 	      "account": {
// 	        "id": 39409
// 	      },
// 	      "address": {
// 	        "line1": "1732 Pennsylvania Avenue NW",
// 	        "line2": "",
// 	        "city": "Washington",
// 	        "postcode": "20006",
// 	        "latitude": 38.8990534,
// 	        "longitude": -77.0401866
// 	      },
// 	      "metadata": {
// 	        "visitsCount": 0,
// 	        "assignedVisitsCount": 0,
// 	        "unassignedVisitsCount": 0,
// 	        "partsCount": 0,
// 	        "chargesCount": 0,
// 	        "timersCount": 0,
// 	        "notesCount": 0,
// 	        "parcelsCount": 0,
// 	        "paymentsCount": 0,
// 	        "documentsCount": 0
// 	      }
// 	    }
// 	  ],
// 	  "metadata": {
// 	    "receivedItemsCount": 1,
// 	    "validItems": [
// 	      0
// 	    ],
// 	    "invalidItems": [
// 	    ]
// 	  }
// 	}
// 

CkJsonObject_Dispose(jsonToken);
CkOAuth2_Dispose(oauth2);
CkRest_Dispose(rest);
CkJsonObject_Dispose(jsonJob);
CkJsonObject_Dispose(json);

end;