Chilkat Online Tools

Foxpro / ORACLE Hospitality OPERA Cloud REST API Workflows / Update a Service Request

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "serviceRequestsDetails": [
*     {
*       "serviceRequestId": {
*         "type": "ServiceRequestID",
*         "idContext": "OPERA",
*         "id": "53437"
*       },
*       "hotelId": "{{HotelId}}",
*       "code": "MIN",
*       "status": "Closed",
*       "priority": "HIGH",
*       "department": {
*         "code": "HSK"
*       },
*       "reservationIdList": [
*         {
*           "type": "Reservation",
*           "id": "{{ReservationId}}"
*         }
*       ],
*       "profileId": {
*         "type": "Profile",
*         "id": "{{ProfileId}}"
*       },
*       "guestName": "Smith, Jack,",
*       "room": "{{RoomId}}",
*       "functionSpaceDetails": "{{RoomId}}",
*       "openDate": "2021-02-26 22:57:00.0",
*       "guaranteedBy": "Ben",
*       "comment": "test",
*       "action": "completed",
*       "guestContactMethod": "IN-ROOM MESSAGE",
*       "completionDate": "2021-02-26 22:53:00.0",
*       "closedDate": "2021-02-26 22:57:00.0",
*       "closedBy": "closed",
*       "closeDescription": "add in action taken notes here"
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("serviceRequestsDetails[0].serviceRequestId.type","ServiceRequestID")
loJson.UpdateString("serviceRequestsDetails[0].serviceRequestId.idContext","OPERA")
loJson.UpdateString("serviceRequestsDetails[0].serviceRequestId.id","53437")
loJson.UpdateString("serviceRequestsDetails[0].hotelId","{{HotelId}}")
loJson.UpdateString("serviceRequestsDetails[0].code","MIN")
loJson.UpdateString("serviceRequestsDetails[0].status","Closed")
loJson.UpdateString("serviceRequestsDetails[0].priority","HIGH")
loJson.UpdateString("serviceRequestsDetails[0].department.code","HSK")
loJson.UpdateString("serviceRequestsDetails[0].reservationIdList[0].type","Reservation")
loJson.UpdateString("serviceRequestsDetails[0].reservationIdList[0].id","{{ReservationId}}")
loJson.UpdateString("serviceRequestsDetails[0].profileId.type","Profile")
loJson.UpdateString("serviceRequestsDetails[0].profileId.id","{{ProfileId}}")
loJson.UpdateString("serviceRequestsDetails[0].guestName","Smith, Jack,")
loJson.UpdateString("serviceRequestsDetails[0].room","{{RoomId}}")
loJson.UpdateString("serviceRequestsDetails[0].functionSpaceDetails","{{RoomId}}")
loJson.UpdateString("serviceRequestsDetails[0].openDate","2021-02-26 22:57:00.0")
loJson.UpdateString("serviceRequestsDetails[0].guaranteedBy","Ben")
loJson.UpdateString("serviceRequestsDetails[0].comment","test")
loJson.UpdateString("serviceRequestsDetails[0].action","completed")
loJson.UpdateString("serviceRequestsDetails[0].guestContactMethod","IN-ROOM MESSAGE")
loJson.UpdateString("serviceRequestsDetails[0].completionDate","2021-02-26 22:53:00.0")
loJson.UpdateString("serviceRequestsDetails[0].closedDate","2021-02-26 22:57:00.0")
loJson.UpdateString("serviceRequestsDetails[0].closedBy","closed")
loJson.UpdateString("serviceRequestsDetails[0].closeDescription","add in action taken notes here")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("x-hotelid","{{HotelId}}")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("x-app-key","{{AppKey}}")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/fof/v0/hotels/{{HotelId}}/serviceRequests",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
    "serviceRequestsDetails": [
        {
            "serviceRequestId": {
                "type": "ServiceRequestID",
                "idContext": "OPERA",
                "id": "53437"
            },
            "hotelId": "{{HotelId}}",
            "code": "MIN",
            "status": "Closed",
            "priority": "HIGH",
            "department": {
                "code": "HSK"
            },
            "reservationIdList": [
                {
                    "type": "Reservation",
                    "id": "{{ReservationId}}"
                }
            ],
            "profileId": {
                "type": "Profile",
                "id": "{{ProfileId}}"
            },
            "guestName": "Smith, Jack,",
            "room": "{{RoomId}}",
            "functionSpaceDetails": "{{RoomId}}",
            "openDate": "2021-02-26 22:57:00.0",
            "guaranteedBy": "Ben",
            "comment": "test",
            "action": "completed",
            "guestContactMethod": "IN-ROOM MESSAGE",
            "completionDate": "2021-02-26 22:53:00.0",
            "closedDate": "2021-02-26 22:57:00.0",
            "closedBy": "closed",
            "closeDescription": "add in action taken notes here"
        }
    ]
}\'"'
https://domain.com/fof/v0/hotels/{{HotelId}}/serviceRequests

Postman Collection Item JSON

{
  "name": "Update a Service Request",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "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": "{\r\n    \"serviceRequestsDetails\": [\r\n        {\r\n            \"serviceRequestId\": {\r\n                \"type\": \"ServiceRequestID\",\r\n                \"idContext\": \"OPERA\",\r\n                \"id\": \"53437\"\r\n            },\r\n            \"hotelId\": \"{{HotelId}}\",\r\n            \"code\": \"MIN\",\r\n            \"status\": \"Closed\",\r\n            \"priority\": \"HIGH\",\r\n            \"department\": {\r\n                \"code\": \"HSK\"\r\n            },\r\n            \"reservationIdList\": [\r\n                {\r\n                    \"type\": \"Reservation\",\r\n                    \"id\": \"{{ReservationId}}\"\r\n                }\r\n            ],\r\n            \"profileId\": {\r\n                \"type\": \"Profile\",\r\n                \"id\": \"{{ProfileId}}\"\r\n            },\r\n            \"guestName\": \"Smith, Jack,\",\r\n            \"room\": \"{{RoomId}}\",\r\n            \"functionSpaceDetails\": \"{{RoomId}}\",\r\n            \"openDate\": \"2021-02-26 22:57:00.0\",\r\n            \"guaranteedBy\": \"Ben\",\r\n            \"comment\": \"test\",\r\n            \"action\": \"completed\",\r\n            \"guestContactMethod\": \"IN-ROOM MESSAGE\",\r\n            \"completionDate\": \"2021-02-26 22:53:00.0\",\r\n            \"closedDate\": \"2021-02-26 22:57:00.0\",\r\n            \"closedBy\": \"closed\",\r\n            \"closeDescription\": \"add in action taken notes here\"\r\n        }\r\n    ]\r\n}'\"",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/fof/v0/hotels/{{HotelId}}/serviceRequests",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "fof",
        "v0",
        "hotels",
        "{{HotelId}}",
        "serviceRequests"
      ],
      "query": [
        {
          "key": "profileId",
          "value": "{{ProfileId}}",
          "disabled": true
        }
      ]
    },
    "description": "Use this operation and request body to complete a service request."
  },
  "response": [
  ]
}