Chilkat Online Tools

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

Back to Collection Items

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

    ; 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"
    ;     }
    ;   ]
    ; }

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

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

    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}}")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/fof/v0/hotels/{{HotelId}}/serviceRequests",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

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



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}