Chilkat Online Tools

VB6 / Postman API / Get All API Versions

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.SetRequestHeader "X-API-Key","{{postman_api_key}}"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api.getpostman.com/apis/{{apiId}}/versions",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)

' {
'   "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

Dim id As String
Dim name As String
Dim summary As String
Dim description As String
Dim createdBy As String
Dim createdAt As String
Dim updatedAt As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("versions")
Do 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
Loop

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}"
    }
  ]
}