Chilkat Online Tools

Foxpro / Postman API / Single Mock

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcOwner
LOCAL lcUid
LOCAL lcCollection
LOCAL lcEnvironment
LOCAL lcMockUrl
LOCAL lcName
LOCAL lnMatchBody
LOCAL lnMatchQueryParams
LOCAL lnMatchWildcards
LOCAL lcDelay
LOCAL lcCreatedAt
LOCAL lcUpdatedAt
LOCAL lnIsPublic
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.SetRequestHeader("X-API-Key","{{postman_api_key}}")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.getpostman.com/mocks/{{mock_uid}}",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

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

* {
*   "mock": {
*     "id": "950dcaf2-ec37-4365-b106-ed659cc2ff5d",
*     "owner": "1679925",
*     "uid": "1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d",
*     "collection": "1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf",
*     "environment": "1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
*     "mockUrl": "https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io",
*     "name": "mock1",
*     "config": {
*       "headers": [
*       ],
*       "matchBody": false,
*       "matchQueryParams": true,
*       "matchWildcards": true,
*       "delay": null
*     },
*     "createdAt": "2020-12-14T08:12:21.000Z",
*     "updatedAt": "2020-12-15T06:44:37.000Z",
*     "isPublic": false
*   }
* }

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

lcId = loJResp.StringOf("mock.id")
lcOwner = loJResp.StringOf("mock.owner")
lcUid = loJResp.StringOf("mock.uid")
lcCollection = loJResp.StringOf("mock.collection")
lcEnvironment = loJResp.StringOf("mock.environment")
lcMockUrl = loJResp.StringOf("mock.mockUrl")
lcName = loJResp.StringOf("mock.name")
lnMatchBody = loJResp.BoolOf("mock.config.matchBody")
lnMatchQueryParams = loJResp.BoolOf("mock.config.matchQueryParams")
lnMatchWildcards = loJResp.BoolOf("mock.config.matchWildcards")
lcDelay = loJResp.StringOf("mock.config.delay")
lcCreatedAt = loJResp.StringOf("mock.createdAt")
lcUpdatedAt = loJResp.StringOf("mock.updatedAt")
lnIsPublic = loJResp.BoolOf("mock.isPublic")
i = 0
lnCount_i = loJResp.SizeOfArray("mock.config.headers")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/mocks/{{mock_uid}}

Postman Collection Item JSON

{
  "name": "Single Mock",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks",
        "{{mock_uid}}"
      ]
    },
    "description": "This endpoint fetches you the basic information about a single mock using its `uid`.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Successful Response",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "mocks",
            "{{mock_uid}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "name": "Content-Type",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"mock\":{\n        \"id\":\"950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n        \"owner\":\"1679925\",\n        \"uid\":\"1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n        \"collection\":\"1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf\",\n        \"environment\": \"1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n        \"mockUrl\":\"https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io\",\n        \"name\":\"mock1\",\n        \"config\":{\n            \"headers\":[],\n            \"matchBody\":false,\n            \"matchQueryParams\":true,\n            \"matchWildcards\":true,\n            \"delay\":null\n        },\n        \"createdAt\":\"2020-12-14T08:12:21.000Z\",\n        \"updatedAt\":\"2020-12-15T06:44:37.000Z\",\n        \"isPublic\":false\n    }\n}"
    }
  ]
}