Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkDtObjW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
HCkDtObjW Date_format;
int id;
int group_id;
const wchar_t *role;
int identity_id;
const wchar_t *first_name;
const wchar_t *last_name;
const wchar_t *email;
const wchar_t *company;
int business_id;
BOOL unacknowledged_change;
BOOL active;
int Id;
const wchar_t *Name;
const wchar_t *Account_id;
int Business_groupId;
const wchar_t *Category;
int AddressId;
const wchar_t *Street;
const wchar_t *City;
const wchar_t *Province;
const wchar_t *Country;
const wchar_t *Postal_code;
const wchar_t *Phone_number;
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();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "name": "Kevin's Corral",
// "date_format": "mm/dd/yyyy",
// "address_attributes": {
// "country": "Canada"
// },
// "phone_number_attributes": null
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"name",L"Kevin's Corral");
CkJsonObjectW_UpdateString(json,L"date_format",L"mm/dd/yyyy");
CkJsonObjectW_UpdateString(json,L"address_attributes.country",L"Canada");
CkJsonObjectW_UpdateNull(json,L"phone_number_attributes");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://api.freshbooks.com/auth/api/v1/users/business",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
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(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "id": 1986590,
// "name": "Kevin's Corral",
// "account_id": "lwy0vG",
// "business_group": {
// "id": 4977602,
// "category": "business",
// "members": [
// {
// "id": 6487912,
// "group_id": 4977602,
// "role": "owner",
// "identity_id": 37256,
// "first_name": "Marshall",
// "last_name": "Johnston",
// "email": "api.freshbooks@gmail.com",
// "company": "Kevin's Corral",
// "business_id": 1986590,
// "unacknowledged_change": false,
// "active": true
// }
// ]
// },
// "date_format": "mm/dd/yyyy",
// "address": {
// "id": 2448988,
// "street": null,
// "city": null,
// "province": null,
// "country": "Canada",
// "postal_code": null
// },
// "phone_number": null,
// "business_clients": [
// ]
// }
// }
// 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.
Date_format = CkDtObjW_Create();
Id = CkJsonObjectW_IntOf(jResp,L"response.id");
Name = CkJsonObjectW_stringOf(jResp,L"response.name");
Account_id = CkJsonObjectW_stringOf(jResp,L"response.account_id");
Business_groupId = CkJsonObjectW_IntOf(jResp,L"response.business_group.id");
Category = CkJsonObjectW_stringOf(jResp,L"response.business_group.category");
CkJsonObjectW_DtOf(jResp,L"response.date_format",FALSE,Date_format);
AddressId = CkJsonObjectW_IntOf(jResp,L"response.address.id");
Street = CkJsonObjectW_stringOf(jResp,L"response.address.street");
City = CkJsonObjectW_stringOf(jResp,L"response.address.city");
Province = CkJsonObjectW_stringOf(jResp,L"response.address.province");
Country = CkJsonObjectW_stringOf(jResp,L"response.address.country");
Postal_code = CkJsonObjectW_stringOf(jResp,L"response.address.postal_code");
Phone_number = CkJsonObjectW_stringOf(jResp,L"response.phone_number");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"response.business_group.members");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].id");
group_id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].group_id");
role = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].role");
identity_id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].identity_id");
first_name = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].first_name");
last_name = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].last_name");
email = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].email");
company = CkJsonObjectW_stringOf(jResp,L"response.business_group.members[i].company");
business_id = CkJsonObjectW_IntOf(jResp,L"response.business_group.members[i].business_id");
unacknowledged_change = CkJsonObjectW_BoolOf(jResp,L"response.business_group.members[i].unacknowledged_change");
active = CkJsonObjectW_BoolOf(jResp,L"response.business_group.members[i].active");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"response.business_clients");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
CkDtObjW_Dispose(Date_format);
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"name": "Kevin\'s Corral",
"date_format": "mm/dd/yyyy",
"address_attributes": {
"country": "Canada"
},
"phone_number_attributes": null
}'
https://api.freshbooks.com/auth/api/v1/users/business
Postman Collection Item JSON
{
"name": "Add Business",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Kevin's Corral\",\n \"date_format\": \"mm/dd/yyyy\",\n \"address_attributes\": {\n \"country\": \"Canada\"\n },\n \"phone_number_attributes\": null\n}"
},
"url": {
"raw": "https://api.freshbooks.com/auth/api/v1/users/business",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"auth",
"api",
"v1",
"users",
"business"
]
}
},
"response": [
{
"name": "Add Business",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Kevin's Corral\",\n \"date_format\": \"mm/dd/yyyy\",\n \"address_attributes\": {\n \"country\": \"Canada\"\n },\n \"phone_number_attributes\": null\n}"
},
"url": {
"raw": "https://my.freshbooks.com/service/api/auth/api/v1/users/business",
"protocol": "https",
"host": [
"my",
"freshbooks",
"com"
],
"path": [
"service",
"api",
"auth",
"api",
"v1",
"users",
"business"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Permitted-Cross-Domain-Policies",
"value": "none"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "ETag",
"value": "W/\"ece9403d440d4badd777fca953dd9580\""
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "X-Request-Id",
"value": "49e5ba95-b7dc-42c7-b0c3-8d61d99d1f39"
},
{
"key": "X-Runtime",
"value": "0.670145"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSBAUHUFQTGhEhCQ0WQg1UDl1KG39aAV0NVBZSEAEZZQAFCBdyUxAIDVl1XhUUUEJQClxZMF8XTAtWXw4IYQpMFVQyVhZLVVYNCkEUAx5UTVIZBwBXVgUEBFNVWlAIUApQDxQZAx9HDlIAVQpQBQBUV1AFXFUBXUM/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 25 Apr 2018 16:51:20 GMT"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Thu, 25 Apr 2019 16:51:20 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17366-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"id\": 1986590,\n \"name\": \"Kevin's Corral\",\n \"account_id\": \"lwy0vG\",\n \"business_group\": {\n \"id\": 4977602,\n \"category\": \"business\",\n \"members\": [\n {\n \"id\": 6487912,\n \"group_id\": 4977602,\n \"role\": \"owner\",\n \"identity_id\": 37256,\n \"first_name\": \"Marshall\",\n \"last_name\": \"Johnston\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"company\": \"Kevin's Corral\",\n \"business_id\": 1986590,\n \"unacknowledged_change\": false,\n \"active\": true\n }\n ]\n },\n \"date_format\": \"mm/dd/yyyy\",\n \"address\": {\n \"id\": 2448988,\n \"street\": null,\n \"city\": null,\n \"province\": null,\n \"country\": \"Canada\",\n \"postal_code\": null\n },\n \"phone_number\": null,\n \"business_clients\": []\n }\n}"
}
]
}
