Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://domain.com/crm/v2/Contacts/roles", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "contact_roles": [
// {
// "sequence_number": 1,
// "name": "Developer/Evaluator",
// "id": "738964000000007170"
// },
// {
// "sequence_number": 2,
// "name": "Decision Maker",
// "id": "738964000000007172"
// },
// {
// "sequence_number": 3,
// "name": "Purchasing",
// "id": "738964000000007174"
// },
// {
// "sequence_number": 4,
// "name": "Executive Sponsor",
// "id": "738964000000007176"
// },
// {
// "sequence_number": 5,
// "name": "Engineering Lead",
// "id": "738964000000007178"
// },
// {
// "sequence_number": 6,
// "name": "Economic Decision Maker",
// "id": "738964000000007180"
// },
// {
// "sequence_number": 7,
// "name": "Product Management",
// "id": "738964000000007182"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var sequence_number: Int
var name: String?
var id: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "contact_roles").intValue
while i < count_i {
jResp.i = i
sequence_number = jResp.int(of: "contact_roles[i].sequence_number").intValue
name = jResp.string(of: "contact_roles[i].name")
id = jResp.string(of: "contact_roles[i].id")
i = i + 1
}
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/Contacts/roles
Postman Collection Item JSON
{
"name": "Contact Roles",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/roles",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"roles"
]
}
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/roles",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 18 Jun 2021 12:57:13 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "542"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-06-18T13:56:39+00:00"
},
{
"key": "clientVersion",
"value": "4126581"
},
{
"key": "clientsubVersion",
"value": "4db5c971143ce609008746cb1d40f588"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"contact_roles\": [\n {\n \"sequence_number\": 1,\n \"name\": \"Developer/Evaluator\",\n \"id\": \"738964000000007170\"\n },\n {\n \"sequence_number\": 2,\n \"name\": \"Decision Maker\",\n \"id\": \"738964000000007172\"\n },\n {\n \"sequence_number\": 3,\n \"name\": \"Purchasing\",\n \"id\": \"738964000000007174\"\n },\n {\n \"sequence_number\": 4,\n \"name\": \"Executive Sponsor\",\n \"id\": \"738964000000007176\"\n },\n {\n \"sequence_number\": 5,\n \"name\": \"Engineering Lead\",\n \"id\": \"738964000000007178\"\n },\n {\n \"sequence_number\": 6,\n \"name\": \"Economic Decision Maker\",\n \"id\": \"738964000000007180\"\n },\n {\n \"sequence_number\": 7,\n \"name\": \"Product Management\",\n \"id\": \"738964000000007182\"\n }\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/role",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"role"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 18 Jun 2021 12:58:36 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-06-18T13:56:39+00:00"
},
{
"key": "Set-Cookie",
"value": "JSESSIONID=D18EFE682B5DD84DD3B585AA3866845A; Path=/; Secure"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/roles",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"roles"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 18 Jun 2021 12:59:08 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/roles",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"roles"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 18 Jun 2021 12:59:24 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
}
]
}
