Chilkat Online Tools

VB6 / Postman API / Get an API Version

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/{{apiVersionId}}",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)

' {
'   "version": {
'     "id": "03c17f53-7e2e-427d-b55a-006b244f29ff",
'     "name": "0.1",
'     "api": "06e41ca3-8bea-4bc5-a726-70338b9f1940",
'     "schema": [
'       "3484cd1e-e00d-4c39-aea4-539663afe898"
'     ],
'     "createdBy": "5665",
'     "updatedBy": "5665",
'     "createdAt": "2019-07-21T16:31:15.000Z",
'     "updatedAt": "2019-07-21T16:31:15.000Z"
'   }
' }

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

Dim strVal As String

Dim Id As String
Id = jResp.StringOf("version.id")
Dim Name As String
Name = jResp.StringOf("version.name")
Dim Api As String
Api = jResp.StringOf("version.api")
Dim CreatedBy As String
CreatedBy = jResp.StringOf("version.createdBy")
Dim UpdatedBy As String
UpdatedBy = jResp.StringOf("version.updatedBy")
Dim CreatedAt As String
CreatedAt = jResp.StringOf("version.createdAt")
Dim UpdatedAt As String
UpdatedAt = jResp.StringOf("version.updatedAt")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("version.schema")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("version.schema[i]")
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get an API Version",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "apis",
        "{{apiId}}",
        "versions",
        "{{apiVersionId}}"
      ]
    },
    "description": "This call fetches details about the specified API Version.\n\nThe response will contain a `version` object which would contain all the details of the API Version.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Get an API version",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{versionId}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "apis",
            "{{apiId}}",
            "versions",
            "{{versionId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"version\": {\n\t\t\"id\": \"03c17f53-7e2e-427d-b55a-006b244f29ff\",\n\t    \"name\": \"0.1\",\n\t    \"api\": \"06e41ca3-8bea-4bc5-a726-70338b9f1940\",\n\t    \"schema\": [\n\t      \"3484cd1e-e00d-4c39-aea4-539663afe898\"\n\t    ],\n\t    \"createdBy\": \"5665\",\n\t    \"updatedBy\": \"5665\",\n\t    \"createdAt\": \"2019-07-21T16:31:15.000Z\",\n\t    \"updatedAt\": \"2019-07-21T16:31:15.000Z\"\n\t}\n}"
    }
  ]
}