Chilkat Online Tools

autoit / ORACLE Hospitality OPERA Cloud REST API Workflows / Create New Profile If one doesn't exist

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

; 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": {
;     "customer": {
;       "personName": [
;         {
;           "givenName": "James",
;           "surname": "Smith",
;           "nameType": "Primary"
;         },
;         {
;           "nameType": "Alternate"
;         },
;         {
;           "nameType": "Incognito"
;         }
;       ],
;       "alienInfo": {},
;       "birthCountry": {
;         "code": ""
;       },
;       "language": "E"
;     },
;     "addresses": {
;       "addressInfo": [
;         {
;           "address": {
;             "isValidated": false,
;             "addressLine": [
;               "3450 North Triumph Boulevard",
;               "Suite 300",
;               "",
;               ""
;             ],
;             "cityName": "Lehi",
;             "postalCode": "84043",
;             "state": "UT",
;             "country": {
;               "value": "US"
;             },
;             "language": "E",
;             "type": "BUSINESS",
;             "primaryInd": true
;           }
;         }
;       ]
;     },
;     "telephones": {
;       "telephoneInfo": [
;         {
;           "telephone": {
;             "phoneTechType": "PHONE",
;             "phoneUseType": "HOME",
;             "phoneNumber": "+1 385 555 0102",
;             "orderSequence": "1",
;             "primaryInd": true
;           }
;         }
;       ]
;     },
;     "mailingActions": {
;       "active": true
;     },
;     "privacyInfo": {
;       "marketResearchParticipation": true,
;       "infoFromThirdParty": true,
;       "autoEnrollLoyaltyProgram": false,
;       "allowPhone": true,
;       "allowSMS": true,
;       "allowEmail": true,
;       "optInMailingList": true,
;       "optInMarketResearch": true,
;       "optInThirdParty": true,
;       "optInAutoEnrollmentMember": true,
;       "optInPhone": true,
;       "optInSms": true,
;       "optInEmail": true
;     },
;     "taxInfo": {},
;     "statusCode": "Active",
;     "requestForHotel": "{{HotelId}}",
;     "markAsRecentlyAccessed": true,
;     "profileType": "Guest"
;   },
;   "profileIdList": [
;   ]
; }

$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("profileDetails.customer.personName[0].givenName","James")
$oJson.UpdateString("profileDetails.customer.personName[0].surname","Smith")
$oJson.UpdateString("profileDetails.customer.personName[0].nameType","Primary")
$oJson.UpdateString("profileDetails.customer.personName[1].nameType","Alternate")
$oJson.UpdateString("profileDetails.customer.personName[2].nameType","Incognito")
$oJson.UpdateNewObject("profileDetails.customer.alienInfo")
$oJson.UpdateString("profileDetails.customer.birthCountry.code","")
$oJson.UpdateString("profileDetails.customer.language","E")
$oJson.UpdateBool("profileDetails.addresses.addressInfo[0].address.isValidated",False)
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[0]","3450 North Triumph Boulevard")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[1]","Suite 300")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[2]","")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.addressLine[3]","")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.cityName","Lehi")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.postalCode","84043")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.state","UT")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.country.value","US")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.language","E")
$oJson.UpdateString("profileDetails.addresses.addressInfo[0].address.type","BUSINESS")
$oJson.UpdateBool("profileDetails.addresses.addressInfo[0].address.primaryInd",True)
$oJson.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.phoneTechType","PHONE")
$oJson.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.phoneUseType","HOME")
$oJson.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.phoneNumber","+1 385 555 0102")
$oJson.UpdateString("profileDetails.telephones.telephoneInfo[0].telephone.orderSequence","1")
$oJson.UpdateBool("profileDetails.telephones.telephoneInfo[0].telephone.primaryInd",True)
$oJson.UpdateBool("profileDetails.mailingActions.active",True)
$oJson.UpdateBool("profileDetails.privacyInfo.marketResearchParticipation",True)
$oJson.UpdateBool("profileDetails.privacyInfo.infoFromThirdParty",True)
$oJson.UpdateBool("profileDetails.privacyInfo.autoEnrollLoyaltyProgram",False)
$oJson.UpdateBool("profileDetails.privacyInfo.allowPhone",True)
$oJson.UpdateBool("profileDetails.privacyInfo.allowSMS",True)
$oJson.UpdateBool("profileDetails.privacyInfo.allowEmail",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInMailingList",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInMarketResearch",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInThirdParty",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInAutoEnrollmentMember",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInPhone",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInSms",True)
$oJson.UpdateBool("profileDetails.privacyInfo.optInEmail",True)
$oJson.UpdateNewObject("profileDetails.taxInfo")
$oJson.UpdateString("profileDetails.statusCode","Active")
$oJson.UpdateString("profileDetails.requestForHotel","{{HotelId}}")
$oJson.UpdateBool("profileDetails.markAsRecentlyAccessed",True)
$oJson.UpdateString("profileDetails.profileType","Guest")
$oJson.UpdateNewArray("profileIdList")

$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "x-app-key","{{AppKey}}"
$oHttp.SetRequestHeader "x-hotelid","{{HotelId}}"
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

