Chilkat Online Tools

TCL / ORACLE Hospitality OPERA Cloud REST API Workflows / Update the guest profile with new contact details

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

# The following JSON is sent in the request body.

# {
#   "profileDetails": {
#     "addresses": {
#       "addressInfo": [
#         {
#           "address": {
#             "addressLine": [
#               "2640 Golden Gate Parkway",
#               "Suite 300",
#               "",
#               ""
#             ],
#             "cityName": "Naples",
#             "postalCode": "34105",
#             "state": "FL",
#             "language": "E",
#             "type": "HOME",
#             "typeDescription": "Home Address",
#             "primaryInd": true
#           }
#         }
#       ]
#     },
#     "telephones": {
#       "telephoneInfo": [
#         {
#           "telephone": {
#             "phoneTechType": "PHONE",
#             "phoneUseType": "MOBILE",
#             "phoneUseTypeDescription": "Mobile Phone Number",
#             "phoneNumber": "+1 415 555 0101",
#             "primaryInd": true,
#             "orderSequence": "1"
#           }
#         }
#       ]
#     },
#     "statusCode": "ACTIVE",
#     "markForHistory": false,
#     "hasCommission": false
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.addressLine[0]" "2640 Golden Gate Parkway"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.addressLine[1]" "Suite 300"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.addressLine[2]" ""
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.addressLine[3]" ""
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.cityName" "Naples"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.postalCode" "34105"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.state" "FL"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.language" "E"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.type" "HOME"
CkJsonObject_UpdateString $json "profileDetails.addresses.addressInfo[0].address.typeDescription" "Home Address"
CkJsonObject_UpdateBool $json "profileDetails.addresses.addressInfo[0].address.primaryInd" 1
CkJsonObject_UpdateString $json "profileDetails.telephones.telephoneInfo[0].telephone.phoneTechType" "PHONE"
CkJsonObject_UpdateString $json "profileDetails.telephones.telephoneInfo[0].telephone.phoneUseType" "MOBILE"
CkJsonObject_UpdateString $json "profileDetails.telephones.telephoneInfo[0].telephone.phoneUseTypeDescription" "Mobile Phone Number"
CkJsonObject_UpdateString $json "profileDetails.telephones.telephoneInfo[0].telephone.phoneNumber" "+1 415 555 0101"
CkJsonObject_UpdateBool $json "profileDetails.telephones.telephoneInfo[0].telephone.primaryInd" 1
CkJsonObject_UpdateString $json "profileDetails.telephones.telephoneInfo[0].telephone.orderSequence" "1"
CkJsonObject_UpdateString $json "profileDetails.statusCode" "ACTIVE"
CkJsonObject_UpdateBool $json "profileDetails.markForHistory" 0
CkJsonObject_UpdateBool $json "profileDetails.hasCommission" 0

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-app-key" "{{AppKey}}"
CkHttp_SetRequestHeader $http "x-hotelid" "{{HotelId}}"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/crm/v1/profiles/{{ProfileId}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-app-key: {{AppKey}}"
	-H "x-hotelid: {{HotelId}}"
	-d '{
  "profileDetails": {
    "addresses": {
      "addressInfo": [
        {
          "address": {
            "addressLine": [
              "2640 Golden Gate Parkway",
              "Suite 300",
              "",
              ""
            ],
            "cityName": "Naples",
            "postalCode": "34105",
            "state": "FL",
            "language": "E",
            "type": "HOME",
            "typeDescription": "Home Address",
            "primaryInd": true
          }
        }
      ]
    },
    "telephones": {
      "telephoneInfo": [
        {
          "telephone": {
            "phoneTechType": "PHONE",
            "phoneUseType": "MOBILE",
            "phoneUseTypeDescription": "Mobile Phone Number",
            "phoneNumber": "+1 415 555 0101",
            "primaryInd": true,
            "orderSequence": "1"
          }
        }
      ]
    },
    "statusCode": "ACTIVE",
    "markForHistory": false,
    "hasCommission": false
  }
}'
https://domain.com/crm/v1/profiles/{{ProfileId}}

Postman Collection Item JSON

{
  "name": "Update the guest profile with new contact details",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      },
      {
        "key": "x-hotelid",
        "value": "{{HotelId}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"profileDetails\": {\n    \"addresses\": {\n      \"addressInfo\": [\n        {\n          \"address\": {\n            \"addressLine\": [\n              \"2640 Golden Gate Parkway\",\n              \"Suite 300\",\n              \"\",\n              \"\"\n            ],\n            \"cityName\": \"Naples\",\n            \"postalCode\": \"34105\",\n            \"state\": \"FL\",\n            \"language\": \"E\",\n            \"type\": \"HOME\",\n            \"typeDescription\": \"Home Address\",\n            \"primaryInd\": true\n          }\n        }\n      ]\n    },\n    \"telephones\": {\n      \"telephoneInfo\": [\n        {\n          \"telephone\": {\n            \"phoneTechType\": \"PHONE\",\n            \"phoneUseType\": \"MOBILE\",\n            \"phoneUseTypeDescription\": \"Mobile Phone Number\",\n            \"phoneNumber\": \"+1 415 555 0101\",\n            \"primaryInd\": true,\n            \"orderSequence\": \"1\"\n          }\n        }\n      ]\n    },\n    \"statusCode\": \"ACTIVE\",\n    \"markForHistory\": false,\n    \"hasCommission\": false\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/crm/v1/profiles/{{ProfileId}}",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "crm",
        "v1",
        "profiles",
        "{{ProfileId}}"
      ]
    }
  },
  "response": [
  ]
}