(MFC) GeoOp - Mark a User as Deleted

Mark one or more users as deleted.

Chilkat C/C++ Library Downloads MS Visual C/C++ Libs

See Also: Using MFC CString in Chilkat

#include <CkJsonObject.h>
#include <CkOAuth2.h>
#include <CkRest.h>

void ChilkatSample(void)
    {
    CkString strOut;

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

    // This example assumes we previously obtained an access token
    CkOAuth2 oauth2;
    oauth2.put_AccessToken(jsonToken.stringOf("access_token"));

    CkRest rest;

    // 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.

    bool bAutoReconnect = true;
    success = rest.Connect("api.geoop.com",443,true,bAutoReconnect);
    if (success != true) {
        strOut.append(rest.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        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
    // 	        }
    // 	    ]
    // 	}

    CkJsonObject jsonPostBody;
    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.put_EmitCompact(false);
    strOut.append(jsonPostBody.emit());
    strOut.append("\r\n");

    rest.AddHeader("Content-Type","application/json");

    jsonPostBody.put_EmitCompact(true);
    const char *responseBody = rest.fullRequestString("PATCH","/users",jsonPostBody.emit());
    if (rest.get_LastMethodSuccess() != true) {
        strOut.append(rest.lastErrorText());
        strOut.append("\r\n");
        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;
    }

    CkJsonObject json;
    json.put_EmitCompact(false);

    // If the response status code did not indicate success, then see what happened..
    if (rest.get_ResponseStatusCode() != 200) {
        strOut.append("Request Header: ");
        strOut.append("\r\n");
        strOut.append(rest.lastRequestHeader());
        strOut.append("\r\n");
        strOut.append("----");
        strOut.append("\r\n");
        strOut.append("Response StatusCode = ");
        strOut.appendInt(rest.get_ResponseStatusCode());
        strOut.append("\r\n");
        strOut.append("Response StatusLine: ");
        strOut.append(rest.responseStatusText());
        strOut.append("\r\n");
        strOut.append("Response Header:");
        strOut.append("\r\n");
        strOut.append(rest.responseHeader());
        strOut.append("\r\n");
        json.Load(responseBody);
        strOut.append(json.emit());
        strOut.append("\r\n");

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

        SetDlgItemText(IDC_EDIT1,strOut.getUnicode());
        return;

    }

    json.Load(responseBody);
    // Show the full JSON response..
    strOut.append(json.emit());
    strOut.append("\r\n");

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


    SetDlgItemText(IDC_EDIT1,strOut.getUnicode());

    }