Chilkat Online Tools

VB6 / Sunshine Conversations API / Get Integration

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

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

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/v2/apps/{{appId}}/integrations/:integrationId",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

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

Dim respStatusCode As Long
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)

' {
'   "integration": {
'     "id": "5e4af71a81966cfff3ef6550",
'     "type": "android",
'     "status": "active",
'     "displayName": "Android",
'     "serverId": "<sender-id>",
'     "canUserCreateMoreConversations": true
'   }
' }

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

Dim Id As String
Id = jResp.StringOf("integration.id")
Dim v_Type As String
v_Type = jResp.StringOf("integration.type")
Dim Status As String
Status = jResp.StringOf("integration.status")
Dim DisplayName As String
DisplayName = jResp.StringOf("integration.displayName")
Dim ServerId As String
ServerId = jResp.StringOf("integration.serverId")
Dim CanUserCreateMoreConversations As Long
CanUserCreateMoreConversations = jResp.BoolOf("integration.canUserCreateMoreConversations")

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get Integration",
  "_postman_id": "8b7b69a8-8e50-43a8-a744-60eaae0c2bf1",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "integrations",
        ":integrationId"
      ],
      "variable": [
        {
          "key": "integrationId"
        }
      ]
    },
    "description": "Get integration."
  },
  "response": [
    {
      "id": "15873df6-c1a7-4758-a037-7bd7e15e9a17",
      "name": "Integration 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/integrations/:integrationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "827e7b8b-2c21-4e5e-800f-fe10d025dcac",
      "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/integrations/:integrationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"integration\": {\n  \"id\": \"5e4af71a81966cfff3ef6550\",\n  \"type\": \"android\",\n  \"status\": \"active\",\n  \"displayName\": \"Android\",\n  \"serverId\": \"<sender-id>\",\n  \"canUserCreateMoreConversations\": true\n }\n}"
    }
  ]
}