Chilkat Online Tools

SQL Server / ORACLE Hospitality OPERA Cloud REST API Workflows / Get the reservation folio

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'folioWindowNo', 1
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'reservationBalanceOnly', 'false'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fetchInstructions', 'Payment'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fetchInstructions', 'Postings'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fetchInstructions', 'Transactioncodes'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'fetchInstructions', 'Totalbalance'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/folios', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams


END
GO

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 the reservation folio",
  "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}}/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": [
  ]
}