Chilkat Online Tools

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

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

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

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-app-key', '{{AppKey}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-hotelid', '{{HotelId}}'
    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

    DECLARE @sbRequestBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/crm/v1/profiles/{{ProfileId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

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