Chilkat Online Tools

Ruby / Egyptian eInvoicing SDK R1.5 / 2. Cancel Document

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "status": "cancelled",
#   "reason": "some reason for cancelled document"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("status","cancelled")
json.UpdateString("reason","some reason for cancelled document")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/api/v1.0/documents/state/:documentUUID/state",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
	"status":"cancelled",
	"reason":"some reason for cancelled document"
}'
https://domain.com/api/v1.0/documents/state/:documentUUID/state

Postman Collection Item JSON

{
  "name": "2. Cancel Document",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{generatedAccessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"status\":\"cancelled\",\n\t\"reason\":\"some reason for cancelled document\"\n}"
    },
    "url": {
      "raw": "{{apiBaseUrl}}/api/v1.0/documents/state/:documentUUID/state",
      "host": [
        "{{apiBaseUrl}}"
      ],
      "path": [
        "api",
        "v1.0",
        "documents",
        "state",
        ":documentUUID",
        "state"
      ],
      "variable": [
        {
          "key": "documentUUID",
          "value": ""
        }
      ]
    }
  },
  "response": [
  ]
}