Chilkat Online Tools

VBScript / Sunshine Conversations API / Get User

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

http.BasicAuth = 1
http.Login = "username"
http.Password = "password"

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = http.QuickGetSb("https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId",sbResponseBody)
If (success = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = http.LastStatus
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(http.LastHeader)
    outFile.WriteLine("Failed.")
    WScript.Quit
End If

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

' {
'   "user": {
'     "id": "7494535bff5cef41a15be74d",
'     "externalId": "your-own-id",
'     "signedUpAt": "2020-05-21T15:53:30.197Z",
'     "profile": {
'       "givenName": "Jane",
'       "surname": "Doe",
'       "email": "jane.doe@gmail.com",
'       "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
'     },
'     "metadata": {
'       "lang": "en-ca"
'     }
'   }
' }

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

Id = jResp.StringOf("user.id")
ExternalId = jResp.StringOf("user.externalId")
SignedUpAt = jResp.StringOf("user.signedUpAt")
GivenName = jResp.StringOf("user.profile.givenName")
Surname = jResp.StringOf("user.profile.surname")
v_Email = jResp.StringOf("user.profile.email")
AvatarUrl = jResp.StringOf("user.profile.avatarUrl")
Lang = jResp.StringOf("user.metadata.lang")

outFile.Close

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId

Postman Collection Item JSON

{
  "name": "Get User",
  "_postman_id": "07e96578-d726-484e-950c-aa44cc307bf2",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "users",
        ":userIdOrExternalId"
      ],
      "variable": [
        {
          "key": "userIdOrExternalId"
        }
      ]
    },
    "description": "Fetches an individual user."
  },
  "response": [
    {
      "id": "1a4f8a87-2cc5-4c7c-ba22-baeccbc6c7f7",
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"user\": {\n  \"id\": \"7494535bff5cef41a15be74d\",\n  \"externalId\": \"your-own-id\",\n  \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n  \"profile\": {\n   \"givenName\": \"Jane\",\n   \"surname\": \"Doe\",\n   \"email\": \"jane.doe@gmail.com\",\n   \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n  },\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  }\n }\n}"
    },
    {
      "id": "d8a40233-2239-4953-9e3d-6c3f40492da2",
      "name": "User not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}