Swift

GeoOp - Mark a User as Deleted

See more GeoOp Examples

Mark one or more users as deleted. Swift

func chilkatTest() {
    var success: Bool = 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}
    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/geoop.json")

    // This example assumes we previously obtained an access token
    let oauth2 = CkoOAuth2()!
    oauth2.accessToken = jsonToken.string(of: "access_token")

    let rest = CkoRest()!

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

    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "api.geoop.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // Provide the authentication credentials (i.e. the access token)
    rest.setAuthOAuth2(authProvider: oauth2)

    // Set the X-Version header.
    rest.addHeader(name: "X-Version", value: "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
    // 	        }
    // 	    ]
    // 	}

    let jsonPostBody = CkoJsonObject()!
    jsonPostBody.updateInt(jsonPath: "users[0].id", value: 115)
    jsonPostBody.updateBool(jsonPath: "users[0].deleted", value: true)
    jsonPostBody.updateInt(jsonPath: "users[1].id", value: 116)
    jsonPostBody.updateBool(jsonPath: "users[1].deleted", value: true)
    // Continue adding more users as needed..

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

    rest.addHeader(name: "Content-Type", value: "application/json")

    jsonPostBody.emitCompact = true
    var responseBody: String? = rest.fullRequestString(httpVerb: "PATCH", uriPath: "/users", bodyText: jsonPostBody.emit())
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    let json = CkoJsonObject()!
    json.emitCompact = false

    // If the response status code did not indicate success, then see what happened..
    if rest.responseStatusCode.intValue != 200 {
        print("Request Header: ")
        print("\(rest.lastRequestHeader!)")
        print("----")
        print("Response StatusCode = \(rest.responseStatusCode.intValue)")
        print("Response StatusLine: \(rest.responseStatusText!)")
        print("Response Header:")
        print("\(rest.responseHeader!)")
        json.load(json: 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(json: 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": [
    // 	    ]
    // 	  }
    // 	}
    // 

}