Chilkat Online Tools

Objective-C / New FreshBooks / Single Staff

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.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;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

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

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

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

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

// {
//   "response": {
//     "result": {
//       "staff": {
//         "accounting_systemid": "wkMd2g",
//         "api_token": "9249ac8633763523fe614cdeb28787b9",
//         "bus_phone": "",
//         "currency_code": null,
//         "display_name": "RyenMarr",
//         "email": "api.freshbooks@gmail.com",
//         "fax": "",
//         "fname": "Ryen",
//         "home_phone": null,
//         "id": 1,
//         "language": "en",
//         "last_login": null,
//         "level": 3,
//         "lname": "Marr",
//         "mob_phone": "",
//         "note": null,
//         "num_logins": 0,
//         "organization": "Postman Sandbox",
//         "p_city": "",
//         "p_code": "",
//         "p_country": "",
//         "p_province": "",
//         "p_street": "",
//         "p_street2": "",
//         "rate": null,
//         "role": "admin",
//         "signup_date": "2019-04-18 09:14:53",
//         "updated": "2019-04-24 14:37:58",
//         "userid": 1,
//         "username": "api.freshbooks@gmail.com",
//         "vis_state": 0
//       }
//     }
//   }
// }

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

NSString *Accounting_systemid = [jResp StringOf: @"response.result.staff.accounting_systemid"];
NSString *Api_token = [jResp StringOf: @"response.result.staff.api_token"];
NSString *Bus_phone = [jResp StringOf: @"response.result.staff.bus_phone"];
NSString *Currency_code = [jResp StringOf: @"response.result.staff.currency_code"];
NSString *Display_name = [jResp StringOf: @"response.result.staff.display_name"];
NSString *v_Email = [jResp StringOf: @"response.result.staff.email"];
NSString *Fax = [jResp StringOf: @"response.result.staff.fax"];
NSString *Fname = [jResp StringOf: @"response.result.staff.fname"];
NSString *Home_phone = [jResp StringOf: @"response.result.staff.home_phone"];
int Id = [[jResp IntOf: @"response.result.staff.id"] intValue];
NSString *Language = [jResp StringOf: @"response.result.staff.language"];
NSString *Last_login = [jResp StringOf: @"response.result.staff.last_login"];
int Level = [[jResp IntOf: @"response.result.staff.level"] intValue];
NSString *Lname = [jResp StringOf: @"response.result.staff.lname"];
NSString *Mob_phone = [jResp StringOf: @"response.result.staff.mob_phone"];
NSString *Note = [jResp StringOf: @"response.result.staff.note"];
int Num_logins = [[jResp IntOf: @"response.result.staff.num_logins"] intValue];
NSString *Organization = [jResp StringOf: @"response.result.staff.organization"];
NSString *P_city = [jResp StringOf: @"response.result.staff.p_city"];
NSString *P_code = [jResp StringOf: @"response.result.staff.p_code"];
NSString *P_country = [jResp StringOf: @"response.result.staff.p_country"];
NSString *P_province = [jResp StringOf: @"response.result.staff.p_province"];
NSString *P_street = [jResp StringOf: @"response.result.staff.p_street"];
NSString *P_street2 = [jResp StringOf: @"response.result.staff.p_street2"];
NSString *Rate = [jResp StringOf: @"response.result.staff.rate"];
NSString *Role = [jResp StringOf: @"response.result.staff.role"];
NSString *Signup_date = [jResp StringOf: @"response.result.staff.signup_date"];
NSString *Updated = [jResp StringOf: @"response.result.staff.updated"];
int Userid = [[jResp IntOf: @"response.result.staff.userid"] intValue];
NSString *Username = [jResp StringOf: @"response.result.staff.username"];
int Vis_state = [[jResp IntOf: @"response.result.staff.vis_state"] intValue];

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}

Postman Collection Item JSON

{
  "name": "Single Staff",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "users",
        "staffs",
        "{{staffId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Single Staff",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "users",
            "staffs",
            "{{staffId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwQFlEEXkAUCBgCHVQOVQBUAlpdAQNSVlcJCglWTU8GHRUEUFIGUAEAAVJRBgpaXFxQEB8DWA1CBG4="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346267"
        },
        {
          "key": "Retry-After",
          "value": "54"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:10:12 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Date",
          "value": "Wed, 08 May 2019 20:10:12 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": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"staff\": {\n                \"accounting_systemid\": \"wkMd2g\",\n                \"api_token\": \"9249ac8633763523fe614cdeb28787b9\",\n                \"bus_phone\": \"\",\n                \"currency_code\": null,\n                \"display_name\": \"RyenMarr\",\n                \"email\": \"api.freshbooks@gmail.com\",\n                \"fax\": \"\",\n                \"fname\": \"Ryen\",\n                \"home_phone\": null,\n                \"id\": 1,\n                \"language\": \"en\",\n                \"last_login\": null,\n                \"level\": 3,\n                \"lname\": \"Marr\",\n                \"mob_phone\": \"\",\n                \"note\": null,\n                \"num_logins\": 0,\n                \"organization\": \"Postman Sandbox\",\n                \"p_city\": \"\",\n                \"p_code\": \"\",\n                \"p_country\": \"\",\n                \"p_province\": \"\",\n                \"p_street\": \"\",\n                \"p_street2\": \"\",\n                \"rate\": null,\n                \"role\": \"admin\",\n                \"signup_date\": \"2019-04-18 09:14:53\",\n                \"updated\": \"2019-04-24 14:37:58\",\n                \"userid\": 1,\n                \"username\": \"api.freshbooks@gmail.com\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}