Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *v_type;
const wchar_t *status;
const wchar_t *displayName;
const wchar_t *serverId;
BOOL canUserCreateMoreConversations;
BOOL HasMore;
const wchar_t *AfterCursor;
const wchar_t *BeforeCursor;
const wchar_t *Prev;
const wchar_t *After;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"username");
CkHttpW_putPassword(http,L"password");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"page[after]",L"5e1606762556d93e9c176f69");
CkJsonObjectW_UpdateString(queryParams,L"page[before]",L"5e1606762556d93e9c176f69");
CkJsonObjectW_UpdateInt(queryParams,L"page[size]",10);
CkJsonObjectW_UpdateString(queryParams,L"filter[types]",L"android,ios");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://domain.com/v2/apps/{{appId}}/integrations",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "integrations": [
// {
// "id": "5e4af71a81966cfff3ef6550",
// "type": "android",
// "status": "active",
// "displayName": "Android",
// "serverId": "<sender-id>",
// "canUserCreateMoreConversations": true
// }
// ],
// "meta": {
// "hasMore": true,
// "afterCursor": "5e4af71a81966cfff3ef6550",
// "beforeCursor": "5e4af71a81966cfff3ef6550"
// },
// "links": {
// "prev": "https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[before]=5e4af71a81966cfff3ef6550",
// "after": "https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[after]=5e4af71a81966cfff3ef6550"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
HasMore = CkJsonObjectW_BoolOf(jResp,L"meta.hasMore");
AfterCursor = CkJsonObjectW_stringOf(jResp,L"meta.afterCursor");
BeforeCursor = CkJsonObjectW_stringOf(jResp,L"meta.beforeCursor");
Prev = CkJsonObjectW_stringOf(jResp,L"links.prev");
After = CkJsonObjectW_stringOf(jResp,L"links.after");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"integrations");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"integrations[i].id");
v_type = CkJsonObjectW_stringOf(jResp,L"integrations[i].type");
status = CkJsonObjectW_stringOf(jResp,L"integrations[i].status");
displayName = CkJsonObjectW_stringOf(jResp,L"integrations[i].displayName");
serverId = CkJsonObjectW_stringOf(jResp,L"integrations[i].serverId");
canUserCreateMoreConversations = CkJsonObjectW_BoolOf(jResp,L"integrations[i].canUserCreateMoreConversations");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "page[after]=5e1606762556d93e9c176f69"
-d "page[before]=5e1606762556d93e9c176f69"
-d "page[size]=10"
-d "filter[types]=android,ios"
-u 'username:password'
https://domain.com/v2/apps/{{appId}}/integrations
Postman Collection Item JSON
{
"name": "List Integrations",
"_postman_id": "910e1daa-764e-4d53-a9a8-dc911aeffeb5",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/integrations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=android,ios",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"integrations"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69",
"description": "Contains parameters for applying cursor pagination."
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69",
"description": "Contains parameters for applying cursor pagination."
},
{
"key": "page[size]",
"value": "10",
"description": "Contains parameters for applying cursor pagination."
},
{
"key": "filter[types]",
"value": "android,ios",
"description": "Contains parameters for filtering the results."
}
]
},
"description": "List available integrations. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).\n```shell\n/v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web\n```\n"
},
"response": [
{
"id": "5cc09374-9a2f-4d9e-95fd-f5bb91aa63d6",
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=android,ios",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
},
{
"key": "filter[types]",
"value": "android,ios"
}
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"integrations\": [\n {\n \"id\": \"5e4af71a81966cfff3ef6550\",\n \"type\": \"android\",\n \"status\": \"active\",\n \"displayName\": \"Android\",\n \"serverId\": \"<sender-id>\",\n \"canUserCreateMoreConversations\": true\n }\n ],\n \"meta\": {\n \"hasMore\": true,\n \"afterCursor\": \"5e4af71a81966cfff3ef6550\",\n \"beforeCursor\": \"5e4af71a81966cfff3ef6550\"\n },\n \"links\": {\n \"prev\": \"https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[before]=5e4af71a81966cfff3ef6550\",\n \"after\": \"https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[after]=5e4af71a81966cfff3ef6550\"\n }\n}"
}
]
}
