Chilkat Online Tools

Objective-C / ORACLE Hospitality OPERA Cloud REST API Workflows / Update a Service Request

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

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

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"x-hotelid" value: @"{{HotelId}}"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"x-app-key" value: @"{{AppKey}}"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://domain.com/fof/v0/hotels/{{HotelId}}/serviceRequests" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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