Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Variant vDate_format
Handle hoDate_format
Integer iId
Integer iGroup_id
String sRole
Integer iIdentity_id
String sFirst_name
String sLast_name
String sEmail
String sCompany
Integer iBusiness_id
Boolean iUnacknowledged_change
Boolean iActive
Integer iId
String sName
String sAccount_id
Integer iBusiness_groupId
String sCategory
Integer iAddressId
String sStreet
String sCity
String sProvince
String sCountry
String sPostal_code
String sPhone_number
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "name" "Kevin's Corral" To iSuccess
Get ComUpdateString Of hoJson "date_format" "mm/dd/yyyy" To iSuccess
Get ComUpdateString Of hoJson "address_attributes.country" "Canada" To iSuccess
Get ComUpdateNull Of hoJson "phone_number_attributes" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://api.freshbooks.com/auth/api/v1/users/business" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get Create (RefClass(cComChilkatDtObj)) To hoDate_format
If (Not(IsComObjectCreated(hoDate_format))) Begin
Send CreateComObject of hoDate_format
End
Get ComIntOf Of hoJResp "response.id" To iId
Get ComStringOf Of hoJResp "response.name" To sName
Get ComStringOf Of hoJResp "response.account_id" To sAccount_id
Get ComIntOf Of hoJResp "response.business_group.id" To iBusiness_groupId
Get ComStringOf Of hoJResp "response.business_group.category" To sCategory
Get pvComObject of hoDate_format to vDate_format
Get ComDtOf Of hoJResp "response.date_format" False vDate_format To iSuccess
Get ComIntOf Of hoJResp "response.address.id" To iAddressId
Get ComStringOf Of hoJResp "response.address.street" To sStreet
Get ComStringOf Of hoJResp "response.address.city" To sCity
Get ComStringOf Of hoJResp "response.address.province" To sProvince
Get ComStringOf Of hoJResp "response.address.country" To sCountry
Get ComStringOf Of hoJResp "response.address.postal_code" To sPostal_code
Get ComStringOf Of hoJResp "response.phone_number" To sPhone_number
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.business_group.members" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComIntOf Of hoJResp "response.business_group.members[i].id" To iId
Get ComIntOf Of hoJResp "response.business_group.members[i].group_id" To iGroup_id
Get ComStringOf Of hoJResp "response.business_group.members[i].role" To sRole
Get ComIntOf Of hoJResp "response.business_group.members[i].identity_id" To iIdentity_id
Get ComStringOf Of hoJResp "response.business_group.members[i].first_name" To sFirst_name
Get ComStringOf Of hoJResp "response.business_group.members[i].last_name" To sLast_name
Get ComStringOf Of hoJResp "response.business_group.members[i].email" To sEmail
Get ComStringOf Of hoJResp "response.business_group.members[i].company" To sCompany
Get ComIntOf Of hoJResp "response.business_group.members[i].business_id" To iBusiness_id
Get ComBoolOf Of hoJResp "response.business_group.members[i].unacknowledged_change" To iUnacknowledged_change
Get ComBoolOf Of hoJResp "response.business_group.members[i].active" To iActive
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "response.business_clients" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
