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 *v_type;
const char *attributesCreated_at;
const char *Description;
const char *attributesDisabled;
const char *attributesModified_at;
const char *attributesName;
const char *Public_id;
const char *Sharing;
const char *v_Url;
const char *Created_at;
const char *Disabled;
const char *v_Email;
const char *Handle;
const char *Icon;
const char *Modified_at;
const char *Name;
const char *Service_account;
const char *Status;
const char *Title;
const char *Verified;
const char *Id;
const char *DataId;
const char *v_Type;
const char *dataType;
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,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/users/:user_id",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)
// {
// "data": {
// "attributes": {
// "created_at": "<dateTime>",
// "disabled": "<boolean>",
// "email": "<string>",
// "handle": "<string>",
// "icon": "<string>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "service_account": "<boolean>",
// "status": "<string>",
// "title": "<string>",
// "verified": "<boolean>"
// },
// "id": "<string>",
// "relationships": {
// "org": {
// "data": {
// "id": "<string>",
// "type": "orgs"
// }
// },
// "other_orgs": {
// "data": [
// {
// "id": "<string>",
// "type": "orgs"
// },
// {
// "id": "<string>",
// "type": "orgs"
// }
// ]
// },
// "other_users": {
// "data": [
// {
// "id": "<string>",
// "type": "users"
// },
// {
// "id": "<string>",
// "type": "users"
// }
// ]
// },
// "roles": {
// "data": [
// {
// "id": "<string>",
// "type": "roles"
// },
// {
// "id": "<string>",
// "type": "roles"
// }
// ]
// }
// },
// "type": "users"
// },
// "included": [
// {
// "type": "orgs",
// "attributes": {
// "created_at": "<dateTime>",
// "description": "<string>",
// "disabled": "<boolean>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "public_id": "<string>",
// "sharing": "<string>",
// "url": "<string>"
// },
// "id": "<string>"
// },
// {
// "type": "orgs",
// "attributes": {
// "created_at": "<dateTime>",
// "description": "<string>",
// "disabled": "<boolean>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "public_id": "<string>",
// "sharing": "<string>",
// "url": "<string>"
// },
// "id": "<string>"
// }
// ]
// }
// 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.
Created_at = CkJsonObject_stringOf(jResp,"data.attributes.created_at");
Disabled = CkJsonObject_stringOf(jResp,"data.attributes.disabled");
v_Email = CkJsonObject_stringOf(jResp,"data.attributes.email");
Handle = CkJsonObject_stringOf(jResp,"data.attributes.handle");
Icon = CkJsonObject_stringOf(jResp,"data.attributes.icon");
Modified_at = CkJsonObject_stringOf(jResp,"data.attributes.modified_at");
Name = CkJsonObject_stringOf(jResp,"data.attributes.name");
Service_account = CkJsonObject_stringOf(jResp,"data.attributes.service_account");
Status = CkJsonObject_stringOf(jResp,"data.attributes.status");
Title = CkJsonObject_stringOf(jResp,"data.attributes.title");
Verified = CkJsonObject_stringOf(jResp,"data.attributes.verified");
Id = CkJsonObject_stringOf(jResp,"data.id");
DataId = CkJsonObject_stringOf(jResp,"data.relationships.org.data.id");
v_Type = CkJsonObject_stringOf(jResp,"data.relationships.org.data.type");
dataType = CkJsonObject_stringOf(jResp,"data.type");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data.relationships.other_orgs.data");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"data.relationships.other_orgs.data[i].id");
v_type = CkJsonObject_stringOf(jResp,"data.relationships.other_orgs.data[i].type");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data.relationships.other_users.data");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"data.relationships.other_users.data[i].id");
v_type = CkJsonObject_stringOf(jResp,"data.relationships.other_users.data[i].type");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data.relationships.roles.data");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"data.relationships.roles.data[i].id");
v_type = CkJsonObject_stringOf(jResp,"data.relationships.roles.data[i].type");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"included");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
v_type = CkJsonObject_stringOf(jResp,"included[i].type");
attributesCreated_at = CkJsonObject_stringOf(jResp,"included[i].attributes.created_at");
Description = CkJsonObject_stringOf(jResp,"included[i].attributes.description");
attributesDisabled = CkJsonObject_stringOf(jResp,"included[i].attributes.disabled");
attributesModified_at = CkJsonObject_stringOf(jResp,"included[i].attributes.modified_at");
attributesName = CkJsonObject_stringOf(jResp,"included[i].attributes.name");
Public_id = CkJsonObject_stringOf(jResp,"included[i].attributes.public_id");
Sharing = CkJsonObject_stringOf(jResp,"included[i].attributes.sharing");
v_Url = CkJsonObject_stringOf(jResp,"included[i].attributes.url");
id = CkJsonObject_stringOf(jResp,"included[i].id");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/users/:user_id
Postman Collection Item JSON
{
"name": "Get user details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id",
"value": "<string>"
}
]
},
"description": "Get a user in the organization specified by the user’s `user_id`."
},
"response": [
{
"name": "OK for get user",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n \"included\": [\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n },\n {\n \"type\": \"orgs\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"disabled\": \"<boolean>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"public_id\": \"<string>\",\n \"sharing\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id"
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
