Chilkat Online Tools

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

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("profileName","Smith")
queryParams.UpdateString("profileType","Guest")
queryParams.UpdateString("summaryInfo","true")
queryParams.UpdateString("searchType","Any")
queryParams.UpdateString("fetchInstructions","Comment")

http.SetRequestHeader("x-app-key","{{AppKey}}")
http.SetRequestHeader("x-hotelid","{{HotelId}}")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/crm/v0/profiles",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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