(Excel) Docusign: Return Brand Data Associated with a User

Demonstrates a call using an OAuth2 access token in combination with the account ID for which we have authorization.

For more information, see https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Implements the following CURL command:

' curl --request GET https://account-d.docusign.com/restapi/v2/accounts/18b4799a-xxxx-xxxx-xxxx-b5b4b8a97604/brands --header "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ"

' Use the following online tool to generate HTTP code from a CURL command
' Convert a cURL Command to HTTP Source Code

' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject
' Load a previously obtained OAuth2 access token.
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = False) Then
    Debug.Print jsonToken.LastErrorText
    Exit Sub
End If

http.AuthToken = jsonToken.StringOf("access_token")

' Use an account ID obtained from DocuSign Get User Account Data
Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = http.QuickGetSb("https://account-d.docusign.com/restapi/v2/accounts/18b4799a-xxxx-xxxx-xxxx-b5b4b8a97604/brands",sbResponseBody)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
Dim success As Boolean
success = json.LoadSb(sbResponseBody)
json.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print json.Emit()


respStatusCode = http.LastStatus
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "recipientBrandIdDefault": "sample string 1",
'   "senderBrandIdDefault": "sample string 2",
'   "brands": [
'     {
'       "brandCompany": "sample string 1",
'       "brandId": "sample string 2",
'       "brandName": "sample string 3",
'       "colors": [
'         {}
'       ],
'       "errorDetails": {
'         "errorCode": "sample string 1",
'         "message": "sample string 2"
'       },
'       "isOverridingCompanyName": "sample string 4",
'       "isSendingDefault": "sample string 5",
'       "isSigningDefault": "sample string 6",
'       "landingPages": [
'         {}
'       ],
'       "links": [
'         {
'           "linkType": "sample string 1",
'           "urlOrMailTo": "sample string 2",
'           "linkText": "sample string 3",
'           "showLink": "sample string 4"
'         }
'       ],
'       "emailContent": [
'         {
'           "emailContentType": "sample string 1",
'           "content": "sample string 2",
'           "emailToLink": "sample string 3",
'           "linkText": "sample string 4"
'         }
'       ],
'       "logos": {
'         "primary": "sample string 1",
'         "secondary": "sample string 2",
'         "email": "sample string 3"
'       },
'       "resources": {
'         "email": "sample string 1",
'         "sending": "sample string 2",
'         "signing": "sample string 3",
'         "signingCaptive": "sample string 4"
'       }
'     }
'   ]
' }

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


recipientBrandIdDefault = json.StringOf("recipientBrandIdDefault")

senderBrandIdDefault = json.StringOf("senderBrandIdDefault")

i = 0

count_i = json.SizeOfArray("brands")
Do While i < count_i
    json.I = i
    brandCompany = json.StringOf("brands[i].brandCompany")
    brandId = json.StringOf("brands[i].brandId")
    brandName = json.StringOf("brands[i].brandName")
    errorDetailsErrorCode = json.StringOf("brands[i].errorDetails.errorCode")
    errorDetailsMessage = json.StringOf("brands[i].errorDetails.message")
    isOverridingCompanyName = json.StringOf("brands[i].isOverridingCompanyName")
    isSendingDefault = json.StringOf("brands[i].isSendingDefault")
    isSigningDefault = json.StringOf("brands[i].isSigningDefault")
    logosPrimary = json.StringOf("brands[i].logos.primary")
    logosSecondary = json.StringOf("brands[i].logos.secondary")
    logosEmail = json.StringOf("brands[i].logos.email")
    resourcesEmail = json.StringOf("brands[i].resources.email")
    resourcesSending = json.StringOf("brands[i].resources.sending")
    resourcesSigning = json.StringOf("brands[i].resources.signing")
    resourcesSigningCaptive = json.StringOf("brands[i].resources.signingCaptive")
    j = 0
    count_j = json.SizeOfArray("brands[i].colors")
    Do While j < count_j
        json.J = j
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("brands[i].landingPages")
    Do While j < count_j
        json.J = j
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("brands[i].links")
    Do While j < count_j
        json.J = j
        linkType = json.StringOf("brands[i].links[j].linkType")
        urlOrMailTo = json.StringOf("brands[i].links[j].urlOrMailTo")
        linkText = json.StringOf("brands[i].links[j].linkText")
        showLink = json.StringOf("brands[i].links[j].showLink")
        j = j + 1
    Loop
    j = 0
    count_j = json.SizeOfArray("brands[i].emailContent")
    Do While j < count_j
        json.J = j
        emailContentType = json.StringOf("brands[i].emailContent[j].emailContentType")
        content = json.StringOf("brands[i].emailContent[j].content")
        emailToLink = json.StringOf("brands[i].emailContent[j].emailToLink")
        linkText = json.StringOf("brands[i].emailContent[j].linkText")
        j = j + 1
    Loop
    i = i + 1
Loop