Chilkat Online Tools

SQL Server / DocuSign REST API / Retrieves the list of users for the specified account.

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

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

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'additional_info', '{{additional_info}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'count', '{{count}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'email', '{{email}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'email_substring', '{{email_substring}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'group_id', '{{group_id}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_usersettings_for_csv', '{{include_usersettings_for_csv}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'login_status', '{{login_status}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'not_group_id', '{{not_group_id}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'start_position', '{{start_position}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'status', '{{status}}'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'user_name_substring', '{{user_name_substring}}'

    -- 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, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/v2.1/accounts/{{accountId}}/users', @queryParams
    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 @queryParams
        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 @queryParams


END
GO

Curl Command

curl -G -d "additional_info=%7B%7Badditional_info%7D%7D"
	-d "count=%7B%7Bcount%7D%7D"
	-d "email=%7B%7Bemail%7D%7D"
	-d "email_substring=%7B%7Bemail_substring%7D%7D"
	-d "group_id=%7B%7Bgroup_id%7D%7D"
	-d "include_usersettings_for_csv=%7B%7Binclude_usersettings_for_csv%7D%7D"
	-d "login_status=%7B%7Blogin_status%7D%7D"
	-d "not_group_id=%7B%7Bnot_group_id%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "user_name_substring=%7B%7Buser_name_substring%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/users

Postman Collection Item JSON

{
  "name": "Retrieves the list of users for the specified account.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users?additional_info={{additional_info}}&count={{count}}&email={{email}}&email_substring={{email_substring}}&group_id={{group_id}}&include_usersettings_for_csv={{include_usersettings_for_csv}}&login_status={{login_status}}&not_group_id={{not_group_id}}&start_position={{start_position}}&status={{status}}&user_name_substring={{user_name_substring}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "users"
      ],
      "query": [
        {
          "key": "additional_info",
          "value": "{{additional_info}}"
        },
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "email",
          "value": "{{email}}"
        },
        {
          "key": "email_substring",
          "value": "{{email_substring}}"
        },
        {
          "key": "group_id",
          "value": "{{group_id}}"
        },
        {
          "key": "include_usersettings_for_csv",
          "value": "{{include_usersettings_for_csv}}"
        },
        {
          "key": "login_status",
          "value": "{{login_status}}"
        },
        {
          "key": "not_group_id",
          "value": "{{not_group_id}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "user_name_substring",
          "value": "{{user_name_substring}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Retrieves the list of users for the specified account.\n\nThe response returns the list of users for the account along with the information about the result set. If the `additional_info` query was added to the endpoint and set to **true**, the full user information is returned for each user"
  },
  "response": [
  ]
}