Chilkat Online Tools

PureBasic / ORACLE Hospitality OPERA Cloud REST API Workflows / Get Folio to view the charges

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::ckUpdateInt(queryParams,"folioWindowNo",1)
    CkJsonObject::ckUpdateString(queryParams,"reservationBalanceOnly","false")
    CkJsonObject::ckUpdateString(queryParams,"fetchInstructions","Payment")
    CkJsonObject::ckUpdateString(queryParams,"fetchInstructions","Postings")
    CkJsonObject::ckUpdateString(queryParams,"fetchInstructions","Transactioncodes")
    CkJsonObject::ckUpdateString(queryParams,"fetchInstructions","Totalbalance")

    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}}/reservations/{{ReservationId}}/folios",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 "folioWindowNo=1"
	-d "reservationBalanceOnly=false"
	-d "fetchInstructions=Payment"
	-d "fetchInstructions=Postings"
	-d "fetchInstructions=Transactioncodes"
	-d "fetchInstructions=Totalbalance"
	-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}}/reservations/{{ReservationId}}/folios

Postman Collection Item JSON

{
  "name": "Get Folio to view the charges",
  "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",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios?folioWindowNo=1&reservationBalanceOnly=false&fetchInstructions=Payment&fetchInstructions=Postings&fetchInstructions=Transactioncodes&fetchInstructions=Totalbalance",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "folios"
      ],
      "query": [
        {
          "key": "folioWindowNo",
          "value": "1"
        },
        {
          "key": "includeFolioHistory",
          "value": "false",
          "disabled": true
        },
        {
          "key": "guestPayOnly",
          "value": "Y",
          "disabled": true
        },
        {
          "key": "reservationBalanceOnly",
          "value": "false"
        },
        {
          "key": "fetchInstructions",
          "value": "Account",
          "disabled": true
        },
        {
          "key": "fetchInstructions",
          "value": "Payee",
          "disabled": true
        },
        {
          "key": "fetchInstructions",
          "value": "Windowbalances",
          "disabled": true
        },
        {
          "key": "fetchInstructions",
          "value": "Payment"
        },
        {
          "key": "fetchInstructions",
          "value": "Postings"
        },
        {
          "key": "fetchInstructions",
          "value": "Transactioncodes"
        },
        {
          "key": "fetchInstructions",
          "value": "Totalbalance"
        },
        {
          "key": "fetchInstructions",
          "value": "Reservation",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}