Local $oResp = $oHttp.PostJson3("https://domain.com/crm/v1/profiles","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-app-key: {{AppKey}}"
	-H "x-hotelid: {{HotelId}}"
	-d '{
    "profileDetails": {
        "customer": {
            "personName": [
                {
                    "givenName": "James",
                    "surname": "Smith",
                    "nameType": "Primary"
                },
                {
                    "nameType": "Alternate"
                },
                {
                    "nameType": "Incognito"
                }
            ],
            "alienInfo": {},
            "birthCountry": {
                "code": ""
            },
            "language": "E"
        },
        "addresses": {
            "addressInfo": [
                {
                    "address": {
                        "isValidated": false,
                        "addressLine": [
                            "3450 North Triumph Boulevard",
                            "Suite 300",
                            "",
                            ""
                        ],
                        "cityName": "Lehi",
                        "postalCode": "84043",
                        "state": "UT",
                        "country": {
                            "value": "US"
                        },
                        "language": "E",
                        "type": "BUSINESS",
                        "primaryInd": true
                    }
                }
            ]
        },
        "telephones": {
            "telephoneInfo": [
                {
                    "telephone": {
                        "phoneTechType": "PHONE",
                        "phoneUseType": "HOME",
                        "phoneNumber": "+1 385 555 0102",
                        "orderSequence": "1",
                        "primaryInd": true
                    }
                }
            ]
        },
        "mailingActions": {
            "active": true
        },
        "privacyInfo": {
            "marketResearchParticipation": true,
            "infoFromThirdParty": true,
            "autoEnrollLoyaltyProgram": false,
            "allowPhone": true,
            "allowSMS": true,
            "allowEmail": true,
            "optInMailingList": true,
            "optInMarketResearch": true,
            "optInThirdParty": true,
            "optInAutoEnrollmentMember": true,
            "optInPhone": true,
            "optInSms": true,
            "optInEmail": true
        },
        "taxInfo": {},
        "statusCode": "Active",
        "requestForHotel": "{{HotelId}}",
        "markAsRecentlyAccessed": true,
        "profileType": "Guest"
    },
    "profileIdList": []
}'
https://domain.com/crm/v1/profiles

Postman Collection Item JSON

{
  "name": "Create New Profile If one doesn't exist",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var data = pm.response.headers.get(\"Location\").split(\"/\").pop();\r",
          "postman.setEnvironmentVariable(\"ProfileId\", data);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"profileDetails\": {\n        \"customer\": {\n            \"personName\": [\n                {\n                    \"givenName\": \"James\",\n                    \"surname\": \"Smith\",\n                    \"nameType\": \"Primary\"\n                },\n                {\n                    \"nameType\": \"Alternate\"\n                },\n                {\n                    \"nameType\": \"Incognito\"\n                }\n            ],\n            \"alienInfo\": {},\n            \"birthCountry\": {\n                \"code\": \"\"\n            },\n            \"language\": \"E\"\n        },\n        \"addresses\": {\n            \"addressInfo\": [\n                {\n                    \"address\": {\n                        \"isValidated\": false,\n                        \"addressLine\": [\n                            \"3450 North Triumph Boulevard\",\n                            \"Suite 300\",\n                            \"\",\n                            \"\"\n                        ],\n                        \"cityName\": \"Lehi\",\n                        \"postalCode\": \"84043\",\n                        \"state\": \"UT\",\n                        \"country\": {\n                            \"value\": \"US\"\n                        },\n                        \"language\": \"E\",\n                        \"type\": \"BUSINESS\",\n                        \"primaryInd\": true\n                    }\n                }\n            ]\n        },\n        \"telephones\": {\n            \"telephoneInfo\": [\n                {\n                    \"telephone\": {\n                        \"phoneTechType\": \"PHONE\",\n                        \"phoneUseType\": \"HOME\",\n                        \"phoneNumber\": \"+1 385 555 0102\",\n                        \"orderSequence\": \"1\",\n                        \"primaryInd\": true\n                    }\n                }\n            ]\n        },\n        \"mailingActions\": {\n            \"active\": true\n        },\n        \"privacyInfo\": {\n            \"marketResearchParticipation\": true,\n            \"infoFromThirdParty\": true,\n            \"autoEnrollLoyaltyProgram\": false,\n            \"allowPhone\": true,\n            \"allowSMS\": true,\n            \"allowEmail\": true,\n            \"optInMailingList\": true,\n            \"optInMarketResearch\": true,\n            \"optInThirdParty\": true,\n            \"optInAutoEnrollmentMember\": true,\n            \"optInPhone\": true,\n            \"optInSms\": true,\n            \"optInEmail\": true\n        },\n        \"taxInfo\": {},\n        \"statusCode\": \"Active\",\n        \"requestForHotel\": \"{{HotelId}}\",\n        \"markAsRecentlyAccessed\": true,\n        \"profileType\": \"Guest\"\n    },\n    \"profileIdList\": []\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/crm/v1/profiles",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "crm",
        "v1",
        "profiles"
      ]
    }
  },
  "response": [
  ]
}