Chilkat Online Tools

Foxpro / New FreshBooks / Create Single Project

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnId
LOCAL lnIdentity_id
LOCAL lcRole
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcEmail
LOCAL lcCompany
LOCAL lnActive
LOCAL lnId
LOCAL lcTitle
LOCAL lcDescription
LOCAL lcDue_date
LOCAL lnClient_id
LOCAL lnInternal
LOCAL lcBudget
LOCAL lcFixed_price
LOCAL lcRate
LOCAL lcBilling_method
LOCAL lcProject_type
LOCAL lnActive
LOCAL lnComplete
LOCAL lnSample
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcLogged_duration
LOCAL lcBilled_amount
LOCAL lcBilled_status
LOCAL lcRetainer_id
LOCAL lnGroupId
LOCAL lcPending_invitations
LOCAL i
LOCAL lnCount_i

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

* 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
*       }
*     ]
*   }
* }

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("project.title","Titikaka Hiking Guide")
loJson.UpdateInt("project.client_id",123)
loJson.UpdateString("project.project_type","fixed_price")
loJson.UpdateString("project.fixed_price","3000")
loJson.UpdateString("project.due_date","2019-04-18")
loJson.UpdateInt("project.services[0].id",123)
loJson.UpdateBool("project.services[0].billable",1)
loJson.UpdateInt("project.services[0].vis_state",0)
loJson.UpdateInt("project.services[1].id",123)
loJson.UpdateBool("project.services[1].billable",1)
loJson.UpdateInt("project.services[1].vis_state",0)
loJson.UpdateInt("project.services[2].id",123)
loJson.UpdateBool("project.services[2].billable",1)
loJson.UpdateInt("project.services[2].vis_state",0)
loJson.UpdateInt("project.services[3].id",123)
loJson.UpdateBool("project.services[3].billable",1)
loJson.UpdateInt("project.services[3].vis_state",0)

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://api.freshbooks.com/projects/business/{{businessId}}/projects","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lnId = loJResp.IntOf("project.id")
lcTitle = loJResp.StringOf("project.title")
lcDescription = loJResp.StringOf("project.description")
lcDue_date = loJResp.StringOf("project.due_date")
lnClient_id = loJResp.IntOf("project.client_id")
lnInternal = loJResp.BoolOf("project.internal")
lcBudget = loJResp.StringOf("project.budget")
lcFixed_price = loJResp.StringOf("project.fixed_price")
lcRate = loJResp.StringOf("project.rate")
lcBilling_method = loJResp.StringOf("project.billing_method")
lcProject_type = loJResp.StringOf("project.project_type")
lnActive = loJResp.BoolOf("project.active")
lnComplete = loJResp.BoolOf("project.complete")
lnSample = loJResp.BoolOf("project.sample")
lcCreated_at = loJResp.StringOf("project.created_at")
lcUpdated_at = loJResp.StringOf("project.updated_at")
lcLogged_duration = loJResp.StringOf("project.logged_duration")
lcBilled_amount = loJResp.StringOf("project.billed_amount")
lcBilled_status = loJResp.StringOf("project.billed_status")
lcRetainer_id = loJResp.StringOf("project.retainer_id")
lnGroupId = loJResp.IntOf("project.group.id")
lcPending_invitations = loJResp.StringOf("project.group.pending_invitations")
i = 0
lnCount_i = loJResp.SizeOfArray("project.services")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("project.group.members")
DO WHILE i < lnCount_i
    loJResp.I = i
    lnId = loJResp.IntOf("project.group.members[i].id")
    lnIdentity_id = loJResp.IntOf("project.group.members[i].identity_id")
    lcRole = loJResp.StringOf("project.group.members[i].role")
    lcFirst_name = loJResp.StringOf("project.group.members[i].first_name")
    lcLast_name = loJResp.StringOf("project.group.members[i].last_name")
    lcEmail = loJResp.StringOf("project.group.members[i].email")
    lcCompany = loJResp.StringOf("project.group.members[i].company")
    lnActive = loJResp.BoolOf("project.group.members[i].active")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

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}"
    }
  ]
}