Chilkat Online Tools

PureBasic / ORACLE Hospitality OPERA Cloud REST API Workflows / Get transaction codes to see what charges can be posted

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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

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

    CkJsonObject::ckUpdateString(queryParams,"includeArticles","true")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/csh/v0/hotels/{{HotelId}}/transactionCodes",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "includeArticles=true"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
https://domain.com/csh/v0/hotels/{{HotelId}}/transactionCodes

Postman Collection Item JSON

{
  "name": "Get transaction codes to see what charges can be posted",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/transactionCodes?includeArticles=true",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "transactionCodes"
      ],
      "query": [
        {
          "key": "includeArticles",
          "value": "true"
        },
        {
          "key": "userRoleTransactions",
          "value": "",
          "disabled": true
        },
        {
          "key": "manualPostAllowed",
          "value": "true",
          "disabled": true
        },
        {
          "key": "code",
          "value": "",
          "disabled": true
        },
        {
          "key": "description",
          "value": "",
          "disabled": true
        },
        {
          "key": "wildCard",
          "value": "",
          "disabled": true
        },
        {
          "key": "folioDate",
          "value": "",
          "disabled": true
        },
        {
          "key": "folioNo",
          "value": "",
          "disabled": true
        },
        {
          "key": "folioStatus",
          "value": "",
          "disabled": true
        },
        {
          "key": "folioTypeName",
          "value": "",
          "disabled": true
        },
        {
          "key": "invoiceNo",
          "value": "",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}