Chilkat Online Tools

Go / Support API / Show Many Job Statuses

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("login")
    http.SetPassword("password")

    queryParams := chilkat.NewJsonObject()
    queryParams.UpdateString("ids","<string>")

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

    resp := http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/job_statuses/show_many",queryParams)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        queryParams.DisposeJsonObject()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        queryParams.DisposeJsonObject()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

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

    // {
    //   "job_statuses": [
    //     {
    //       "id": "<string>",
    //       "message": "<string>",
    //       "progress": "<integer>",
    //       "results": [
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         },
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         }
    //       ],
    //       "status": "<string>",
    //       "total": "<integer>",
    //       "url": "<string>"
    //     },
    //     {
    //       "id": "<string>",
    //       "message": "<string>",
    //       "progress": "<integer>",
    //       "results": [
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         },
    //         {
    //           "id": "<integer>",
    //           "index": "<integer>"
    //         }
    //       ],
    //       "status": "<string>",
    //       "total": "<integer>",
    //       "url": "<string>"
    //     }
    //   ]
    // }

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

    var id *string = new(string)
    var message *string = new(string)
    var progress *string = new(string)
    var status *string = new(string)
    var total *string = new(string)
    var url *string = new(string)
    var j int
    var count_j int
    var index *string = new(string)

    i := 0
    count_i := jResp.SizeOfArray("job_statuses")
    for i < count_i {
        jResp.SetI(i)
        id = jResp.StringOf("job_statuses[i].id")
        message = jResp.StringOf("job_statuses[i].message")
        progress = jResp.StringOf("job_statuses[i].progress")
        status = jResp.StringOf("job_statuses[i].status")
        total = jResp.StringOf("job_statuses[i].total")
        url = jResp.StringOf("job_statuses[i].url")
        j = 0
        count_j = jResp.SizeOfArray("job_statuses[i].results")
        for j < count_j {
            jResp.SetJ(j)
            id = jResp.StringOf("job_statuses[i].results[j].id")
            index = jResp.StringOf("job_statuses[i].results[j].index")
            j = j + 1
        }

        i = i + 1
    }


    http.DisposeHttp()
    queryParams.DisposeJsonObject()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

curl  -u login:password -G -d "ids=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/job_statuses/show_many

Postman Collection Item JSON

{
  "name": "Show Many Job Statuses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/job_statuses/show_many?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "job_statuses",
        "show_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Comma-separated list of job status ids."
        }
      ]
    },
    "description": "Accepts a comma-separated list of job status ids.\n\n#### Allowed For:\n\n* Agents\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/job_statuses/show_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "job_statuses",
            "show_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) Comma-separated list of job status ids."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_statuses\": [\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}