Delphi DLL

GeoOp - Mark a User as Deleted

See more GeoOp Examples

Mark one or more users as deleted. 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;
jsonPostBody: 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');

// We'll send a POST that looks like this:
// 
// 	PATCH /users HTTP/1.1
// 	Host: api.geoop.com
// 	Authorization: Bearer oJ_7Hj.f-F3f.kL
// 	Content-Type: application/json
// 	X-Version: 1.0
// 
// 	{
// 	    "users": [
// 	        {
// 	            "id": 115,
// 	            "deleted": true
// 	        },
// 	        {
// 	            "id": 116,
// 	            "deleted": true
// 	        }
// 	    ]
// 	}

jsonPostBody := CkJsonObject_Create();
CkJsonObject_UpdateInt(jsonPostBody,'users[0].id',115);
CkJsonObject_UpdateBool(jsonPostBody,'users[0].deleted',True);
CkJsonObject_UpdateInt(jsonPostBody,'users[1].id',116);
CkJsonObject_UpdateBool(jsonPostBody,'users[1].deleted',True);
// Continue adding more users as needed..

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

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

CkJsonObject_putEmitCompact(jsonPostBody,True);
responseBody := CkRest__fullRequestString(rest,'PATCH','/users',CkJsonObject__emit(jsonPostBody));
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));

    // If a user ID does not exist, we'll get an error response body that looks like this:

    // 		{
    // 		  "result": "failure",
    // 		  "failures": [
    // 		    {
    // 		      "rawData": {
    // 		        "id": 115,
    // 		        "deleted": true
    // 		      },
    // 		      "errors": [
    // 		        {
    // 		          "type": "client",
    // 		          "code": 1012,
    // 		          "message": "Item does not exist, or you do not have permission to access the item.",
    // 		          "description": "Make certain that you specified the correct item ID, and that you have permission to access the item."
    // 		        }
    // 		      ]
    // 		    }
    // 		  ],
    // 		  "metadata": {
    // 		    "receivedItemsCount": 1,
    // 		    "validItems": [
    // 		    ],
    // 		    "invalidItems": [
    // 		      0
    // 		    ]
    // 		  }
    // 		}
    // 

    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",
// 	  "users": [
// 	    {
// 	      "id": 984242,
// 	      "firstName": "John",
// 	      "lastName": "Doe",
// 	      "companyName": "Chilkat Software, inc.",
// 	      "email": "sales@chilkatsoft.com",
// 	      "phone": "",
// 	      "mobile": "2223334444",
// 	      "hourlyRate": 0,
// 	      "active": 1,
// 	      "deleted": true,
// 	      "colour": "#8162E7",
// 	      "created": "2016-10-26T17:52:30+00:00",
// 	      "modified": "2016-10-31T11:47:18+00:00",
// 	      "isAssignable": true,
// 	      "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984242.jpg",
// 	      "role": {
// 	        "id": 3
// 	      },
// 	      "account": {
// 	        "id": 39409
// 	      },
// 	      "status": {
// 	        "message": "",
// 	        "timestamp": "2016-10-26T17:52:30+00:00"
// 	      }
// 	    }
// 	  ],
// 	  "metadata": {
// 	    "receivedItemsCount": 1,
// 	    "validItems": [
// 	      0
// 	    ],
// 	    "invalidItems": [
// 	    ]
// 	  }
// 	}
// 

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

end;