Chilkat Online Tools

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

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.

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

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

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

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"x-app-key","{{AppKey}}")
    CkHttp::ckSetRequestHeader(http,"x-hotelid","{{HotelId}}")
    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    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/crm/v1/profiles/{{ProfileId}}",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-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": [
  ]
}