Chilkat Online Tools

unicodeC / GP-API Collection / ACT_1.0 Get Actions List

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"from_time_created",L"2020-09-29");
    CkJsonObjectW_UpdateString(queryParams,L"order",L"DESC");

    // Adds the "Authorization: Bearer {{token}}" header.
    CkHttpW_putAuthToken(http,L"{{token}}");
    CkHttpW_SetRequestHeader(http,L"X-GP-Version",L"{{version}}");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://{{url}}/ucp/actions",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);

    }

Curl Command

curl -G -d "from_time_created=2020-09-29"
	-d "order=DESC"
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/actions

Postman Collection Item JSON

{
  "name": "ACT_1.0 Get Actions List",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "\r",
          "pm.test(\"Successful POST request\", function () {\r",
          "    pm.expect(pm.response.code).to.be.oneOf([200,201,202]);\r",
          "});\r",
          "\r",
          "pm.test(\"Status code name has string\", function () {\r",
          "    pm.response.to.have.status(\"OK\");\r",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{token}}"
      },
      {
        "key": "X-GP-Version",
        "type": "text",
        "value": "{{version}}"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/actions?from_time_created=2020-09-29&order=DESC",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "actions"
      ],
      "query": [
        {
          "key": "to_time_created",
          "value": "2020-05-28",
          "disabled": true
        },
        {
          "key": "from_time_created",
          "value": "2020-09-29"
        },
        {
          "key": "page_size",
          "value": "100",
          "disabled": true
        },
        {
          "key": "page",
          "value": "1",
          "disabled": true
        },
        {
          "key": "order",
          "value": "DESC"
        },
        {
          "key": "order_by",
          "value": "time_created",
          "disabled": true
        }
      ]
    },
    "description": "This request gets a log of requests and responses sent by the merchant and received by GP-API.\r\n\r\nFor more information on what query params you can return the list by, please visit the following Dev Portal link: https://developer.globalpay.com/api/actions#/Actions/get_actions"
  },
  "response": [
  ]
}