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.
; {
; "documentTypeCodeName": "creditupdated",
; "namePrimaryLang": "CreditEn",
; "nameSecondaryLang": "CreditAr",
; "descriptionPrimaryLang": "Des-creditEn",
; "descriptionSecondaryLang": "Des-creditAr",
; "activeFrom": "2020-06-09T07:38:54.836Z"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"documentTypeCodeName","creditupdated")
CkJsonObject::ckUpdateString(json,"namePrimaryLang","CreditEn")
CkJsonObject::ckUpdateString(json,"nameSecondaryLang","CreditAr")
CkJsonObject::ckUpdateString(json,"descriptionPrimaryLang","Des-creditEn")
CkJsonObject::ckUpdateString(json,"descriptionSecondaryLang","Des-creditAr")
CkJsonObject::ckUpdateString(json,"activeFrom","2020-06-09T07:38:54.836Z")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept-Language","ar")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"GET","https://domain.com/api/v1/documenttypes",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Accept-Language: ar"
-d '{
"documentTypeCodeName": "creditupdated",
"namePrimaryLang": "CreditEn",
"nameSecondaryLang": "CreditAr",
"descriptionPrimaryLang": "Des-creditEn",
"descriptionSecondaryLang": "Des-creditAr",
"activeFrom": "2020-06-09T07:38:54.836Z"
}'
https://domain.com/api/v1/documenttypes
Postman Collection Item JSON
{
"name": "2. Get Document Types",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{generatedAccessToken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept-Language",
"value": "ar",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"documentTypeCodeName\": \"creditupdated\",\r\n \"namePrimaryLang\": \"CreditEn\",\r\n \"nameSecondaryLang\": \"CreditAr\",\r\n \"descriptionPrimaryLang\": \"Des-creditEn\",\r\n \"descriptionSecondaryLang\": \"Des-creditAr\",\r\n \"activeFrom\": \"2020-06-09T07:38:54.836Z\"\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{apiBaseUrl}}/api/v1/documenttypes",
"host": [
"{{apiBaseUrl}}"
],
"path": [
"api",
"v1",
"documenttypes"
]
}
},
"response": [
]
}