Chilkat Online Tools

PureBasic / Support API / Search Requests

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/requests/search",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ; {
    ;   "requests": [
    ;     {
    ;       "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": {
    ;           "sitde": -5925380.425592765,
    ;           "id80": false
    ;         }
    ;       }
    ;     },
    ;     {
    ;       "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": {
    ;           "esse2a": false,
    ;           "irure_8": true,
    ;           "in77": 99886237.33060426,
    ;           "nisi_0": "occaecat velit voluptate consequat"
    ;         }
    ;       }
    ;     }
    ;   ]
    ; }

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

    subject.s
    assignee_id.s
    can_be_solved_by_me.s
    created_at.s
    custom_status_id.s
    description.s
    due_at.s
    followup_source_id.s
    group_id.s
    id.s
    is_public.s
    organization_id.s
    priority.s
    recipient.s
    requester_id.s
    solved.s
    status.s
    ticket_form_id.s
    v_type.s
    updated_at.s
    url.s
    Channel.s
    Sitde.s
    Id80.i
    Esse2a.i
    Irure_8.i
    In77.s
    Nisi_0.s
    j.i
    count_j.i
    strVal.s
    value.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"requests")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        subject = CkJsonObject::ckStringOf(jResp,"requests[i].subject")
        assignee_id = CkJsonObject::ckStringOf(jResp,"requests[i].assignee_id")
        can_be_solved_by_me = CkJsonObject::ckStringOf(jResp,"requests[i].can_be_solved_by_me")
        created_at = CkJsonObject::ckStringOf(jResp,"requests[i].created_at")
        custom_status_id = CkJsonObject::ckStringOf(jResp,"requests[i].custom_status_id")
        description = CkJsonObject::ckStringOf(jResp,"requests[i].description")
        due_at = CkJsonObject::ckStringOf(jResp,"requests[i].due_at")
        followup_source_id = CkJsonObject::ckStringOf(jResp,"requests[i].followup_source_id")
        group_id = CkJsonObject::ckStringOf(jResp,"requests[i].group_id")
        id = CkJsonObject::ckStringOf(jResp,"requests[i].id")
        is_public = CkJsonObject::ckStringOf(jResp,"requests[i].is_public")
        organization_id = CkJsonObject::ckStringOf(jResp,"requests[i].organization_id")
        priority = CkJsonObject::ckStringOf(jResp,"requests[i].priority")
        recipient = CkJsonObject::ckStringOf(jResp,"requests[i].recipient")
        requester_id = CkJsonObject::ckStringOf(jResp,"requests[i].requester_id")
        solved = CkJsonObject::ckStringOf(jResp,"requests[i].solved")
        status = CkJsonObject::ckStringOf(jResp,"requests[i].status")
        ticket_form_id = CkJsonObject::ckStringOf(jResp,"requests[i].ticket_form_id")
        v_type = CkJsonObject::ckStringOf(jResp,"requests[i].type")
        updated_at = CkJsonObject::ckStringOf(jResp,"requests[i].updated_at")
        url = CkJsonObject::ckStringOf(jResp,"requests[i].url")
        Channel = CkJsonObject::ckStringOf(jResp,"requests[i].via.channel")
        Sitde = CkJsonObject::ckStringOf(jResp,"requests[i].via.source.sitde")
        Id80 = CkJsonObject::ckBoolOf(jResp,"requests[i].via.source.id80")
        Esse2a = CkJsonObject::ckBoolOf(jResp,"requests[i].via.source.esse2a")
        Irure_8 = CkJsonObject::ckBoolOf(jResp,"requests[i].via.source.irure_8")
        In77 = CkJsonObject::ckStringOf(jResp,"requests[i].via.source.in77")
        Nisi_0 = CkJsonObject::ckStringOf(jResp,"requests[i].via.source.nisi_0")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"requests[i].collaborator_ids")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"requests[i].collaborator_ids[j]")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"requests[i].custom_fields")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            id = CkJsonObject::ckStringOf(jResp,"requests[i].custom_fields[j].id")
            value = CkJsonObject::ckStringOf(jResp,"requests[i].custom_fields[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"requests[i].email_cc_ids")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"requests[i].email_cc_ids[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Search Requests",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests/search",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests",
        "search"
      ],
      "variable": [
        {
          "key": "query",
          "value": "<string>",
          "description": "The syntax and matching logic for the string is detailed in the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226). See also [Query basics](/api-reference/ticketing/ticket-management/search/#query-basics) in the Tickets API doc."
        }
      ]
    },
    "description": "Examples:\n\n* `GET /api/v2/requests/search.json?query=printer`\n* `GET /api/v2/requests/search.json?query=printer&organization_id=1`\n* `GET /api/v2/requests/search.json?query=printer&cc_id=true`\n* `GET /api/v2/requests/search.json?query=printer&status=hold,open`\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Results limit\n\nThe Search Requests endpoint returns up to 1,000 results per query, with a maximum of 100 results per page. See [Pagination](/api-reference/ticketing/introduction/#pagination). If you request a page past the limit (`page=11` at 100 results per page), a 422 Insufficient Resource Error is returned.\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/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests",
            "search"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"requests\": [\n    {\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          \"sitde\": -5925380.425592765,\n          \"id80\": false\n        }\n      }\n    },\n    {\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          \"esse2a\": false,\n          \"irure_8\": true,\n          \"in77\": 99886237.33060426,\n          \"nisi_0\": \"occaecat velit voluptate consequat\"\n        }\n      }\n    }\n  ]\n}"
    }
  ]
}