Chilkat Online Tools

TCL / easybill REST API / Fetch contact

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Authorization" "{{apiKey}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "city": "<string>",
#   "street": "<string>",
#   "state": "<string>",
#   "company_name": "<string>",
#   "country": "<string>",
#   "department": null,
#   "fax": null,
#   "first_name": null,
#   "id": "<long>",
#   "last_name": null,
#   "login_id": "<long>",
#   "mobile": null,
#   "note": null,
#   "personal": false,
#   "phone_1": null,
#   "phone_2": null,
#   "salutation": "<integer>",
#   "suffix_1": null,
#   "suffix_2": null,
#   "title": null,
#   "zip_code": null,
#   "created_at": "<string>",
#   "updated_at": "<string>"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set city [CkJsonObject_stringOf $jResp "city"]
set street [CkJsonObject_stringOf $jResp "street"]
set state [CkJsonObject_stringOf $jResp "state"]
set company_name [CkJsonObject_stringOf $jResp "company_name"]
set country [CkJsonObject_stringOf $jResp "country"]
set department [CkJsonObject_stringOf $jResp "department"]
set fax [CkJsonObject_stringOf $jResp "fax"]
set first_name [CkJsonObject_stringOf $jResp "first_name"]
set id [CkJsonObject_stringOf $jResp "id"]
set last_name [CkJsonObject_stringOf $jResp "last_name"]
set login_id [CkJsonObject_stringOf $jResp "login_id"]
set mobile [CkJsonObject_stringOf $jResp "mobile"]
set note [CkJsonObject_stringOf $jResp "note"]
set personal [CkJsonObject_BoolOf $jResp "personal"]
set phone_1 [CkJsonObject_stringOf $jResp "phone_1"]
set phone_2 [CkJsonObject_stringOf $jResp "phone_2"]
set salutation [CkJsonObject_stringOf $jResp "salutation"]
set suffix_1 [CkJsonObject_stringOf $jResp "suffix_1"]
set suffix_2 [CkJsonObject_stringOf $jResp "suffix_2"]
set title [CkJsonObject_stringOf $jResp "title"]
set zip_code [CkJsonObject_stringOf $jResp "zip_code"]
set created_at [CkJsonObject_stringOf $jResp "created_at"]
set updated_at [CkJsonObject_stringOf $jResp "updated_at"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id

Postman Collection Item JSON

{
  "name": "Fetch contact",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "customers",
        ":customerId",
        "contacts",
        ":id"
      ],
      "variable": [
        {
          "key": "customerId",
          "value": "<long>",
          "description": "(Required) ID of customer"
        },
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of contact"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts",
            ":id"
          ],
          "variable": [
            {
              "key": "customerId"
            },
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"city\": \"<string>\",\n  \"street\": \"<string>\",\n  \"state\": \"<string>\",\n  \"company_name\": \"<string>\",\n  \"country\": \"<string>\",\n  \"department\": null,\n  \"fax\": null,\n  \"first_name\": null,\n  \"id\": \"<long>\",\n  \"last_name\": null,\n  \"login_id\": \"<long>\",\n  \"mobile\": null,\n  \"note\": null,\n  \"personal\": false,\n  \"phone_1\": null,\n  \"phone_2\": null,\n  \"salutation\": \"<integer>\",\n  \"suffix_1\": null,\n  \"suffix_2\": null,\n  \"title\": null,\n  \"zip_code\": null,\n  \"created_at\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts",
            ":id"
          ],
          "variable": [
            {
              "key": "customerId"
            },
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/customers/:customerId/contacts/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "customers",
            ":customerId",
            "contacts",
            ":id"
          ],
          "variable": [
            {
              "key": "customerId"
            },
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}