Use Cases

Request Parameters

Parameter	Description	Type
channel	SynXis CR booking channel code (used for content customization).	String
contactlastname	Last name of the group contact (use % for wildcards).	String
pageStart	Starting record to be returned in the response (used to retrieve data in smaller sets).	Integer
pageSize	Number of records to be returned in the response (0 = return all).	Integer
productAllocationBlockDates	Product Allocation block dates used to filter the results. If blank, the search will include all dates. Values are start and end dates delimited by a semi-colon (;).	String
priceSeasonDates	Price Season dates used to filter the results. If blank, the search will include all dates. Values are start and end dates delimited by a semi-colon (;).	String
status	Status of the group. Values: Cancel, CheckedIn, CheckedOut, Closed, Confirmed, MeetingRoom, Tentative	String
View	Specifies what additional information to include in the response. Values: Default, CancelPolicySeasons, ChannelAssignmentInfo, CommissionInfo, CompanyProfile, ContactInfo, Full, GroupAdminInfo, MarketAssignments, MealPlan, PackageAssignments, PolicyInfo, PriceSeasons, TaxAssignment	String

Response

Basic Information

{
    "groups": [{
        "id": "7914095e-2d2b-4642-aeb7-3d8547d61334",
        "code": "grpRt",
        "pmsCode": "ADV1",
        "pmsGroupCode": "SMITHWED",
        "name": "Smith Wedding",
        "alias": "SmithWedding",
        "isActive": true,
        "isSuppressed": false,
        "isCommissionable": false,
        "ExcludedFromAvailabilityRatesAndInventoryPush": true,
        "ControlledLocally": false,
        "PricingUpdatesRestricted": true,
        "descriptions": {
            "shortDescription": "Wedding party.",
            "longDescription": "If group book is used, call meeting organizer Mr. Amorim 555 634 8146."
        },
        "status": "Tentative",
        "specialInstructions": "Group would like all rooms on the same floor.",
        "externalCateringCode": "ExtCD1",
        "hotel": {
            "id": 13098,
            "code": "HOP",
            "name": "SynXis Hotel"
        }
    }]
}

Booking Method

{
    "groups": [{
        "bookingMethod": {
            "code": "WEB",
            "name": "Booking Engine"
        }
    }]
}

Cancel Reason

{
    "groups": [{
        "cancelReason": {
            "code": "CXLOne"
        }
    }]
}

Company

Use view=CompanyProfile or view=Full to return Company Profile information for the group

/v1/api/hotel/{id}/groups?view=CompanyProfile

{
    "groups": [{
        "company": {
            "code": "66578",
            "name": "Some Hotel Company",
            "chain": {
                "Id": 15458
            }
        }
    }]
}

Contact Information

Use view=ContactInfo, view=Default or view=Full to return Contact information for the group

/v1/api/hotel/{id}/groups?view=ContactInfo

{
    "groups": [{
        "contactInfo": {
            "title": "Mr.",
            "firstname": "Larry",
            "middleInitial": "A",
            "lastname": "Walker",
            "address": {
                "id": "C6E50D08-38BD-45CD-A201-C3C9B10B70BD",
                "name": "My Business Address",
                "addressLine": ["123 Main St."],
                "city": "Denver",
                "state": "CO",
                "countryCode": "US",
                "postalCode": "70045"
            },
            "emailAddress": "larry.walker@email.com",
            "contactNumbers": [{
                "Number": "55512345678",
                "Type": "Mobile"
            }],
            "url": "SomeGroupSite.com"
        }
    }]
}

Group Portal

Use view=GroupAdminInfo or view=Full to return the credentials for the Group Rooming Portal

/v1/api/hotel/{id}/groups?view=GroupAdminInfo

{
    "groups": [{
        "AdminCredential": {
            "Password": "Abcd1234!"
        }
    }]
}

Individual Payment

{
    "groups": [{
        "IndividualPayment": {
            "type": "GroupPaysAll"
        }
    }]
}

Market Assignments

Use view=MarketAssignments or view=Full to return the Market Segment and Market Source for the group.

/v1/api/hotel/{id}/groups?view=MarketAssignments

{
    "groups": [{
        "marketSegment": {
            "code": "LEISURE"
        },
        "marketSource": {
            "code": "REFERRAL"
        }       
    }]
}

Packages

Use view=PackageAssignments or view=Full to return the Packages assigned to the group.

