Chilkat Online Tools

autoit / New FreshBooks / Create Single Project

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

; The following JSON is sent in the request body.

; {
;   "project": {
;     "title": "Titikaka Hiking Guide",
;     "client_id": 123,
;     "project_type": "fixed_price",
;     "fixed_price": "3000",
;     "due_date": "2019-04-18",
;     "services": [
;       {
;         "id": 123,
;         "billable": true,
;         "vis_state": 0
;       },
;       {
;         "id": 123,
;         "billable": true,
;         "vis_state": 0
;       },
;       {
;         "id": 123,
;         "billable": true,
;         "vis_state": 0
;       },
;       {
;         "id": 123,
;         "billable": true,
;         "vis_state": 0
;       }
;     ]
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("project.title","Titikaka Hiking Guide")
$oJson.UpdateInt("project.client_id",123)
$oJson.UpdateString("project.project_type","fixed_price")
$oJson.UpdateString("project.fixed_price","3000")
$oJson.UpdateString("project.due_date","2019-04-18")
$oJson.UpdateInt("project.services[0].id",123)
$oJson.UpdateBool("project.services[0].billable",True)
$oJson.UpdateInt("project.services[0].vis_state",0)
$oJson.UpdateInt("project.services[1].id",123)
$oJson.UpdateBool("project.services[1].billable",True)
$oJson.UpdateInt("project.services[1].vis_state",0)
$oJson.UpdateInt("project.services[2].id",123)
$oJson.UpdateBool("project.services[2].billable",True)
$oJson.UpdateInt("project.services[2].vis_state",0)
$oJson.UpdateInt("project.services[3].id",123)
$oJson.UpdateBool("project.services[3].billable",True)
$oJson.UpdateInt("project.services[3].vis_state",0)

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"

Local $oResp = $oHttp.PostJson3("https://api.freshbooks.com/projects/business/{{businessId}}/projects","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "project": {
;     "id": 3018266,
;     "title": "Titikaka Hiking Guide",
;     "description": null,
;     "due_date": "2019-04-18",
;     "client_id": 31006,
;     "internal": false,
;     "budget": null,
;     "fixed_price": "3000.00",
;     "rate": null,
;     "billing_method": null,
;     "project_type": "fixed_price",
;     "active": true,
;     "complete": false,
;     "sample": false,
;     "created_at": "2019-05-08T20:06:55",
;     "updated_at": "2019-05-08T20:06:55",
;     "logged_duration": null,
;     "services": [
;     ],
;     "billed_amount": "0.00",
;     "billed_status": "unbilled",
;     "retainer_id": null,
;     "group": {
;       "id": 5049390,
;       "members": [
;         {
;           "id": 6578346,
;           "identity_id": 37256,
;           "role": "owner",
;           "first_name": "Marshall",
;           "last_name": "Johnston",
;           "email": "api.freshbooks@freshbooks.com",
;           "company": "Postman Sandbox",
;           "active": true
;         }
;       ],
;       "pending_invitations": null
;     }
;   }
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $id
Local $identity_id
Local $sRole
Local $sFirst_name
Local $sLast_name
Local $sEmail
Local $sCompany
Local $bActive

Local $iId = $oJResp.IntOf("project.id")
Local $sTitle = $oJResp.StringOf("project.title")
Local $sDescription = $oJResp.StringOf("project.description")
Local $sDue_date = $oJResp.StringOf("project.due_date")
Local $iClient_id = $oJResp.IntOf("project.client_id")
Local $bInternal = $oJResp.BoolOf("project.internal")
Local $sBudget = $oJResp.StringOf("project.budget")
Local $sFixed_price = $oJResp.StringOf("project.fixed_price")
Local $sRate = $oJResp.StringOf("project.rate")
Local $sBilling_method = $oJResp.StringOf("project.billing_method")
Local $sProject_type = $oJResp.StringOf("project.project_type")
Local $bActive = $oJResp.BoolOf("project.active")
Local $bComplete = $oJResp.BoolOf("project.complete")
Local $bSample = $oJResp.BoolOf("project.sample")
Local $sCreated_at = $oJResp.StringOf("project.created_at")
Local $sUpdated_at = $oJResp.StringOf("project.updated_at")
Local $sLogged_duration = $oJResp.StringOf("project.logged_duration")
Local $sBilled_amount = $oJResp.StringOf("project.billed_amount")
Local $sBilled_status = $oJResp.StringOf("project.billed_status")
Local $sRetainer_id = $oJResp.StringOf("project.retainer_id")
Local $iGroupId = $oJResp.IntOf("project.group.id")
Local $sPending_invitations = $oJResp.StringOf("project.group.pending_invitations")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("project.services")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("project.group.members")
While $i < $iCount_i
    $oJResp.I = $i
    $id = $oJResp.IntOf("project.group.members[i].id")
    $identity_id = $oJResp.IntOf("project.group.members[i].identity_id")
    $sRole = $oJResp.StringOf("project.group.members[i].role")
    $sFirst_name = $oJResp.StringOf("project.group.members[i].first_name")
    $sLast_name = $oJResp.StringOf("project.group.members[i].last_name")
    $sEmail = $oJResp.StringOf("project.group.members[i].email")
    $sCompany = $oJResp.StringOf("project.group.members[i].company")
    $bActive = $oJResp.BoolOf("project.group.members[i].active")
    $i = $i + 1
Wend

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "project": {
    "title": "Titikaka Hiking Guide",
    "client_id": {{customerId}},
    "project_type": "fixed_price",
    "fixed_price": "3000",
    "due_date": "2019-04-18",
    "services": 
    [
    	{"id": {{serviceid}}, "billable": true, "vis_state": 0}, {"id": {{serviceid}},"billable": true, "vis_state": 0}, {"id": {{serviceid}}, "billable": true, "vis_state": 0}, {"id": {{serviceid}}, "billable": true, "vis_state": 0}
    	]
  }
}'
https://api.freshbooks.com/projects/business/{{businessId}}/projects

Postman Collection Item JSON

{
  "name": "Create Single Project",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"projectId\", jsonData.project.id);",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"project\": {\n    \"title\": \"Titikaka Hiking Guide\",\n    \"client_id\": {{customerId}},\n    \"project_type\": \"fixed_price\",\n    \"fixed_price\": \"3000\",\n    \"due_date\": \"2019-04-18\",\n    \"services\": \n    [\n    \t{\"id\": {{serviceid}}, \"billable\": true, \"vis_state\": 0}, {\"id\": {{serviceid}},\"billable\": true, \"vis_state\": 0}, {\"id\": {{serviceid}}, \"billable\": true, \"vis_state\": 0}, {\"id\": {{serviceid}}, \"billable\": true, \"vis_state\": 0}\n    \t]\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "projects",
        "business",
        "{{businessId}}",
        "projects"
      ]
    }
  },
  "response": [
    {
      "name": "Create Single Project",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"project\": {\n    \"title\": \"Titikaka Hiking Guide\",\n    \"client_id\": {{customerId}},\n    \"project_type\": \"fixed_price\",\n    \"fixed_price\": \"3000\",\n    \"due_date\": \"2019-04-18\"\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "projects",
            "business",
            "{{businessId}}",
            "projects"
          ]
        }
      },
      "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.7.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTEccQQBKDkQTUAdeRkUODAZbR0NGTVIbARlUVAcEB1VTVVoBUQhWAQsFBB9UDlQdQ1dSVVBSBFFRD1dVVldVAAIVSgJQWkAHOw=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "8"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346076"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:06:55 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Content-Length",
          "value": "759"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 08 May 2019 20:06:55 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-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    \"project\": {\n        \"id\": 3018266,\n        \"title\": \"Titikaka Hiking Guide\",\n        \"description\": null,\n        \"due_date\": \"2019-04-18\",\n        \"client_id\": 31006,\n        \"internal\": false,\n        \"budget\": null,\n        \"fixed_price\": \"3000.00\",\n        \"rate\": null,\n        \"billing_method\": null,\n        \"project_type\": \"fixed_price\",\n        \"active\": true,\n        \"complete\": false,\n        \"sample\": false,\n        \"created_at\": \"2019-05-08T20:06:55\",\n        \"updated_at\": \"2019-05-08T20:06:55\",\n        \"logged_duration\": null,\n        \"services\": [],\n        \"billed_amount\": \"0.00\",\n        \"billed_status\": \"unbilled\",\n        \"retainer_id\": null,\n        \"group\": {\n            \"id\": 5049390,\n            \"members\": [\n                {\n                    \"id\": 6578346,\n                    \"identity_id\": 37256,\n                    \"role\": \"owner\",\n                    \"first_name\": \"Marshall\",\n                    \"last_name\": \"Johnston\",\n                    \"email\": \"api.freshbooks@freshbooks.com\",\n                    \"company\": \"Postman Sandbox\",\n                    \"active\": true\n                }\n            ],\n            \"pending_invitations\": null\n        }\n    }\n}"
    }
  ]
}