Chilkat Online Tools

Foxpro / Support API / Show Request

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcId
LOCAL lcValue
LOCAL lcSubject
LOCAL lcAssignee_id
LOCAL lcCan_be_solved_by_me
LOCAL lcCreated_at
LOCAL lcCustom_status_id
LOCAL lcDescription
LOCAL lcDue_at
LOCAL lcFollowup_source_id
LOCAL lcGroup_id
LOCAL lcId
LOCAL lcIs_public
LOCAL lcOrganization_id
LOCAL lcPriority
LOCAL lcRecipient
LOCAL lcRequester_id
LOCAL lcSolved
LOCAL lcStatus
LOCAL lcTicket_form_id
LOCAL lcV_Type
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL lcChannel
LOCAL lnEst__
LOCAL i
LOCAL lnCount_i

* 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')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/requests/:request_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

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

* {
*   "request": {
*     "subject": "<string>",
*     "assignee_id": "<integer>",
*     "can_be_solved_by_me": "<boolean>",
*     "collaborator_ids": [
*       "<integer>",
*       "<integer>"
*     ],
*     "created_at": "<dateTime>",
*     "custom_fields": [
*       {
*         "id": "<integer>",
*         "value": "<string>"
*       },
*       {
*         "id": "<integer>",
*         "value": "<string>"
*       }
*     ],
*     "custom_status_id": "<integer>",
*     "description": "<string>",
*     "due_at": "<dateTime>",
*     "email_cc_ids": [
*       "<integer>",
*       "<integer>"
*     ],
*     "followup_source_id": "<integer>",
*     "group_id": "<integer>",
*     "id": "<integer>",
*     "is_public": "<boolean>",
*     "organization_id": "<integer>",
*     "priority": "<string>",
*     "recipient": "<string>",
*     "requester_id": "<integer>",
*     "solved": "<boolean>",
*     "status": "<string>",
*     "ticket_form_id": "<integer>",
*     "type": "<string>",
*     "updated_at": "<dateTime>",
*     "url": "<string>",
*     "via": {
*       "channel": "<string>",
*       "source": {
*         "est__": false
*       }
*     }
*   }
* }

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

lcSubject = loJResp.StringOf("request.subject")
lcAssignee_id = loJResp.StringOf("request.assignee_id")
lcCan_be_solved_by_me = loJResp.StringOf("request.can_be_solved_by_me")
lcCreated_at = loJResp.StringOf("request.created_at")
lcCustom_status_id = loJResp.StringOf("request.custom_status_id")
lcDescription = loJResp.StringOf("request.description")
lcDue_at = loJResp.StringOf("request.due_at")
lcFollowup_source_id = loJResp.StringOf("request.followup_source_id")
lcGroup_id = loJResp.StringOf("request.group_id")
lcId = loJResp.StringOf("request.id")
lcIs_public = loJResp.StringOf("request.is_public")
lcOrganization_id = loJResp.StringOf("request.organization_id")
lcPriority = loJResp.StringOf("request.priority")
lcRecipient = loJResp.StringOf("request.recipient")
lcRequester_id = loJResp.StringOf("request.requester_id")
lcSolved = loJResp.StringOf("request.solved")
lcStatus = loJResp.StringOf("request.status")
lcTicket_form_id = loJResp.StringOf("request.ticket_form_id")
lcV_Type = loJResp.StringOf("request.type")
lcUpdated_at = loJResp.StringOf("request.updated_at")
lcV_Url = loJResp.StringOf("request.url")
lcChannel = loJResp.StringOf("request.via.channel")
lnEst__ = loJResp.BoolOf("request.via.source.est__")
i = 0
lnCount_i = loJResp.SizeOfArray("request.collaborator_ids")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("request.collaborator_ids[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("request.custom_fields")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("request.custom_fields[i].id")
    lcValue = loJResp.StringOf("request.custom_fields[i].value")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("request.email_cc_ids")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("request.email_cc_ids[i]")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/:request_id

Postman Collection Item JSON

{
  "name": "Show Request",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests/:request_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests",
        ":request_id"
      ],
      "variable": [
        {
          "key": "request_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Sideloads\n\nThe following sideloads are supported:\n\n| Name             | Will sideload\n| ---------------- | -------------\n| users            | The email ccs for a request by side-loading users\n\n#### Allowed For\n\n* End Users\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/requests/:request_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests",
            ":request_id"
          ],
          "variable": [
            {
              "key": "request_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"request\": {\n    \"subject\": \"<string>\",\n    \"assignee_id\": \"<integer>\",\n    \"can_be_solved_by_me\": \"<boolean>\",\n    \"collaborator_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"custom_fields\": [\n      {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"id\": \"<integer>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"custom_status_id\": \"<integer>\",\n    \"description\": \"<string>\",\n    \"due_at\": \"<dateTime>\",\n    \"email_cc_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"followup_source_id\": \"<integer>\",\n    \"group_id\": \"<integer>\",\n    \"id\": \"<integer>\",\n    \"is_public\": \"<boolean>\",\n    \"organization_id\": \"<integer>\",\n    \"priority\": \"<string>\",\n    \"recipient\": \"<string>\",\n    \"requester_id\": \"<integer>\",\n    \"solved\": \"<boolean>\",\n    \"status\": \"<string>\",\n    \"ticket_form_id\": \"<integer>\",\n    \"type\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\",\n    \"via\": {\n      \"channel\": \"<string>\",\n      \"source\": {\n        \"est__\": false\n      }\n    }\n  }\n}"
    }
  ]
}