Chilkat Online Tools

Objective-C / Support API / List Sharing Agreements

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;

http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://example.zendesk.com/api/v2/sharing_agreements" 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)

// {
//   "sharing_agreements": [
//     {
//       "created_at": "<dateTime>",
//       "id": "<integer>",
//       "name": "<string>",
//       "partner_name": "<string>",
//       "remote_subdomain": "<string>",
//       "status": "<string>",
//       "type": "<string>",
//       "url": "<string>"
//     },
//     {
//       "created_at": "<dateTime>",
//       "id": "<integer>",
//       "name": "<string>",
//       "partner_name": "<string>",
//       "remote_subdomain": "<string>",
//       "status": "<string>",
//       "type": "<string>",
//       "url": "<string>"
//     }
//   ]
// }

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

NSString *created_at = 0;
NSString *id = 0;
NSString *name = 0;
NSString *partner_name = 0;
NSString *remote_subdomain = 0;
NSString *status = 0;
NSString *v_type = 0;
NSString *url = 0;

int i = 0;
int count_i = [[jResp SizeOfArray: @"sharing_agreements"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    created_at = [jResp StringOf: @"sharing_agreements[i].created_at"];
    id = [jResp StringOf: @"sharing_agreements[i].id"];
    name = [jResp StringOf: @"sharing_agreements[i].name"];
    partner_name = [jResp StringOf: @"sharing_agreements[i].partner_name"];
    remote_subdomain = [jResp StringOf: @"sharing_agreements[i].remote_subdomain"];
    status = [jResp StringOf: @"sharing_agreements[i].status"];
    v_type = [jResp StringOf: @"sharing_agreements[i].type"];
    url = [jResp StringOf: @"sharing_agreements[i].url"];
    i = i + 1;
}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/sharing_agreements

Postman Collection Item JSON

{
  "name": "List Sharing Agreements",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sharing_agreements",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sharing_agreements"
      ]
    },
    "description": "#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/sharing_agreements",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sharing_agreements"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sharing_agreements\": [\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"partner_name\": \"<string>\",\n      \"remote_subdomain\": \"<string>\",\n      \"status\": \"<string>\",\n      \"type\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"partner_name\": \"<string>\",\n      \"remote_subdomain\": \"<string>\",\n      \"status\": \"<string>\",\n      \"type\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}