Chilkat Online Tools

Swift / Postman API / Get All API Versions

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    http.SetRequestHeader("X-API-Key", value: "{{postman_api_key}}")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://api.getpostman.com/apis/{{apiId}}/versions", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    // {
    //   "versions": [
    //     {
    //       "id": "024660a6-c837-46ca-91d8-7e8dd7c669de",
    //       "name": "0.1",
    //       "summary": "Summary",
    //       "description": "Description",
    //       "createdBy": "5665",
    //       "createdAt": "2019-02-12 19:34:49",
    //       "updatedAt": "2019-02-12 19:34:49"
    //     },
    //     {
    //       "id": "00932d3b-20f1-454f-a77e-38b4023163ea",
    //       "name": "0.2",
    //       "summary": "Summary",
    //       "description": "Description",
    //       "createdBy": "5665",
    //       "createdAt": "2019-02-12 19:34:49",
    //       "updatedAt": "2019-02-12 19:34:49"
    //     }
    //   ]
    // }

    // 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?
    var name: String?
    var summary: String?
    var description: String?
    var createdBy: String?
    var createdAt: String?
    var updatedAt: String?

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("versions").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("versions[i].id")
        name = jResp.StringOf("versions[i].name")
        summary = jResp.StringOf("versions[i].summary")
        description = jResp.StringOf("versions[i].description")
        createdBy = jResp.StringOf("versions[i].createdBy")
        createdAt = jResp.StringOf("versions[i].createdAt")
        updatedAt = jResp.StringOf("versions[i].updatedAt")
        i = i + 1
    }


}

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/apis/{{apiId}}/versions

Postman Collection Item JSON

{
  "name": "Get All API Versions",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/apis/{{apiId}}/versions",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "apis",
        "{{apiId}}",
        "versions"
      ]
    },
    "description": "This call fetches details about the all the API Versions in the specified API.\n\nThe response will contain an array `versions` object which would be a list of all the API Version along with their details.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Get All API versions",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/apis/{{apiId}}/versions",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "apis",
            "{{apiId}}",
            "versions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"versions\": [\n\t\t{\n\t      \"id\": \"024660a6-c837-46ca-91d8-7e8dd7c669de\",\n\t      \"name\": \"0.1\",\n\t      \"summary\": \"Summary\",\n\t      \"description\": \"Description\",\n\t      \"createdBy\": \"5665\",\n\t      \"createdAt\": \"2019-02-12 19:34:49\",\n\t      \"updatedAt\": \"2019-02-12 19:34:49\"\n\t    },\n\t    {\n\t      \"id\": \"00932d3b-20f1-454f-a77e-38b4023163ea\",\n\t      \"name\": \"0.2\",\n\t      \"summary\": \"Summary\",\n\t      \"description\": \"Description\",\n\t      \"createdBy\": \"5665\",\n\t      \"createdAt\": \"2019-02-12 19:34:49\",\n\t      \"updatedAt\": \"2019-02-12 19:34:49\"\n\t    }\n\t]\n}"
    }
  ]
}