Chilkat Online Tools

Objective-C / ORACLE Hospitality OPERA Cloud REST API Workflows / Search for a guest profile

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"profileName" value: @"Smith"];
[queryParams UpdateString: @"profileType" value: @"Guest"];
[queryParams UpdateString: @"summaryInfo" value: @"true"];
[queryParams UpdateString: @"searchType" value: @"Any"];
[queryParams UpdateString: @"fetchInstructions" value: @"Comment"];

[http SetRequestHeader: @"x-app-key" value: @"{{AppKey}}"];
[http SetRequestHeader: @"x-hotelid" value: @"{{HotelId}}"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/crm/v0/profiles" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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