Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

C Web API Examples

Primary Categories

Facebook
GeoOp
Jira
PayPal
Peoplevox
QuickBooks

Shopify
Stripe
SugarCRM
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(C) GeoOp - Mark a User as Deleted

Mark one or more users as deleted.

Chilkat C/C++ Library Downloads

MS Visual C/C++

Linux/CentOS C/C++

Alpine Linux C/C++

MAC OS X C/C++

armhf/aarch64 C/C++

C++ Builder

iOS C/C++

Android C/C++

Win Mobile 5.0/Pocket PC 2003

Solaris C/C++

FreeBSD C/C++

OpenBSD C/C++

MinGW C/C++

#include <C_CkJsonObject.h>
#include <C_CkOAuth2.h>
#include <C_CkRest.h>

void ChilkatSample(void)
    {
    HCkJsonObject jsonToken;
    BOOL success;
    HCkOAuth2 oauth2;
    HCkRest rest;
    BOOL bAutoReconnect;
    HCkJsonObject jsonPostBody;
    const char *responseBody;
    HCkJsonObject json;

    // 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) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkOAuth2_Dispose(oauth2);
        CkRest_Dispose(rest);
        return;
    }

    // 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);
    printf("%s\n",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) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkOAuth2_Dispose(oauth2);
        CkRest_Dispose(rest);
        CkJsonObject_Dispose(jsonPostBody);
        return;
    }

    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) {
        printf("Request Header: \n");
        printf("%s\n",CkRest_lastRequestHeader(rest));
        printf("----\n");
        printf("Response StatusCode = %d\n",CkRest_getResponseStatusCode(rest));
        printf("Response StatusLine: %s\n",CkRest_responseStatusText(rest));
        printf("Response Header:\n");
        printf("%s\n",CkRest_responseHeader(rest));
        CkJsonObject_Load(json,responseBody);
        printf("%s\n",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
        // 		    ]
        // 		  }
        // 		}
        // 

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

    }

    CkJsonObject_Load(json,responseBody);
    // Show the full JSON response..
    printf("%s\n",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);

    }

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.