Back to Collection Items
IncludeFile "CkJsonObject.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(queryParams,"location-code",1234568)
CkJsonObject::ckUpdateString(queryParams,"fields","[" + Chr(34) + "id" + Chr(34) + "," + Chr(34) + "name" + Chr(34) + "," + Chr(34) + "active" + Chr(34) + "," + Chr(34) + "street1" + Chr(34) + "," + Chr(34) + "street2" + Chr(34) + "," + Chr(34) + "city" + Chr(34) + "," + Chr(34) + "state" + Chr(34) + "," + Chr(34) + "postal_code" + Chr(34) + "," + Chr(34) + "location_code" + Chr(34) + ",{" + Chr(34) + "country" + Chr(34) + ":{}},{" + Chr(34) + "tax_registrations" + Chr(34) + ":{}},{" + Chr(34) + "custom_fields" + Chr(34) + ":{}}]")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/addresses",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "location-code=1234568"
-d "fields=%5B%22id%22,%22name%22,%22active%22,%22street1%22,%22street2%22,%22city%22,%22state%22,%22postal_code%22,%22location_code%22,%7B%22country%22%3A%7B%7D%7D,%7B%22tax_registrations%22%3A%7B%7D%7D,%7B%22custom_fields%22%3A%7B%7D%7D%5D"
-H "Authorization: Bearer <access_token>"
https://domain.com/addresses
Postman Collection Item JSON
{
"name": "Get Address by Location Code",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{URL}}/addresses?location-code=1234568&fields=[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]",
"host": [
"{{URL}}"
],
"path": [
"addresses"
],
"query": [
{
"key": "location-code",
"value": "1234568"
},
{
"key": "fields",
"value": "[\"id\",\"name\",\"active\",\"street1\",\"street2\",\"city\",\"state\",\"postal_code\",\"location_code\",{\"country\":{}},{\"tax_registrations\":{}},{\"custom_fields\":{}}]"
}
]
}
},
"response": [
]
}