Dart

GeoOp - Mark a User as Deleted

See more GeoOp Examples

Mark one or more users as deleted. 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..
  // 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.

  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');

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

  final jsonPostBody = CkJsonObject();
  jsonPostBody.updateInt('users[0].id', 115);
  jsonPostBody.updateBool('users[0].deleted', true);
  jsonPostBody.updateInt('users[1].id', 116);
  jsonPostBody.updateBool('users[1].deleted', true);
  // Continue adding more users as needed..

  // Examine the JSON we're about to send...
  jsonPostBody.emitCompact = false;
  print(jsonPostBody.emit());

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

  jsonPostBody.emitCompact = true;
  final String responseBody;
  try {
    responseBody = rest.fullRequestString('PATCH', '/users', jsonPostBody.emit());
  } 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());

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

    return;
  }

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

  // 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": [
  // 	    ]
  // 	  }
  // 	}
  // 
}