Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "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>"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"city","<string>")
CkJsonObject::ckUpdateString(json,"street","<string>")
CkJsonObject::ckUpdateString(json,"state","<string>")
CkJsonObject::ckUpdateString(json,"company_name","<string>")
CkJsonObject::ckUpdateString(json,"country","<string>")
CkJsonObject::ckUpdateNull(json,"department")
CkJsonObject::ckUpdateNull(json,"fax")
CkJsonObject::ckUpdateNull(json,"first_name")
CkJsonObject::ckUpdateString(json,"id","<long>")
CkJsonObject::ckUpdateNull(json,"last_name")
CkJsonObject::ckUpdateString(json,"login_id","<long>")
CkJsonObject::ckUpdateNull(json,"mobile")
CkJsonObject::ckUpdateNull(json,"note")
CkJsonObject::ckUpdateBool(json,"personal",0)
CkJsonObject::ckUpdateNull(json,"phone_1")
CkJsonObject::ckUpdateNull(json,"phone_2")
CkJsonObject::ckUpdateString(json,"salutation","<integer>")
CkJsonObject::ckUpdateNull(json,"suffix_1")
CkJsonObject::ckUpdateNull(json,"suffix_2")
CkJsonObject::ckUpdateNull(json,"title")
CkJsonObject::ckUpdateNull(json,"zip_code")
CkJsonObject::ckUpdateString(json,"created_at","<string>")
CkJsonObject::ckUpdateString(json,"updated_at","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Authorization","{{apiKey}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.easybill.de/rest/v1/customers/:customerId/contacts","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"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>"
}'
https://api.easybill.de/rest/v1/customers/:customerId/contacts
Postman Collection Item JSON
{
"name": "Create new contact",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/customers/:customerId/contacts",
"host": [
"{{baseUrl}}"
],
"path": [
"customers",
":customerId",
"contacts"
],
"variable": [
{
"key": "customerId",
"value": "<long>",
"description": "(Required) ID of customer"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/customers/:customerId/contacts",
"host": [
"{{baseUrl}}"
],
"path": [
"customers",
":customerId",
"contacts"
],
"variable": [
{
"key": "customerId"
}
]
}
},
"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": "Invalid contact",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/customers/:customerId/contacts",
"host": [
"{{baseUrl}}"
],
"path": [
"customers",
":customerId",
"contacts"
],
"variable": [
{
"key": "customerId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/customers/:customerId/contacts",
"host": [
"{{baseUrl}}"
],
"path": [
"customers",
":customerId",
"contacts"
],
"variable": [
{
"key": "customerId"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
