Chilkat Online Tools

SQL Server / DocuSign REST API / Returns a URL to the recipient view UI.

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- 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"
    --   ]
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'clientUserId', 'sample string 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'userId', 'sample string 2'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'userName', 'sample string 3'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'email', 'sample string 4'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'recipientId', 'sample string 5'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'returnUrl', 'sample string 6'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'pingUrl', 'sample string 7'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'pingFrequency', 'sample string 8'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'authenticationMethod', 'sample string 9'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'assertionId', 'sample string 10'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'authenticationInstant', 'sample string 11'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'securityDomain', 'sample string 12'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'xFrameOptions', 'sample string 13'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'xFrameOptionsAllowFromUrl', 'sample string 14'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'frameAncestors[0]', 'sample string 1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messageOrigins[0]', 'sample string 1'

    -- Adds the "Authorization: Bearer {{accessToken}}" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/recipient', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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/recipient

Postman Collection Item JSON

{
  "name": "Returns a URL to the recipient view 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/recipient",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "views",
        "recipient"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. \n\nImportant: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. \n\nAn entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity."
  },
  "response": [
  ]
}