Chilkat Online Tools

PureBasic / GP-API Collection / ACT_1.1 Get Action

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Adds the "Authorization: Bearer {{token}}" header.
    CkHttp::setCkAuthToken(http, "{{token}}")
    CkHttp::ckSetRequestHeader(http,"X-GP-Version","{{version}}")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://{{url}}/ucp/actions/ACT_I3qHb6EkqS6ApYPqt45Fv8JfM4r13p",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
    Debug CkStringBuilder::ckGetAsString(sbResponseBody)


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/actions/ACT_I3qHb6EkqS6ApYPqt45Fv8JfM4r13p

Postman Collection Item JSON

{
  "name": "ACT_1.1 Get Action",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "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",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "X-GP-Version",
        "value": "{{version}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/actions/ACT_I3qHb6EkqS6ApYPqt45Fv8JfM4r13p",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "actions",
        "ACT_I3qHb6EkqS6ApYPqt45Fv8JfM4r13p"
      ]
    },
    "description": "This request returns a more detailed view of one action from a returned actions list. Replace current ACT id in the GET URL with whichever ACT id you would like to see more details on. \r\n\r\nFor more information on this request, please visit the following Dev Portal link: https://developer.globalpay.com/api/actions#/Action/get_actions__id_"
  },
  "response": [
  ]
}