unicodeC / Postman API / Single Mock
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Id;
const wchar_t *Owner;
const wchar_t *Uid;
const wchar_t *Collection;
const wchar_t *Environment;
const wchar_t *MockUrl;
const wchar_t *Name;
BOOL MatchBody;
BOOL MatchQueryParams;
BOOL MatchWildcards;
const wchar_t *Delay;
const wchar_t *CreatedAt;
const wchar_t *UpdatedAt;
BOOL IsPublic;
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_SetRequestHeader(http,L"X-API-Key",L"{{postman_api_key}}");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://api.getpostman.com/mocks/{{mock_uid}}",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "mock": {
// "id": "950dcaf2-ec37-4365-b106-ed659cc2ff5d",
// "owner": "1679925",
// "uid": "1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d",
// "collection": "1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf",
// "environment": "1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
// "mockUrl": "https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io",
// "name": "mock1",
// "config": {
// "headers": [
// ],
// "matchBody": false,
// "matchQueryParams": true,
// "matchWildcards": true,
// "delay": null
// },
// "createdAt": "2020-12-14T08:12:21.000Z",
// "updatedAt": "2020-12-15T06:44:37.000Z",
// "isPublic": false
// }
// }
// 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.
Id = CkJsonObjectW_stringOf(jResp,L"mock.id");
Owner = CkJsonObjectW_stringOf(jResp,L"mock.owner");
Uid = CkJsonObjectW_stringOf(jResp,L"mock.uid");
Collection = CkJsonObjectW_stringOf(jResp,L"mock.collection");
Environment = CkJsonObjectW_stringOf(jResp,L"mock.environment");
MockUrl = CkJsonObjectW_stringOf(jResp,L"mock.mockUrl");
Name = CkJsonObjectW_stringOf(jResp,L"mock.name");
MatchBody = CkJsonObjectW_BoolOf(jResp,L"mock.config.matchBody");
MatchQueryParams = CkJsonObjectW_BoolOf(jResp,L"mock.config.matchQueryParams");
MatchWildcards = CkJsonObjectW_BoolOf(jResp,L"mock.config.matchWildcards");
Delay = CkJsonObjectW_stringOf(jResp,L"mock.config.delay");
CreatedAt = CkJsonObjectW_stringOf(jResp,L"mock.createdAt");
UpdatedAt = CkJsonObjectW_stringOf(jResp,L"mock.updatedAt");
IsPublic = CkJsonObjectW_BoolOf(jResp,L"mock.isPublic");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"mock.config.headers");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/mocks/{{mock_uid}}
Postman Collection Item JSON
{
"name": "Single Mock",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks",
"{{mock_uid}}"
]
},
"description": "This endpoint fetches you the basic information about a single mock using its `uid`.\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/{{mock_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"mocks",
"{{mock_uid}}"
]
}
},
"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 \"mock\":{\n \"id\":\"950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n \"owner\":\"1679925\",\n \"uid\":\"1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n \"collection\":\"1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf\",\n \"environment\": \"1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n \"mockUrl\":\"https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.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-14T08:12:21.000Z\",\n \"updatedAt\":\"2020-12-15T06:44:37.000Z\",\n \"isPublic\":false\n }\n}"
}
]
}
