Chilkat Online Tools

Foxpro / easybill REST API / Update time tracking

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL loDate_from_at
LOCAL loDate_thru_at
LOCAL lcDescription
LOCAL lcCleared_at
LOCAL lcCreated_at
LOCAL lnHourly_rate
LOCAL lcId
LOCAL lcNote
LOCAL lcV_number
LOCAL lcPosition_id
LOCAL lcProject_id
LOCAL lcLogin_id
LOCAL lcTimer_value

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.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.

* {
*   "description": "<string>",
*   "cleared_at": null,
*   "created_at": "<dateTime>",
*   "date_from_at": null,
*   "date_thru_at": null,
*   "hourly_rate": 0,
*   "id": "<long>",
*   "note": null,
*   "number": "<string>",
*   "position_id": null,
*   "project_id": null,
*   "login_id": "<long>",
*   "timer_value": null
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("description","<string>")
loJson.UpdateNull("cleared_at")
loJson.UpdateString("created_at","<dateTime>")
loJson.UpdateNull("date_from_at")
loJson.UpdateNull("date_thru_at")
loJson.UpdateInt("hourly_rate",0)
loJson.UpdateString("id","<long>")
loJson.UpdateNull("note")
loJson.UpdateString("number","<string>")
loJson.UpdateNull("position_id")
loJson.UpdateNull("project_id")
loJson.UpdateString("login_id","<long>")
loJson.UpdateNull("timer_value")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://api.easybill.de/rest/v1/time-trackings/:id",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.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 loSbRequestBody
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "description": "<string>",
*   "cleared_at": null,
*   "created_at": "<dateTime>",
*   "date_from_at": null,
*   "date_thru_at": null,
*   "hourly_rate": 0,
*   "id": "<long>",
*   "note": null,
*   "number": "<string>",
*   "position_id": null,
*   "project_id": null,
*   "login_id": "<long>",
*   "timer_value": null
* }

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_from_at = CreateObject('Chilkat.DtObj')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_thru_at = CreateObject('Chilkat.DtObj')

lcDescription = loJResp.StringOf("description")
lcCleared_at = loJResp.StringOf("cleared_at")
lcCreated_at = loJResp.StringOf("created_at")
loJResp.DtOf("date_from_at",0,loDate_from_at)
loJResp.DtOf("date_thru_at",0,loDate_thru_at)
lnHourly_rate = loJResp.IntOf("hourly_rate")
lcId = loJResp.StringOf("id")
lcNote = loJResp.StringOf("note")
lcV_number = loJResp.StringOf("number")
lcPosition_id = loJResp.StringOf("position_id")
lcProject_id = loJResp.StringOf("project_id")
lcLogin_id = loJResp.StringOf("login_id")
lcTimer_value = loJResp.StringOf("timer_value")

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
RELEASE loDate_from_at
RELEASE loDate_thru_at

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "description": "<string>",
  "cleared_at": null,
  "created_at": "<dateTime>",
  "date_from_at": null,
  "date_thru_at": null,
  "hourly_rate": 0,
  "id": "<long>",
  "note": null,
  "number": "<string>",
  "position_id": null,
  "project_id": null,
  "login_id": "<long>",
  "timer_value": null
}'
https://api.easybill.de/rest/v1/time-trackings/:id

Postman Collection Item JSON

{
  "name": "Update time tracking",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"description\": \"<string>\",\n  \"cleared_at\": null,\n  \"created_at\": \"<dateTime>\",\n  \"date_from_at\": null,\n  \"date_thru_at\": null,\n  \"hourly_rate\": 0,\n  \"id\": \"<long>\",\n  \"note\": null,\n  \"number\": \"<string>\",\n  \"position_id\": null,\n  \"project_id\": null,\n  \"login_id\": \"<long>\",\n  \"timer_value\": null\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/time-trackings/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "time-trackings",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of time tracking"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"<string>\",\n  \"cleared_at\": null,\n  \"created_at\": \"<dateTime>\",\n  \"date_from_at\": null,\n  \"date_thru_at\": null,\n  \"hourly_rate\": 0,\n  \"id\": \"<long>\",\n  \"note\": null,\n  \"number\": \"<string>\",\n  \"position_id\": null,\n  \"project_id\": null,\n  \"login_id\": \"<long>\",\n  \"timer_value\": null\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/time-trackings/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"description\": \"<string>\",\n  \"cleared_at\": null,\n  \"created_at\": \"<dateTime>\",\n  \"date_from_at\": null,\n  \"date_thru_at\": null,\n  \"hourly_rate\": 0,\n  \"id\": \"<long>\",\n  \"note\": null,\n  \"number\": \"<string>\",\n  \"position_id\": null,\n  \"project_id\": null,\n  \"login_id\": \"<long>\",\n  \"timer_value\": null\n}"
    },
    {
      "name": "Invalid time tracking",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"<string>\",\n  \"cleared_at\": null,\n  \"created_at\": \"<dateTime>\",\n  \"date_from_at\": null,\n  \"date_thru_at\": null,\n  \"hourly_rate\": 0,\n  \"id\": \"<long>\",\n  \"note\": null,\n  \"number\": \"<string>\",\n  \"position_id\": null,\n  \"project_id\": null,\n  \"login_id\": \"<long>\",\n  \"timer_value\": null\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/time-trackings/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"description\": \"<string>\",\n  \"cleared_at\": null,\n  \"created_at\": \"<dateTime>\",\n  \"date_from_at\": null,\n  \"date_thru_at\": null,\n  \"hourly_rate\": 0,\n  \"id\": \"<long>\",\n  \"note\": null,\n  \"number\": \"<string>\",\n  \"position_id\": null,\n  \"project_id\": null,\n  \"login_id\": \"<long>\",\n  \"timer_value\": null\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/time-trackings/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}