Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *id;
const char *owner;
const char *uid;
const char *collection;
const char *environment;
const char *mockUrl;
const char *name;
BOOL MatchBody;
BOOL MatchQueryParams;
BOOL MatchWildcards;
const char *Delay;
const char *createdAt;
const char *updatedAt;
BOOL isPublic;
int j;
int count_j;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_SetRequestHeader(http,"X-API-Key","{{postman_api_key}}");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.getpostman.com/mocks",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "mocks": [
// {
// "id": "e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
// "owner": "1686168",
// "uid": "1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
// "collection": "1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc",
// "environment": "1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
// "mockUrl": "https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io",
// "name": "mock1",
// "config": {
// "headers": [
// ],
// "matchBody": false,
// "matchQueryParams": true,
// "matchWildcards": true,
// "delay": null
// },
// "createdAt": "2020-12-15T06:44:37.000Z",
// "updatedAt": "2020-12-15T06:44:37.000Z",
// "isPublic": false
// },
// {
// "id": "8f9d4b95-780d-455d-af38-772277bc9393",
// "owner": "1686168",
// "uid": "1686168-8f9d4b95-780d-455d-af38-772277bc9393",
// "collection": "1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664",
// "mockUrl": "https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io",
// "name": "mock2",
// "config": {
// "headers": [
// ],
// "matchBody": false,
// "matchQueryParams": true,
// "matchWildcards": true,
// "delay": null
// },
// "createdAt": "2020-11-15T06:44:37.000Z",
// "updatedAt": "2020-12-15T06:48:37.000Z",
// "isPublic": true
// }
// ]
// }
// 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.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"mocks");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"mocks[i].id");
owner = CkJsonObject_stringOf(jResp,"mocks[i].owner");
uid = CkJsonObject_stringOf(jResp,"mocks[i].uid");
collection = CkJsonObject_stringOf(jResp,"mocks[i].collection");
environment = CkJsonObject_stringOf(jResp,"mocks[i].environment");
mockUrl = CkJsonObject_stringOf(jResp,"mocks[i].mockUrl");
name = CkJsonObject_stringOf(jResp,"mocks[i].name");
MatchBody = CkJsonObject_BoolOf(jResp,"mocks[i].config.matchBody");
MatchQueryParams = CkJsonObject_BoolOf(jResp,"mocks[i].config.matchQueryParams");
MatchWildcards = CkJsonObject_BoolOf(jResp,"mocks[i].config.matchWildcards");
Delay = CkJsonObject_stringOf(jResp,"mocks[i].config.delay");
createdAt = CkJsonObject_stringOf(jResp,"mocks[i].createdAt");
updatedAt = CkJsonObject_stringOf(jResp,"mocks[i].updatedAt");
isPublic = CkJsonObject_BoolOf(jResp,"mocks[i].isPublic");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"mocks[i].config.headers");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/mocks
Postman Collection Item JSON
{
"name": "All Mocks",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/mocks",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks"
]
},
"description": "This endpoint fetches all the mocks that you have created.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Successful Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/mocks",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"mocks\": [\n {\n \"id\": \"e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n \"owner\": \"1686168\",\n \"uid\": \"1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n \"collection\": \"1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n \"environment\": \"1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n \"mockUrl\": \"https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io\",\n \"name\": \"mock1\",\n \"config\": {\n \"headers\": [],\n \"matchBody\": false,\n \"matchQueryParams\": true,\n \"matchWildcards\": true,\n \"delay\": null\n },\n \"createdAt\": \"2020-12-15T06:44:37.000Z\",\n \"updatedAt\": \"2020-12-15T06:44:37.000Z\",\n \"isPublic\": false\n },\n {\n \"id\": \"8f9d4b95-780d-455d-af38-772277bc9393\",\n \"owner\": \"1686168\",\n \"uid\": \"1686168-8f9d4b95-780d-455d-af38-772277bc9393\",\n \"collection\": \"1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664\",\n \"mockUrl\": \"https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io\",\n \"name\": \"mock2\",\n \"config\": {\n \"headers\": [],\n \"matchBody\": false,\n \"matchQueryParams\": true,\n \"matchWildcards\": true,\n \"delay\": null\n },\n \"createdAt\": \"2020-11-15T06:44:37.000Z\",\n \"updatedAt\": \"2020-12-15T06:48:37.000Z\",\n \"isPublic\": true\n }\n ]\n}"
}
]
}