/v1/api/hotel/{id}/groups?view=PackageAssignments

{
    "groups": [{
        "packages": [{
            "code": "CHAM",
            "name": "Champagne"
        {
            "code": "LIMO",
            "name": "Limo Service"      
        }]
    }]
}

Pagination

{
    "groups": [{...}],
    "pagination": {
        "size": 50,
        "start": 0,
        "total": 146
    }
}

Payment Method

{
    "groups": [{
        "paymentMethod": {
            "type": "Cash"
        }
    }]
}

Policies

Use view=PolicyInfo or view=Full to return Policy information for the group

/v1/api/hotel/{id}/groups?view=PolicyInfo

{
    "groups": [{
        "bookingPolicy": {
            "code": "GUA",
            "description": "A valid credit card is required to guarantee the reservation",
            "holdTime": "string",
            "depositFee": {
                "amount": 40,
                "dueDays": 0,
                "dueType": "AtTimeOfBooking",
                "isPrePayment": false,
                "taxInclusive": false,
                "type": "LocalCurrency"
            }
        },
        "cancelPolicy": {
            "Code": "1D",
            "Description": "Booking must be cancelled 1 day prior to arrival local time to avoid charges",
            "NoShow": {
                "Amount": 150,
                "type": "NumberNightsOfStay",
                "TaxInclusive": true
            }
        }       
    }]
}

Request @description in a specified language.

Note: Use Accept-Language and channel to return language specific content (i.e. Accept-Language=de, channel=WEB)

{
    "groups": [{
        "bookingPolicy": {
            "code": "GUA",
            "description": "Eine gültige Kreditkarte ist erforderlich, um die Reservierung zu garantieren",
            "holdTime": "string",
            "depositFee": {
                "amount": 40,
                "dueDays": 0,
                "dueType": "AtTimeOfBooking",
                "isPrePayment": false,
                "taxInclusive": false,
                "type": "LocalCurrency"
            }
        },
        "cancelPolicy": {
            "Code": "1D",
            "Description": "Die Buchung muss 1 Tag vor Ortszeit der Ankunft storniert werden, um Gebühren zu vermeiden",
            "NoShow": {
                "Amount": 150,
                "type": "NumberNightsOfStay",
                "TaxInclusive": true
            }
        }       
    }]
}

Products

Use view=PriceSeasons or view=Full to return Product and Price Season information for the group

/v1/api/hotel/{id}/groups?view=PriceSeasons

{
    "groups": [{
        "products": [{
            "room": {
                "code": "HCP",
                "name": "Accessible Room Two Queen Beds"
            },
            "priceseasons": [{
                "name": "Winter_Override",
                "startdate": "2020-10-01T00:00:00",
                "enddate": "2020-12-31T00:00:00",
                "basePrice": 300,
                "isTaxInclusive": false,
                "productallocation": [{
                    "date": "2020-09-22",
                    "available": 8,
                    "committed": 10,
                    "sold": 2,
                    "sellLimit": 15,
                    "total": 20
                }],
                "offsets": {
                    "shoulderPrice": [{
                        "type": "PreStay",
                        "days": 3,
                        "amount": {
                            "value": 25,
                            "type": "Whole"
                        }
                    }]
                },
                "cutoff": {
                    "type": "Days",
                    "days": 1,
                    "date": "2019-12-30T00:00:00"
                }
            }]
        }]
    }]
}

Routing List

{
    "groups": [{
        "routingList": [{
            "code": "ABA",
            "folioNumber": "01"
        }]
    }]
}

Sales Manager

{
    "groups": [{
        "salesManager": {
            "emailAddress": "larry.walker@email.com",
            "firstName": "Larry",
            "lastName": "Walker",
            "middleInitial": "A",
            "title": "Mr.",
            "contactNumbers": [{
                "Number": "55512345678",
                "Type": "Mobile"
            }]
        }
    }]
}

Taxes

Use view=TaxAssignment or view=Full to return Tax information for the group

/v1/api/hotel/{id}/groups?view=TaxAssignment

{
    "groups": [{
        "TaxList": [{
            "Code": "TX10"
        }]
    }]
}

Travel Agent

Use view=CommissionInfo or view=Full to return Travel Agency and Commission information for the group

/v1/api/hotel/{id}/groups?view=CommissionInfo

{
    "groups": [{
        "travelAgent": {
            "iataNumber": "05620860",
            "commissionPercentage": 0.1
        }
    }]
}