Chilkat Online Tools

TCL / ORACLE Hospitality OPERA Cloud REST API Workflows / Search for a guest profile

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]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "profileName" "Smith"
CkJsonObject_UpdateString $queryParams "profileType" "Guest"
CkJsonObject_UpdateString $queryParams "summaryInfo" "true"
CkJsonObject_UpdateString $queryParams "searchType" "Any"
CkJsonObject_UpdateString $queryParams "fetchInstructions" "Comment"

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

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/crm/v0/profiles" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

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


delete_CkHttp $http
delete_CkJsonObject $queryParams

Curl Command

curl -G -d "profileName=Smith"
	-d "profileType=Guest"
	-d "summaryInfo=true"
	-d "searchType=Any"
	-d "fetchInstructions=Comment"
	-H "Authorization: Bearer <access_token>"
	-H "x-app-key: {{AppKey}}"
	-H "x-hotelid: {{HotelId}}"
https://domain.com/crm/v0/profiles

Postman Collection Item JSON

{
  "name": "Search for a guest profile",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "x-app-key",
        "type": "text",
        "value": "{{AppKey}}"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      }
    ],
    "url": {
      "raw": "{{HostName}}/crm/v0/profiles?profileName=Smith&profileType=Guest&summaryInfo=true&searchType=Any&fetchInstructions=Comment",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "crm",
        "v0",
        "profiles"
      ],
      "query": [
        {
          "key": "profileName",
          "value": "Smith"
        },
        {
          "key": "givenName",
          "value": "Kate",
          "disabled": true
        },
        {
          "key": "profileType",
          "value": "Guest"
        },
        {
          "key": "summaryInfo",
          "value": "true"
        },
        {
          "key": "hotelId",
          "value": "",
          "disabled": true
        },
        {
          "key": "limit",
          "value": "3",
          "disabled": true
        },
        {
          "key": "city",
          "value": "",
          "disabled": true
        },
        {
          "key": "state",
          "value": "",
          "disabled": true
        },
        {
          "key": "postalCode",
          "value": "",
          "disabled": true
        },
        {
          "key": "communication",
          "value": "",
          "disabled": true
        },
        {
          "key": "membership",
          "value": "",
          "description": "membership number",
          "disabled": true
        },
        {
          "key": "searchType",
          "value": "Any"
        },
        {
          "key": "fetchInstructions",
          "value": "Comment"
        },
        {
          "key": "fetchInstructions",
          "value": "Address",
          "disabled": true
        }
      ]
    }
  },
  "response": [
  ]
}