addLeadGuestDetails
Add lead guest details
Adds or updates the lead guest details for a room stays in the cart. Also specifies the expected guest occupancy for the given room stay.
/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/leadGuest
Usage and SDK Samples
curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/occ/v2/{baseSiteId}/users/{userId}/carts/{cartId}/roomStays/{roomStayRefNumber}/leadGuest"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccommodationCartsApi;
import java.io.File;
import java.util.*;
public class AccommodationCartsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure OAuth2 access token for authorization: oauth2_Password
OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");
// Configure OAuth2 access token for authorization: oauth2_client_credentials
OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");
AccommodationCartsApi apiInstance = new AccommodationCartsApi();
LeadGuest body = ; // LeadGuest |
String baseSiteId = baseSiteId_example; // String | Base site identifier
String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
try {
'String' result = apiInstance.addLeadGuestDetails(body, baseSiteId, cartId, roomStayRefNumber, userId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccommodationCartsApi#addLeadGuestDetails");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AccommodationCartsApi;
public class AccommodationCartsApiExample {
public static void main(String[] args) {
AccommodationCartsApi apiInstance = new AccommodationCartsApi();
LeadGuest body = ; // LeadGuest |
String baseSiteId = baseSiteId_example; // String | Base site identifier
String cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
String userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
try {
'String' result = apiInstance.addLeadGuestDetails(body, baseSiteId, cartId, roomStayRefNumber, userId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccommodationCartsApi#addLeadGuestDetails");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
LeadGuest *body = ; //
String *baseSiteId = baseSiteId_example; // Base site identifier
String *cartId = cartId_example; // Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Integer *roomStayRefNumber = 56; // Room Stay unique identifier - identifies a room stay in the cart
String *userId = userId_example; // User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
AccommodationCartsApi *apiInstance = [[AccommodationCartsApi alloc] init];
// Add lead guest details
[apiInstance addLeadGuestDetailsWith:body
baseSiteId:baseSiteId
cartId:cartId
roomStayRefNumber:roomStayRefNumber
userId:userId
completionHandler: ^('String' output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var CommerceWebservices = require('commerce_webservices');
var defaultClient = CommerceWebservices.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"
// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"
var api = new CommerceWebservices.AccommodationCartsApi()
var body = ; // {{LeadGuest}}
var baseSiteId = baseSiteId_example; // {{String}} Base site identifier
var cartId = cartId_example; // {{String}} Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = 56; // {{Integer}} Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // {{String}} User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addLeadGuestDetails(bodybaseSiteIdcartIdroomStayRefNumberuserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class addLeadGuestDetailsExample
{
public void main()
{
// Configure OAuth2 access token for authorization: oauth2_Password
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new AccommodationCartsApi();
var body = new LeadGuest(); // LeadGuest |
var baseSiteId = baseSiteId_example; // String | Base site identifier
var cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
var roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
var userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
try
{
// Add lead guest details
'String' result = apiInstance.addLeadGuestDetails(body, baseSiteId, cartId, roomStayRefNumber, userId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccommodationCartsApi.addLeadGuestDetails: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$api_instance = new Swagger\Client\ApiAccommodationCartsApi();
$body = ; // LeadGuest |
$baseSiteId = baseSiteId_example; // String | Base site identifier
$cartId = cartId_example; // String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
$roomStayRefNumber = 56; // Integer | Room Stay unique identifier - identifies a room stay in the cart
$userId = userId_example; // String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
try {
$result = $api_instance->addLeadGuestDetails($body, $baseSiteId, $cartId, $roomStayRefNumber, $userId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AccommodationCartsApi->addLeadGuestDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccommodationCartsApi;
# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
my $api_instance = WWW::SwaggerClient::AccommodationCartsApi->new();
my $body = WWW::SwaggerClient::Object::LeadGuest->new(); # LeadGuest |
my $baseSiteId = baseSiteId_example; # String | Base site identifier
my $cartId = cartId_example; # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
my $roomStayRefNumber = 56; # Integer | Room Stay unique identifier - identifies a room stay in the cart
my $userId = userId_example; # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
eval {
my $result = $api_instance->addLeadGuestDetails(body => $body, baseSiteId => $baseSiteId, cartId => $cartId, roomStayRefNumber => $roomStayRefNumber, userId => $userId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AccommodationCartsApi->addLeadGuestDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccommodationCartsApi()
body = # LeadGuest |
baseSiteId = baseSiteId_example # String | Base site identifier
cartId = cartId_example # String | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
roomStayRefNumber = 56 # Integer | Room Stay unique identifier - identifies a room stay in the cart
userId = userId_example # String | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
try:
# Add lead guest details
api_response = api_instance.add_lead_guest_details(body, baseSiteId, cartId, roomStayRefNumber, userId)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccommodationCartsApi->addLeadGuestDetails: %s\n" % e)
Parameters
| Name | Description |
|---|---|
| baseSiteId* |
String
Base site identifier
Required
|
| cartId* |
String
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart
Required
|
| roomStayRefNumber* |
Integer
(int32)
Room Stay unique identifier - identifies a room stay in the cart
Required
|
| userId* |
String
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user
Required
|
| Name | Description |
|---|---|
| body * |