Chilkat Online Tools

C# / Sunshine Conversations API / Get App

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "username";
http.Password = "password";

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "app": {
//     "id": "5d8cff3cd55b040010928b5b",
//     "displayName": "utoc",
//     "settings": {
//       "conversationRetentionSeconds": 35855812,
//       "maskCreditCardNumbers": true,
//       "useAnimalNames": false,
//       "echoPostback": true,
//       "ignoreAutoConversationStart": true,
//       "multiConvoEnabled": true,
//       "attachmentsAccess": "public",
//       "attachmentsTokenExpirationSeconds": 64028
//     },
//     "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

string Id = jResp.StringOf("app.id");
string DisplayName = jResp.StringOf("app.displayName");
int ConversationRetentionSeconds = jResp.IntOf("app.settings.conversationRetentionSeconds");
bool MaskCreditCardNumbers = jResp.BoolOf("app.settings.maskCreditCardNumbers");
bool UseAnimalNames = jResp.BoolOf("app.settings.useAnimalNames");
bool EchoPostback = jResp.BoolOf("app.settings.echoPostback");
bool IgnoreAutoConversationStart = jResp.BoolOf("app.settings.ignoreAutoConversationStart");
bool MultiConvoEnabled = jResp.BoolOf("app.settings.multiConvoEnabled");
string AttachmentsAccess = jResp.StringOf("app.settings.attachmentsAccess");
int AttachmentsTokenExpirationSeconds = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds");
string Lang = jResp.StringOf("app.metadata.lang");

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Get App",
  "_postman_id": "b6b38388-b3be-454f-aca6-f0624470ea02",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": "{{url}}/v2/apps/{{appId}}",
    "description": "Fetches an individual app."
  },
  "response": [
    {
      "id": "12c94751-e245-4540-8c81-865dccad09d5",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"app\": {\n  \"id\": \"5d8cff3cd55b040010928b5b\",\n  \"displayName\": \"utoc\",\n  \"settings\": {\n   \"conversationRetentionSeconds\": 35855812,\n   \"maskCreditCardNumbers\": true,\n   \"useAnimalNames\": false,\n   \"echoPostback\": true,\n   \"ignoreAutoConversationStart\": true,\n   \"multiConvoEnabled\": true,\n   \"attachmentsAccess\": \"public\",\n   \"attachmentsTokenExpirationSeconds\": 64028\n  },\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  }\n }\n}"
    },
    {
      "id": "8aa1f69d-ba23-420b-ae3f-870557fcf2ce",
      "name": "App 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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}