Chilkat Online Tools

delphiDll / Sunshine Conversations API / Get User

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Id: PWideChar;
ExternalId: PWideChar;
SignedUpAt: PWideChar;
GivenName: PWideChar;
Surname: PWideChar;
v_Email: PWideChar;
AvatarUrl: PWideChar;
Lang: PWideChar;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'username');
CkHttp_putPassword(http,'password');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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 := CkJsonObject__stringOf(jResp,'user.id');
ExternalId := CkJsonObject__stringOf(jResp,'user.externalId');
SignedUpAt := CkJsonObject__stringOf(jResp,'user.signedUpAt');
GivenName := CkJsonObject__stringOf(jResp,'user.profile.givenName');
Surname := CkJsonObject__stringOf(jResp,'user.profile.surname');
v_Email := CkJsonObject__stringOf(jResp,'user.profile.email');
AvatarUrl := CkJsonObject__stringOf(jResp,'user.profile.avatarUrl');
Lang := CkJsonObject__stringOf(jResp,'user.metadata.lang');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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