Chilkat Online Tools

Objective-C / easybill REST API / Fetch time trackings list

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoDtObj.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"limit" value: @"<integer>"];
[queryParams UpdateString: @"page" value: @"<integer>"];
[queryParams UpdateString: @"login_id" value: @"<string>"];
[queryParams UpdateString: @"project_id" value: @"<string>"];
[queryParams UpdateString: @"date_from_at" value: @"<string>"];
[queryParams UpdateString: @"date_thru_at" value: @"<string>"];

[http SetRequestHeader: @"Authorization" value: @"{{apiKey}}"];
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.easybill.de/rest/v1/time-trackings" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "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
//     },
//     {
//       "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

CkoDtObj *date_from_at = [[CkoDtObj alloc] init];
CkoDtObj *date_thru_at = [[CkoDtObj alloc] init];
NSString *description = 0;
NSString *cleared_at = 0;
NSString *created_at = 0;
int hourly_rate;
NSString *id = 0;
NSString *note = 0;
NSString *v_number = 0;
NSString *position_id = 0;
NSString *project_id = 0;
NSString *login_id = 0;
NSString *timer_value = 0;

NSString *page = [jResp StringOf: @"page"];
NSString *pages = [jResp StringOf: @"pages"];
NSString *limit = [jResp StringOf: @"limit"];
NSString *total = [jResp StringOf: @"total"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"items"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    description = [jResp StringOf: @"items[i].description"];
    cleared_at = [jResp StringOf: @"items[i].cleared_at"];
    created_at = [jResp StringOf: @"items[i].created_at"];
    [jResp DtOf: @"items[i].date_from_at" bLocal: NO dt: date_from_at];
    [jResp DtOf: @"items[i].date_thru_at" bLocal: NO dt: date_thru_at];
    hourly_rate = [[jResp IntOf: @"items[i].hourly_rate"] intValue];
    id = [jResp StringOf: @"items[i].id"];
    note = [jResp StringOf: @"items[i].note"];
    v_number = [jResp StringOf: @"items[i].number"];
    position_id = [jResp StringOf: @"items[i].position_id"];
    project_id = [jResp StringOf: @"items[i].project_id"];
    login_id = [jResp StringOf: @"items[i].login_id"];
    timer_value = [jResp StringOf: @"items[i].timer_value"];
    i = i + 1;
}

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "login_id=%3Cstring%3E"
	-d "project_id=%3Cstring%3E"
	-d "date_from_at=%3Cstring%3E"
	-d "date_thru_at=%3Cstring%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/time-trackings

Postman Collection Item JSON

{
  "name": "Fetch time trackings list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/time-trackings?limit=<integer>&page=<integer>&login_id=<string>&project_id=<string>&date_from_at=<string>&date_thru_at=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "time-trackings"
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Limited the result. Default is 100. Maximum can be 1000."
        },
        {
          "key": "page",
          "value": "<integer>",
          "description": "Set current Page. Default is 1."
        },
        {
          "key": "login_id",
          "value": "<string>",
          "description": "Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id."
        },
        {
          "key": "project_id",
          "value": "<string>",
          "description": "Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id."
        },
        {
          "key": "date_from_at",
          "value": "<string>",
          "description": "Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
        },
        {
          "key": "date_thru_at",
          "value": "<string>",
          "description": "Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/time-trackings?limit=<integer>&page=<integer>&login_id=<string>&project_id=<string>&date_from_at=<string>&date_thru_at=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            },
            {
              "key": "login_id",
              "value": "<string>",
              "description": "Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "project_id",
              "value": "<string>",
              "description": "Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "date_from_at",
              "value": "<string>",
              "description": "Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
            },
            {
              "key": "date_thru_at",
              "value": "<string>",
              "description": "Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"page\": \"<integer>\",\n  \"pages\": \"<integer>\",\n  \"limit\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"items\": [\n    {\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    },\n    {\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    }\n  ]\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/time-trackings?limit=<integer>&page=<integer>&login_id=<string>&project_id=<string>&date_from_at=<string>&date_thru_at=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "time-trackings"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            },
            {
              "key": "login_id",
              "value": "<string>",
              "description": "Filter time-tracking by login_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "project_id",
              "value": "<string>",
              "description": "Filter time-tracking by project_id. You can add multiple ids separate by comma like id,id,id."
            },
            {
              "key": "date_from_at",
              "value": "<string>",
              "description": "Filter time-tracking by date_from_at. You can filter one date with date_from_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_from_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
            },
            {
              "key": "date_thru_at",
              "value": "<string>",
              "description": "Filter time-tracking by date_thru_at. You can filter one date with date_thru_at=2014-12-10 or between like 2015-01-01,2015-12-31.\nYou can also specify a specific time with date_thru_at=2014-12-10 12:30:00 or between like 2015-01-01 12:30:00,2015-01-01 13:00:00."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}