Chilkat Online Tools

Objective-C / DocuSign REST API / Provides a URL to start a shared recipient view of the Envelope UI

Back to Collection Items

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

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "clientUserId": "sample string 1",
//   "userId": "sample string 2",
//   "userName": "sample string 3",
//   "email": "sample string 4",
//   "recipientId": "sample string 5",
//   "returnUrl": "sample string 6",
//   "pingUrl": "sample string 7",
//   "pingFrequency": "sample string 8",
//   "authenticationMethod": "sample string 9",
//   "assertionId": "sample string 10",
//   "authenticationInstant": "sample string 11",
//   "securityDomain": "sample string 12",
//   "xFrameOptions": "sample string 13",
//   "xFrameOptionsAllowFromUrl": "sample string 14",
//   "frameAncestors": [
//     "sample string 1"
//   ],
//   "messageOrigins": [
//     "sample string 1"
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"clientUserId" value: @"sample string 1"];
[json UpdateString: @"userId" value: @"sample string 2"];
[json UpdateString: @"userName" value: @"sample string 3"];
[json UpdateString: @"email" value: @"sample string 4"];
[json UpdateString: @"recipientId" value: @"sample string 5"];
[json UpdateString: @"returnUrl" value: @"sample string 6"];
[json UpdateString: @"pingUrl" value: @"sample string 7"];
[json UpdateString: @"pingFrequency" value: @"sample string 8"];
[json UpdateString: @"authenticationMethod" value: @"sample string 9"];
[json UpdateString: @"assertionId" value: @"sample string 10"];
[json UpdateString: @"authenticationInstant" value: @"sample string 11"];
[json UpdateString: @"securityDomain" value: @"sample string 12"];
[json UpdateString: @"xFrameOptions" value: @"sample string 13"];
[json UpdateString: @"xFrameOptionsAllowFromUrl" value: @"sample string 14"];
[json UpdateString: @"frameAncestors[0]" value: @"sample string 1"];
[json UpdateString: @"messageOrigins[0]" value: @"sample string 1"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "clientUserId": "sample string 1",
  "userId": "sample string 2",
  "userName": "sample string 3",
  "email": "sample string 4",
  "recipientId": "sample string 5",
  "returnUrl": "sample string 6",
  "pingUrl": "sample string 7",
  "pingFrequency": "sample string 8",
  "authenticationMethod": "sample string 9",
  "assertionId": "sample string 10",
  "authenticationInstant": "sample string 11",
  "securityDomain": "sample string 12",
  "xFrameOptions": "sample string 13",
  "xFrameOptionsAllowFromUrl": "sample string 14",
  "frameAncestors": [
    "sample string 1"
  ],
  "messageOrigins": [
    "sample string 1"
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared

Postman Collection Item JSON

{
  "name": "Provides a URL to start a shared recipient view of the Envelope UI",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"clientUserId\": \"sample string 1\",\n  \"userId\": \"sample string 2\",\n  \"userName\": \"sample string 3\",\n  \"email\": \"sample string 4\",\n  \"recipientId\": \"sample string 5\",\n  \"returnUrl\": \"sample string 6\",\n  \"pingUrl\": \"sample string 7\",\n  \"pingFrequency\": \"sample string 8\",\n  \"authenticationMethod\": \"sample string 9\",\n  \"assertionId\": \"sample string 10\",\n  \"authenticationInstant\": \"sample string 11\",\n  \"securityDomain\": \"sample string 12\",\n  \"xFrameOptions\": \"sample string 13\",\n  \"xFrameOptionsAllowFromUrl\": \"sample string 14\",\n  \"frameAncestors\": [\n    \"sample string 1\"\n  ],\n  \"messageOrigins\": [\n    \"sample string 1\"\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/shared",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "views",
        "shared"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    }
  },
  "response": [
  ]
}