Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "retainer": {
// "active": true
// }
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateBool("retainer.active",True)
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "retainer": {
// "id": 2248,
// "business_id": 1966214,
// "system_id": 4236410,
// "invoice_profile_id": null,
// "client_user_id": 75162,
// "start_date": "2019-06-03",
// "next_period_start_date": "2019-07-03",
// "fee": "20.00",
// "excess_rate": "700.00",
// "budgeted_time": 180000,
// "active": true,
// "created_at": "2019-06-03T15:42:49",
// "updated_at": "2019-06-03T18:25:02"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim Id As Int32
Id = jResp.IntOf("retainer.id")
Dim Business_id As Int32
Business_id = jResp.IntOf("retainer.business_id")
Dim System_id As Int32
System_id = jResp.IntOf("retainer.system_id")
Dim Invoice_profile_id As String
Invoice_profile_id = jResp.StringOf("retainer.invoice_profile_id")
Dim Client_user_id As Int32
Client_user_id = jResp.IntOf("retainer.client_user_id")
Dim Start_date As String
Start_date = jResp.StringOf("retainer.start_date")
Dim Next_period_start_date As String
Next_period_start_date = jResp.StringOf("retainer.next_period_start_date")
Dim Fee As String
Fee = jResp.StringOf("retainer.fee")
Dim Excess_rate As String
Excess_rate = jResp.StringOf("retainer.excess_rate")
Dim Budgeted_time As Int32
Budgeted_time = jResp.IntOf("retainer.budgeted_time")
Dim Active As Boolean
Active = jResp.BoolOf("retainer.active")
Dim Created_at As String
Created_at = jResp.StringOf("retainer.created_at")
Dim Updated_at As String
Updated_at = jResp.StringOf("retainer.updated_at")
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"retainer": {
"active": true
}
}'
https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}
Postman Collection Item JSON
{
"name": "Undelete Retainer",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"active\": true\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainer",
"{{retainerId}}"
]
},
"description": "A retainer is deleted by changing the active status to \"false\". It can be undeleted by changing active status back to true."
},
"response": [
{
"name": "Undelete Retainer Success",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"retainer\": {\n \"active\": true\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"retainer",
"{{retainerId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1905.33.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlXVAUHAFNfUFUAUA5bDw8BBh9QCU0TUgpbBQQEBABVDwRRVwBaBRMbAAVdRVY/"
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1559586355"
},
{
"key": "Retry-After",
"value": "52"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Sun, 03 Jun 2018 18:25:02 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "349"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Mon, 03 Jun 2019 18:25:02 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17376-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"retainer\": {\n \"id\": 2248,\n \"business_id\": 1966214,\n \"system_id\": 4236410,\n \"invoice_profile_id\": null,\n \"client_user_id\": 75162,\n \"start_date\": \"2019-06-03\",\n \"next_period_start_date\": \"2019-07-03\",\n \"fee\": \"20.00\",\n \"excess_rate\": \"700.00\",\n \"budgeted_time\": 180000,\n \"active\": true,\n \"created_at\": \"2019-06-03T15:42:49\",\n \"updated_at\": \"2019-06-03T18:25:02\"\n }\n}"
}
]
}
