Chilkat Online Tools

Objective-C / Support API / Update a Sharing Agreement

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.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"];

CkoHttpResponse *resp = [http QuickRequest: @"PUT" url: @"https://example.zendesk.com/api/v2/sharing_agreements/:sharing_agreement_id"];
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)

// {
//   "sharing_agreement": {
//     "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 = [jResp StringOf: @"sharing_agreement.created_at"];
NSString *Id = [jResp StringOf: @"sharing_agreement.id"];
NSString *Name = [jResp StringOf: @"sharing_agreement.name"];
NSString *Partner_name = [jResp StringOf: @"sharing_agreement.partner_name"];
NSString *Remote_subdomain = [jResp StringOf: @"sharing_agreement.remote_subdomain"];
NSString *Status = [jResp StringOf: @"sharing_agreement.status"];
NSString *v_Type = [jResp StringOf: @"sharing_agreement.type"];
NSString *v_Url = [jResp StringOf: @"sharing_agreement.url"];

Curl Command

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

Postman Collection Item JSON

{
  "name": "Update a Sharing Agreement",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sharing_agreements",
        ":sharing_agreement_id"
      ],
      "variable": [
        {
          "key": "sharing_agreement_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns an updated sharing agreement. Only `status` is allowed to be updated.\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/sharing_agreements/:sharing_agreement_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sharing_agreements",
            ":sharing_agreement_id"
          ],
          "variable": [
            {
              "key": "sharing_agreement_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sharing_agreement\": {\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}"
    }
  ]
}