Chilkat Online Tools

.NET Core C# / Postman API / Single Mock

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://api.getpostman.com/mocks/{{mock_uid}}",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

// 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

string Id = jResp.StringOf("mock.id");
string Owner = jResp.StringOf("mock.owner");
string Uid = jResp.StringOf("mock.uid");
string Collection = jResp.StringOf("mock.collection");
string Environment = jResp.StringOf("mock.environment");
string MockUrl = jResp.StringOf("mock.mockUrl");
string Name = jResp.StringOf("mock.name");
bool MatchBody = jResp.BoolOf("mock.config.matchBody");
bool MatchQueryParams = jResp.BoolOf("mock.config.matchQueryParams");
bool MatchWildcards = jResp.BoolOf("mock.config.matchWildcards");
string Delay = jResp.StringOf("mock.config.delay");
string CreatedAt = jResp.StringOf("mock.createdAt");
string UpdatedAt = jResp.StringOf("mock.updatedAt");
bool IsPublic = jResp.BoolOf("mock.isPublic");
int i = 0;
int count_i = jResp.SizeOfArray("mock.config.headers");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

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