Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Id;
const wchar_t *ExternalId;
const wchar_t *SignedUpAt;
const wchar_t *GivenName;
const wchar_t *Surname;
const wchar_t *v_Email;
const wchar_t *AvatarUrl;
const wchar_t *Lang;
// 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");
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "signedUpAt": "2020-05-21T15:53:30.197Z",
// "profile": {
// "givenName": "Jane",
// "surname": "Doe",
// "email": "jane.doe@gmail.com",
// "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
// },
// "metadata": {
// "lang": "en-ca"
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"signedUpAt",L"2020-05-21T15:53:30.197Z");
CkJsonObjectW_UpdateString(json,L"profile.givenName",L"Jane");
CkJsonObjectW_UpdateString(json,L"profile.surname",L"Doe");
CkJsonObjectW_UpdateString(json,L"profile.email",L"jane.doe@gmail.com");
CkJsonObjectW_UpdateString(json,L"profile.avatarUrl",L"https://s3.amazonaws.com/avatar.jpg");
CkJsonObjectW_UpdateString(json,L"metadata.lang",L"en-ca");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PATCH",L"https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
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(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "user": {
// "id": "7494535bff5cef41a15be74d",
// "externalId": "your-own-id",
// "signedUpAt": "2020-05-21T15:53:30.197Z",
// "profile": {
// "givenName": "Jane",
// "surname": "Doe",
// "email": "jane.doe@gmail.com",
// "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
// },
// "metadata": {
// "lang": "en-ca"
// }
// }
// }
// 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"user.id");
ExternalId = CkJsonObjectW_stringOf(jResp,L"user.externalId");
SignedUpAt = CkJsonObjectW_stringOf(jResp,L"user.signedUpAt");
GivenName = CkJsonObjectW_stringOf(jResp,L"user.profile.givenName");
Surname = CkJsonObjectW_stringOf(jResp,L"user.profile.surname");
v_Email = CkJsonObjectW_stringOf(jResp,L"user.profile.email");
AvatarUrl = CkJsonObjectW_stringOf(jResp,L"user.profile.avatarUrl");
Lang = CkJsonObjectW_stringOf(jResp,L"user.metadata.lang");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PATCH
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"signedUpAt": "2020-05-21T15:53:30.197Z",
"profile": {
"givenName": "Jane",
"surname": "Doe",
"email": "jane.doe@gmail.com",
"avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
},
"metadata": {
"lang": "en-ca"
}
}'
https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId
Postman Collection Item JSON
{
"name": "Update User",
"_postman_id": "8b3b25b1-b89b-4a6d-8aae-e72fd279cbc7",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"users",
":userIdOrExternalId"
],
"variable": [
{
"key": "userIdOrExternalId"
}
]
},
"description": "Updates a user."
},
"response": [
{
"id": "386032bc-c4a4-4590-a4be-47f5a73f20ba",
"name": "User not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"users",
":userIdOrExternalId"
],
"variable": [
{
"key": "appId"
},
{
"key": "userIdOrExternalId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "cdd035df-8db2-4fe8-95fa-337219ee4c48",
"name": "Ok",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"users",
":userIdOrExternalId"
],
"variable": [
{
"key": "appId"
},
{
"key": "userIdOrExternalId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"id\": \"7494535bff5cef41a15be74d\",\n \"externalId\": \"your-own-id\",\n \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n \"profile\": {\n \"givenName\": \"Jane\",\n \"surname\": \"Doe\",\n \"email\": \"jane.doe@gmail.com\",\n \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n }\n}"
}
]
}
