Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.easybill.de/rest/v1/customers/:customerId/contacts/:id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
city.s = CkJsonObject::ckStringOf(jResp,"city")
street.s = CkJsonObject::ckStringOf(jResp,"street")
state.s = CkJsonObject::ckStringOf(jResp,"state")
company_name.s = CkJsonObject::ckStringOf(jResp,"company_name")
country.s = CkJsonObject::ckStringOf(jResp,"country")
department.s = CkJsonObject::ckStringOf(jResp,"department")
fax.s = CkJsonObject::ckStringOf(jResp,"fax")
first_name.s = CkJsonObject::ckStringOf(jResp,"first_name")
id.s = CkJsonObject::ckStringOf(jResp,"id")
last_name.s = CkJsonObject::ckStringOf(jResp,"last_name")
login_id.s = CkJsonObject::ckStringOf(jResp,"login_id")
mobile.s = CkJsonObject::ckStringOf(jResp,"mobile")
note.s = CkJsonObject::ckStringOf(jResp,"note")
personal.i = CkJsonObject::ckBoolOf(jResp,"personal")
phone_1.s = CkJsonObject::ckStringOf(jResp,"phone_1")
phone_2.s = CkJsonObject::ckStringOf(jResp,"phone_2")
salutation.s = CkJsonObject::ckStringOf(jResp,"salutation")
suffix_1.s = CkJsonObject::ckStringOf(jResp,"suffix_1")
suffix_2.s = CkJsonObject::ckStringOf(jResp,"suffix_2")
title.s = CkJsonObject::ckStringOf(jResp,"title")
zip_code.s = CkJsonObject::ckStringOf(jResp,"zip_code")
created_at.s = CkJsonObject::ckStringOf(jResp,"created_at")
updated_at.s = CkJsonObject::ckStringOf(jResp,"updated_at")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}
