DC Reservation

Read Information For a Reservation

Retrieve all room stays on current or future reservations.

Authentication type: Application & Application User

GET https://kapip-s.hilton.io/hospitality-partner/v2/dcres/{confNumber}

confNumber required Confirmation Number string

Responses

200 Success < DcReservationStay-DcRes > array
403 Forbidden No Content
404 Record not found No Content

Example Request

https://kapip-s.hilton.io/hospitality-partner/v2/dcres/{confNumber}

Example Response

[ {
  "confNumber" : "string",
  "ratePlan" : {
    "ratePlanName" : "string",
    "serviceChargesAndTaxesIncluded" : true,
    "promoCode" : "string",
    "advancePurchase" : true,
    "ratePlanCode" : "string"
  },
  "travelPartners" : [ {
    "partnerNumber" : "string",
    "partnerCode" : "string",
    "partnerType" : {
      "description" : "Travel partner type (air)."
    }
  } ],
  "numRollAways" : 0,
  "guarantee" : {
    "paymentCard" : {
      "cardHolderState" : "string",
      "cardHolderName" : "string",
      "cardHolderCountry" : "string",
      "secureCustomerAuthenticationInfo" : {
        "cavv" : "string",
        "cavvAlgorithm" : "string",
        "threeDAuthenticatedResponse" : "string",
        "networkTxnRefTraceId" : "string",
        "eCommerceIndicator" : "string",
        "threeDOfferedResponse" : "string",
        "threeDSVersion" : "string",
        "transactionId" : "string"
      },
      "cardCode" : "string",
      "postalCode" : "string",
      "cardExpireDate" : "string",
      "cardHolderAddress" : "string",
      "cardPaymentType" : {
        "description" : "Indicates type of card payment."
      },
      "cardHolderCity" : "string",
      "cardNumber" : "string"
    },
    "cxlPolicyCode" : "string",
    "guarPolicyCode" : "string",
    "cxlPolicyLocalDeadline" : "string",
    "cxlPolicyDesc" : "string",
    "guarMethodDesc" : "string",
    "guarPolicyDesc" : "string",
    "deposit" : {
      "amount" : 0.0,
      "dueDate" : "string",
      "currencyCode" : "string"
    },
    "guarMethodCode" : "string",
    "cxlPolicyDeadline" : "string"
  },
  "requests" : {
    "requestText" : "string",
    "requestCodes" : [ {
      "description" : "The room amenities array, this identifies room amenity request for the reservation.\n"
    } ]
  },
  "propCode" : "string",
  "externalResId" : "string",
  "resCreateDate" : "string",
  "numChildren" : 0,
  "lastResModifyDate" : "string",
  "gnrNumber" : 0,
  "commission" : {
    "amount" : 0.0,
    "payTo" : {
      "description" : "Who to pay the commission to: Corp, Travel, No one"
    },
    "type" : {
      "description" : "Type of commission"
    },
    "centralPay" : true
  },
  "departureDate" : "string",
  "ageBasedPricing" : true,
  "childAges" : [ 0 ],
  "resStatus" : {
    "description" : "CRS Reservation Status"
  },
  "additionalNames" : [ {
    "firstName" : "string",
    "lastName" : "string",
    "title" : "string",
    "middleInit" : "string"
  } ],
  "roomType" : {
    "roomTypeCode" : "string",
    "roomTypeDesc" : [ "string" ],
    "smokingRoom" : true,
    "extraBedPermitted" : true,
    "roomOccupancy" : 0
  },
  "numRooms" : 0,
  "cxlNumber" : "string",
  "cost" : {
    "averageRate" : 0.0,
    "amountBeforeTax" : 0.0,
    "chargeTotals" : [ {
      "total" : 0.0,
      "category" : "string"
    } ],
    "totalTaxes" : 0.0,
    "averageRateAfterFees" : 0.0,
    "averageRateAfterTax" : 0.0,
    "amountAfterTax" : 0.0,
    "rateDetails" : [ {
      "serviceCharges" : [ {
        "period" : {
          "description" : "Period Type."
        },
        "amount" : 0.0,
        "type" : {
          "description" : "Service Charge Type"
        },
        "basis" : {
          "description" : "Basis Type."
        }
      } ],
      "rate3Person" : 0.0,
      "rate2Person" : 0.0,
      "rollawayRate" : 0.0,
      "discountAmount" : 0.0,
      "taxes" : [ {
        "period" : {
          "description" : "Period Type."
        },
        "amount" : 0.0,
        "type" : {
          "description" : "(percent) = Percentage of tax basis, (flat) = Flat Change, (sum) = % of sum of tax basis and prior tax."
        },
        "basis" : {
          "description" : "Basis Type."
        }
      } ],
      "extraPersonRate" : 0.0,
      "chargeDetails" : [ {
        "amountType" : {
          "description" : "The type of Charge rule amount that can be setup."
        },
        "inclusive" : true,
        "amount" : 0.0,
        "period" : {
          "description" : "Period Type."
        },
        "accountingCode" : "string",
        "includedInQuotedRate" : true,
        "basis" : {
          "description" : "Options that are part of the application criteria for a charge rule"
        },
        "collectedOnProperty" : true,
        "sequence" : 0,
        "total" : 0.0,
        "appliedToRuleId" : 0,
        "name" : "string",
        "ruleId" : 0,
        "category" : "string",
        "overrideRuleId" : 0
      } ],
      "roomRate" : 0.0,
      "childRates" : [ 0.0 ],
      "extraChildRate" : 0.0,
      "rate1Person" : 0.0,
      "rate4Person" : 0.0,
      "discountType" : {
        "typeRef" : "string"
      },
      "cribRate" : 0.0,
      "effectiveDate" : "string"
    } ],
    "serviceChargesInTaxCalc" : true,
    "totalServiceCharges" : 0.0,
    "amountWithFees" : 0.0,
    "guestTotalCostAfterTax" : 0.0,
    "currencyCode" : "string",
    "serviceChargeDesc" : "string",
    "meals" : {
      "lunch" : true,
      "mealPlanDesc" : "string",
      "breakfast" : true,
      "dinner" : true,
      "mealPlan" : "string"
    }
  },
  "comments" : [ "string" ],
  "numAdults" : 0,
  "numCribs" : 0,
  "secondaryGdsCode" : "string",
  "adultAge" : 0,
  "primaryGdsCode" : "string",
  "arrivalDate" : "string",
  "childAgeRanges" : [ {
    "endChildAge" : 0,
    "startChildAge" : 0
  } ],
  "guest" : {
    "emails" : [ {
      "emailAddress" : "string",
      "emailType" : {
        "description" : "home/business/travel/other"
      }
    } ],
    "addresses" : [ {
      "country" : "string",
      "city" : "string",
      "addressType" : {
        "description" : "home/business/travel"
      },
      "postalCode" : "string",
      "addressLine1" : "string",
      "addressLine2" : "string",
      "company" : "string",
      "addressLine3" : "string",
      "state" : "string",
      "addressLine4" : "string"
    } ],
    "name" : {
      "firstName" : "string",
      "lastName" : "string",
      "title" : "string",
      "middleInit" : "string"
    },
    "phones" : [ {
      "phoneType" : {
        "description" : "home/business/mobile/fax/travel"
      },
      "phoneNumber" : "string",
      "phoneExtension" : "string"
    } ],
    "honorsNumber" : "string"
  },
  "bookingCode" : "string",
  "clientAccounts" : [ {
    "clientId" : "string",
    "clientType" : {
      "description" : "Client Type (corporate, travelAgent)."
    },
    "clientName" : "string"
  } ],
  "gdsChainCode" : "string"
} ]

confNumberpath
Type: string
Description: Confirmation Number
Hide Response

Create a Reservation

Create a new reservation at a selected property

Authentication type: Application & Application User

POST https://kapip-s.hilton.io/hospitality-partner/v2/dcres

reservation required DcReservation-DcRes
Hilton-Inventory-Hold optional Indicates desire to hold booking inventory in an unconfirmed state until confirm or release request is received. Available only to authorized channels. boolean

Responses

200 Success
Headers :
Hilton-Crs-SessionId (string(uuid)) : Crs session GUID.
< DcReservationStay-DcRes > array
400 Bad Request ErrorDetail-DcRes
403 Forbidden No Content

Example Request

https://kapip-s.hilton.io/hospitality-partner/v2/dcres
{
  "sendConfirmation" : true,
  "pseudoCityCode" : "string",
  "comments" : [ "string" ],
  "travelPartners" : [ {
    "partnerNumber" : "string",
    "partnerCode" : "string",
    "partnerType" : {
      "description" : "Travel partner type (air)."
    }
  } ],
  "roomStays" : [ {
    "roomTypeCode" : "string",
    "numAdults" : 0,
    "numCribs" : 0,
    "smokingRoom" : true,
    "rateOverrides" : [ {
      "amount" : 0.0,
      "effectiveDate" : "string"
    } ],
    "numRollAways" : 0,
    "advancePurchase" : true,
    "ratePlanCode" : "string",
    "arrivalDate" : "string",
    "numChildren" : 0,
    "promoCode" : "string",
    "departureDate" : "string",
    "bookingCode" : "string",
    "childAges" : [ 0 ]
  } ],
  "secondaryGdsCode" : "string",
  "guarantee" : {
    "paymentCard" : {
      "cardHolderState" : "string",
      "cardHolderName" : "string",
      "cardHolderCountry" : "string",
      "secureCustomerAuthenticationInfo" : {
        "cavv" : "string",
        "cavvAlgorithm" : "string",
        "threeDAuthenticatedResponse" : "string",
        "networkTxnRefTraceId" : "string",
        "eCommerceIndicator" : "string",
        "threeDOfferedResponse" : "string",
        "threeDSVersion" : "string",
        "transactionId" : "string"
      },
      "cardCode" : "string",
      "postalCode" : "string",
      "cardExpireDate" : "string",
      "cardHolderAddress" : "string",
      "cardPaymentType" : {
        "description" : "Indicates type of card payment."
      },
      "cardHolderCity" : "string",
      "cardNumber" : "string"
    },
    "deposit" : {
      "amount" : 0.0,
      "dueDate" : "string"
    },
    "guarMethodCode" : "string"
  },
  "requests" : {
    "requestText" : "string",
    "requestCodes" : [ {
      "description" : "The room amenities array, this identifies room amenity request for the reservation.\n"
    } ]
  },
  "primaryGdsCode" : "string",
  "languageCode" : "string",
  "propCode" : "string",
  "externalResId" : "string",
  "guest" : {
    "emails" : [ {
      "emailAddress" : "string",
      "emailType" : {
        "description" : "home/business/travel/other"
      }
    } ],
    "addresses" : [ {
      "country" : "string",
      "city" : "string",
      "addressType" : {
        "description" : "home/business/travel"
      },
      "postalCode" : "string",
      "addressLine1" : "string",
      "addressLine2" : "string",
      "company" : "string",
      "addressLine3" : "string",
      "state" : "string",
      "addressLine4" : "string"
    } ],
    "name" : {
      "firstName" : "string",
      "lastName" : "string",
      "title" : "string",
      "middleInit" : "string"
    },
    "phones" : [ {
      "phoneType" : {
        "description" : "home/business/mobile/fax/travel"
      },
      "phoneNumber" : "string",
      "phoneExtension" : "string"
    } ],
    "honorsNumber" : "string"
  },
  "clientAccounts" : [ {
    "clientId" : "string",
    "clientType" : {
      "description" : "Client Type (corporate, travelAgent)."
    },
    "clientName" : "string"
  } ],
  "additionalNames" : [ {
    "firstName" : "string",
    "lastName" : "string",
    "title" : "string",
    "middleInit" : "string"
  } ],
  "gdsChainCode" : "string"
}

Example Response

[ {
  "confNumber" : "string",
  "ratePlan" : {
    "ratePlanName" : "string",
    "serviceChargesAndTaxesIncluded" : true,
    "promoCode" : "string",
    "advancePurchase" : true,
    "ratePlanCode" : "string"
  },
  "travelPartners" : [ {
    "partnerNumber" : "string",
    "partnerCode" : "string",
    "partnerType" : {
      "description" : "Travel partner type (air)."
    }
  } ],
  "numRollAways" : 0,
  "guarantee" : {
    "paymentCard" : {
      "cardHolderState" : "string",
      "cardHolderName" : "string",
      "cardHolderCountry" : "string",
      "secureCustomerAuthenticationInfo" : {
        "cavv" : "string",
        "cavvAlgorithm" : "string",
        "threeDAuthenticatedResponse" : "string",
        "networkTxnRefTraceId" : "string",
        "eCommerceIndicator" : "string",
        "threeDOfferedResponse" : "string",
        "threeDSVersion" : "string",
        "transactionId" : "string"
      },
      "cardCode" : "string",
      "postalCode" : "string",
      "cardExpireDate" : "string",
      "cardHolderAddress" : "string",
      "cardPaymentType" : {
        "description" : "Indicates type of card payment."
      },
      "cardHolderCity" : "string",
      "cardNumber" : "string"
    },
    "cxlPolicyCode" : "string",
    "guarPolicyCode" : "string",
    "cxlPolicyLocalDeadline" : "string",
    "cxlPolicyDesc" : "string",
    "guarMethodDesc" : "string",
    "guarPolicyDesc" : "string",
    "deposit" : {
      "amount" : 0.0,
      "dueDate" : "string",
      "currencyCode" : "string"
    },
    "guarMethodCode" : "string",
    "cxlPolicyDeadline" : "string"
  },
  "requests" : {
    "requestText" : "string",
    "requestCodes" : [ {
      "description" : "The room amenities array, this identifies room amenity request for the reservation.\n"
    } ]
  },
  "propCode" : "string",
  "externalResId" : "string",
  "resCreateDate" : "string",
  "numChildren" : 0,
  "lastResModifyDate" : "string",
  "gnrNumber" : 0,
  "commission" : {
    "amount" : 0.0,
    "payTo" : {
      "description" : "Who to pay the commission to: Corp, Travel, No one"
    },
    "type" : {
      "description" : "Type of commission"
    },
    "centralPay" : true
  },
  "departureDate" : "string",
  "ageBasedPricing" : true,
  "childAges" : [ 0 ],
  "resStatus" : {
    "description" : "CRS Reservation Status"
  },
  "additionalNames" : [ {
    "firstName" : "string",
    "lastName" : "string",
    "title" : "string",
    "middleInit" : "string"
  } ],
  "roomType" : {
    "roomTypeCode" : "string",
    "roomTypeDesc" : [ "string" ],
    "smokingRoom" : true,
    "extraBedPermitted" : true,
    "roomOccupancy" : 0
  },
  "numRooms" : 0,
  "cxlNumber" : "string",
  "cost" : {
    "averageRate" : 0.0,
    "amountBeforeTax" : 0.0,
    "chargeTotals" : [ {
      "total" : 0.0,
      "category" : "string"
    } ],
    "totalTaxes" : 0.0,
    "averageRateAfterFees" : 0.0,
    "averageRateAfterTax" : 0.0,
    "amountAfterTax" : 0.0,
    "rateDetails" : [ {
      "serviceCharges" : [ {
        "period" : {
          "description" : "Period Type."
        },
        "amount" : 0.0,
        "type" : {
          "description" : "Service Charge Type"
        },
        "basis" : {
          "description" : "Basis Type."
        }
      } ],
      "rate3Person" : 0.0,
      "rate2Person" : 0.0,
      "rollawayRate" : 0.0,
      "discountAmount" : 0.0,
      "taxes" : [ {
        "period" : {
          "description" : "Period Type."
        },
        "amount" : 0.0,
        "type" : {
          "description" : "(percent) = Percentage of tax basis, (flat) = Flat Change, (sum) = % of sum of tax basis and prior tax."
        },
        "basis" : {
          "description" : "Basis Type."
        }
      } ],
      "extraPersonRate" : 0.0,
      "chargeDetails" : [ {
        "amountType" : {
          "description" : "The type of Charge rule amount that can be setup."
        },
        "inclusive" : true,
        "amount" : 0.0,
        "period" : {
          "description" : "Period Type."
        },
        "accountingCode" : "string",
        "includedInQuotedRate" : true,
        "basis" : {
          "description" : "Options that are part of the application criteria for a charge rule"
        },
        "collectedOnProperty" : true,
        "sequence" : 0,
        "total" : 0.0,
        "appliedToRuleId" : 0,
        "name" : "string",
        "ruleId" : 0,
        "category" : "string",
        "overrideRuleId" : 0
      } ],
      "roomRate" : 0.0,
      "childRates" : [ 0.0 ],
      "extraChildRate" : 0.0,
      "rate1Person" : 0.0,
      "rate4Person" : 0.0,
      "discountType" : {
        "typeRef" : "string"
      },
      "cribRate" : 0.0,
      "effectiveDate" : "string"
    } ],
    "serviceChargesInTaxCalc" : true,
    "totalServiceCharges" : 0.0,
    "amountWithFees" : 0.0,
    "guestTotalCostAfterTax" : 0.0,
    "currencyCode" : "string",
    "serviceChargeDesc" : "string",
    "meals" : {
      "lunch" : true,
      "mealPlanDesc" : "string",
      "breakfast" : true,
      "dinner" : true,
      "mealPlan" : "string"
    }
  },
  "comments" : [ "string" ],
  "numAdults" : 0,
  "numCribs" : 0,
  "secondaryGdsCode" : "string",
  "adultAge" : 0,
  "primaryGdsCode" : "string",
  "arrivalDate" : "string",
  "childAgeRanges" : [ {
    "endChildAge" : 0,
    "startChildAge" : 0
  } ],
  "guest" : {
    "emails" : [ {
      "emailAddress" : "string",
      "emailType" : {
        "description" : "home/business/travel/other"
      }
    } ],
    "addresses" : [ {
      "country" : "string",
      "city" : "string",
      "addressType" : {
        "description" : "home/business/travel"
      },
      "postalCode" : "string",
      "addressLine1" : "string",
      "addressLine2" : "string",
      "company" : "string",
      "addressLine3" : "string",
      "state" : "string",
      "addressLine4" : "string"
    } ],
    "name" : {
      "firstName" : "string",
      "lastName" : "string",
      "title" : "string",
      "middleInit" : "string"
    },
    "phones" : [ {
      "phoneType" : {
        "description" : "home/business/mobile/fax/travel"
      },
      "phoneNumber" : "string",
      "phoneExtension" : "string"
    } ],
    "honorsNumber" : "string"
  },
  "bookingCode" : "string",
  "clientAccounts" : [ {
    "clientId" : "string",
    "clientType" : {
      "description" : "Client Type (corporate, travelAgent)."
    },
    "clientName" : "string"
  } ],
  "gdsChainCode" : "string"
} ]

reservationbodyrequired
Type: [DcReservation-DcRes-1.0.33](#dcreservation-dcres-1-0-33)
Description:
Hilton-Inventory-Holdheader
Type: boolean
Description: Indicates desire to hold booking inventory in an unconfirmed state until confirm or release request is received. Available only to authorized channels.
{
  "comments" : [ "DCRes Example" ],
  "externalResId" : "XXTEST",
  "roomStays" : [ {
    "roomTypeCode" : "K1DVV",
    "numAdults" : "1",
    "numCribs" : 0,
    "numRollAways" : 0,
    "numChildren" : "0",
    "departureDate" : "2020-01-04",
    "ratePlanCode" : "F1",
    "arrivalDate" : "2020-01-03"
  } ],
  "guarantee" : {
    "paymentCard" : {
      "cvv" : 273,
      "cardHolderName" : "John Smith",
      "cardCode" : "VI",
      "postalCode" : "111111",
      "cardExpireDate" : "1222",
      "cardHolderAddress" : "755 Crossover Lane",
      "cardNumber" : "8041651690569999"
    },
    "guarMethodCode" : "CC"
  },
  "guest" : {
    "emails" : [ {
      "emailAddress" : "test@hotmail.com",
      "emailType" : "home"
    } ],
    "addresses" : [ {
      "country" : "US",
      "city" : "Memphis",
      "addressType" : "business",
      "postalCode" : "28031",
      "addressLine1" : "755 Crossover Lane",
      "company" : "HILTON",
      "state" : "TN"
    } ],
    "name" : {
      "firstName" : "John",
      "lastName" : "Smith",
      "title" : "Mr",
      "middleInit" : "L"
    },
    "phones" : [ {
      "phoneType" : "business",
      "phoneNumber" : "9012345677",
      "phoneExtension" : "1234"
    } ],
    "honorsNumber" : "246731309"
  },
  "languageCode" : "EN",
  "clientAccounts" : [ {
    "clientId" : "1234567",
    "clientType" : "corporate"
  } ],
  "propCode" : "MSYNH",
  "additionalNames" : [ {
    "firstName" : "Bob",
    "lastName" : "Smith"
  }, {
    "firstName" : "Jim",
    "lastName" : "Rock"
  } ]
}
Hide Response

Definitions

AmenityCode-DcRes

The room amenities array, this identifies room amenity request for the reservation.

Type : enum (accessibleRoom, smoking, nonSmoking, cribs, rollawayBed, oneBed, twoBeds, lowFloor, nearElevator)

BasisType-DcRes

Basis Type.

Type : enum (perRoom, perGuest)

CardPaymentType-DcRes

Indicates type of card payment.

Type : enum (credit, debit, virtual, applepay, googlepay)

CategoryTotal-DcRes

Summarized and grouped totals by charge rule type, taxes, fees, surcharges, etc.

category required Unique code that represents a specific charge category.
Pattern : ^[A-Z0-9]{3,30}$
Example : "string"
string
total required Grand total of charges.
Example : 0.0
number(double)

CategoryTotalDetail-DcRes

Summarized and grouped totals by charge rule type, taxes, fees, surcharges, etc.

accountingCode optional Accounting code to be used for mapping charge rules to GL accounts.
Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,255}$
Example : "string"
string
amount optional Charge rule amount.
Example : 0.0
number(double)
amountType optional Example : ChargeRuleAmountType-DcRes ChargeRuleAmountType-DcRes
appliedToRuleId optional For tax on tax scenarios, id of the rule that this rule was calculated upon.
Example : 0
integer
basis optional Example : ChargeRuleBasis-DcRes ChargeRuleBasis-DcRes
category required Unique code that represents a specific charge category.
Pattern : ^[A-Z0-9]{3,30}$
Example : "string"
string
collectedOnProperty optional Flag to indicate to our external partners (OTAS, etc) which taxes or fees will be collected on property.
Example : true
boolean
includedInQuotedRate optional Indicates if a given charge rule is included in the quoted rate (amount before tax).
Example : true
boolean
inclusive optional Indicates if the Charge Rule was included in the charge amount.
Default : false
Example : true
boolean
name optional Short name that identifies a charge rule.
Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,50}$
Example : "string"
string
overrideRuleId optional Charge rule override id. Indicates that this rule was overridden and which override was applied.
Example : 0
integer
period optional Example : PeriodType-DcRes PeriodType-DcRes
ruleId optional Example : 0 integer
sequence required Example : 0 integer
total required Total charges for the category.
Example : 0.0
number(double)

ChargeRuleAmountType-DcRes

The type of Charge rule amount that can be setup.

Type : enum (flat, percent)

ChargeRuleBasis-DcRes

Options that are part of the application criteria for a charge rule

Type : enum (perRoom, perChild, perAdult, perGuest)

ChildAgeRange-DcRes

endChildAge optional Ending child age of child rate age range
Minimum value : 0
Example : 0
integer
startChildAge optional Starting child age of child rate age range
Minimum value : 0
Example : 0
integer

ClientType-DcRes

Client Type (corporate, travelAgent).

Type : enum (corporate, travelAgent)

Commission-DcRes

amount optional Amount of the commission
Example : 0.0
number(double)
centralPay optional Is the commission centrally paid
Example : true
boolean
payTo optional Example : CommissionPayTo-DcRes CommissionPayTo-DcRes
type optional Example : CommissionType-DcRes CommissionType-DcRes

CommissionPayTo-DcRes

Who to pay the commission to: Corp, Travel, No one

Type : enum (corporate, travelAgent)

CommissionType-DcRes

Type of commission

Type : enum (percent, amount)

DcClientAccount-DcRes

clientId required Client account ID
Pattern : ^\d{1,22}$
Example : "string"
string
clientName optional Client Name
Example : "string"
string
clientType required Example : ClientType-DcRes ClientType-DcRes

DcResCostDetail-DcRes

Polymorphism : Composition

amountAfterTax optional The total amount including all associated taxes and service charges. Does not include crib or rollaway charges.
Example : 0.0
number(double)
amountBeforeTax optional The total amount not including any associated taxes or service charges. Does not include crib or rollaway charges.
Example : 0.0
number(double)
amountWithFees optional Amount for the stay including service charges. Calculated as sum of amountBeforeTax and service charge, rounded up to rate plan currency precision.
Example : 0.0
number(double)
averageRate optional Average rate for the stay. Calculated by dividing amountBeforeTax by length of the stay, rounded up to rate plan currency precision.
Example : 0.0
number(double)
averageRateAfterFees optional Average rate for the stay including service charges. Calculated by dividing sum of amountBeforeTax and service charge by length of the stay, rounded up to rate plan currency precision.
Example : 0.0
number(double)
averageRateAfterTax optional Average rate for the stay including taxes and service charges. Calculated by dividing amountAfterTax by length of the stay, rounded up to rate plan currency precision.
Example : 0.0
number(double)
chargeTotals optional Example : CategoryTotal-DcRes < CategoryTotal-DcRes > array
currencyCode optional ISO 4217 standard currency code
Pattern : ^[A-Z]{3}$
Example : "string"
string
guestTotalCostAfterTax optional The total cost to the guest of all elements of the stay (i.e. rooms and add-ons) after taxes.
Example : 0.0
number(double)
meals optional Example : DcResMealsIncluded-DcRes DcResMealsIncluded-DcRes
rateDetails optional Example : DcStayRateDetail-DcRes < DcStayRateDetail-DcRes > array
serviceChargeDesc optional Service charge description
Example : "string"
string
serviceChargesInTaxCalc optional Indicates if the service charges are included in the tax calculation.
Example : true
boolean
totalServiceCharges optional Total service charges for the stay. If rate plan is tax inclusive, this value will be 0.0.
Example : 0.0
number(double)
totalTaxes optional Total taxes for the stay. If rate plan is tax inclusive, this value will be 0.0.
Example : 0.0
number(double)

DcReservation-DcRes

additionalNames optional The number of additional names cannot exceed total number of guests minus 1.
Example : StandardName-DcRes
< StandardName-DcRes > array
clientAccounts optional Only one of each client type is allowed.
Example : DcClientAccount-DcRes
< DcClientAccount-DcRes > array
comments optional Max Items : 3
Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,65}$
Example : [ "string" ]
< string > array
externalResId optional The external ReservationId.
Pattern : ^((?![|=;])[\p{N}\p{L}\p{P}]){1,20}$
Example : "string"
string
gdsChainCode optional GDS chain code. Required for GDS.
Pattern : ^[A-Z]{2}$
Example : "string"
string
guarantee required Example : DcResGuarantee-DcRes DcResGuarantee-DcRes
guest required Example : DcStayGuest-DcRes DcStayGuest-DcRes
languageCode optional IETF BCP 47 standard language codes
Pattern : ^[A-Z]{2}$
Example : "string"
string
primaryGdsCode optional The primary GDS code identifies a Global Distribution System (GDS). Required for GDS.
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
propCode required Property Code or GDS Property Code
Pattern : ^[A-Z0-9]{2,6}$
Example : "string"
string
pseudoCityCode optional Identification code of office/agency of a GDS. Optional for GDS.
Pattern : ^[A-Z0-9]{1,16}$
Example : "string"
string
requests optional Example : SpecialRequest-DcRes SpecialRequest-DcRes
roomStays required Min Items : 1
Example : DcResRoomStay-DcRes
< DcResRoomStay-DcRes > array
secondaryGdsCode optional The secondary GDS code.
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
sendConfirmation optional Send confirmation information to the guest.
Example : true
boolean
travelPartners optional Example : TravelPartner-DcRes < TravelPartner-DcRes > array

DcReservationStay-DcRes

additionalNames optional Example : StandardName-DcRes < StandardName-DcRes > array
adultAge optional Minimum age of person considered an adult
Minimum value : 0
Example : 0
integer
ageBasedPricing optional Indicates that property participates in age-based pricing
Example : true
boolean
arrivalDate optional The arrival date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)
bookingCode optional The GDS booking code (3 character roomTypeCode and 3 character ratePlanCode).
Pattern : ^[A-Z0-9]{6}$
Example : "string"
string
childAgeRanges optional Array of child age ranges defined for the property, returned in order from youngest to oldest. The rate for each age range can be determined by indexing into the childRates array with the same array index value for that particular range.
Max Items : 6
Example : ChildAgeRange-DcRes
< ChildAgeRange-DcRes > array
childAges optional Child Age
Max Items : 8
Example : [ 0 ]
< integer > array
clientAccounts optional Example : DcClientAccount-DcRes < DcClientAccount-DcRes > array
comments optional Max Items : 3
Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,65}$
Example : [ "string" ]
< string > array
commission optional Example : Commission-DcRes Commission-DcRes
confNumber optional Confirmation Number
Example : "string"
string
cost optional Example : DcResCostDetail-DcRes DcResCostDetail-DcRes
cxlNumber optional Cancellation Number
Example : "string"
string
departureDate optional The departure date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)
externalResId optional The external ReservationId.
Pattern : ^((?![|=;])[\p{N}\p{L}\p{P}]){1,20}$
Example : "string"
string
gdsChainCode optional GDS chain code
Pattern : ^[A-Z]{2}$
Example : "string"
string
gnrNumber optional GNR Number
Example : 0
integer(int64)
guarantee optional Example : DcStayGuarantee-DcRes DcStayGuarantee-DcRes
guest optional Example : DcStayGuest-DcRes DcStayGuest-DcRes
lastResModifyDate optional The time stamp as defined by date-time - RFC3339 that represents when the stay was last modified on the CRS
Example : "string"
string(date-time)
numAdults optional The number of adults per room.
Minimum value : 0
Example : 0
integer
numChildren optional The number of children per room.
Minimum value : 0
Example : 0
integer
numCribs optional The number of cribs per room.
Example : 0
integer
numRollAways optional The number of rollaway beds per room.
Example : 0
integer
numRooms optional Number of rooms
Minimum value : 0
Example : 0
integer
primaryGdsCode optional The primary GDS code identifies a Global Distribution System (GDS). Required for GDS.
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
propCode optional Property Code or GDS Property Code
Pattern : ^[A-Z0-9]{2,6}$
Example : "string"
string
ratePlan optional Example : DcStayRatePlan-DcRes DcStayRatePlan-DcRes
requests optional Example : SpecialRequest-DcRes SpecialRequest-DcRes
resCreateDate optional The time stamp as defined by date-time - RFC3339 that represents when the stay was created on the CRS
Example : "string"
string(date-time)
resStatus optional Example : ResStatus-DcRes ResStatus-DcRes
roomType optional Example : DcStayRoomType-DcRes DcStayRoomType-DcRes
secondaryGdsCode optional The secondary GDS code.
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
travelPartners optional Example : TravelPartner-DcRes < TravelPartner-DcRes > array

DcResGuarantee-DcRes

deposit optional Example : ResDeposit-DcRes ResDeposit-DcRes
guarMethodCode required Guarantee method code
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
paymentCard optional Example : ResPaymentCard-DcRes ResPaymentCard-DcRes

DcResMealsIncluded-DcRes

Defines which meals are included with this rate plan

breakfast optional Does the restaurant serve breakfast
Example : true
boolean
dinner optional Does the restaurant serve dinner
Example : true
boolean
lunch optional Does the restaurant serve lunch
Example : true
boolean
mealPlan optional Meal plan
Pattern : [A-Z0-9]{1}
Example : "string"
string
mealPlanDesc optional Description of meal plan
Example : "string"
string

DcResRoomStay-DcRes

advancePurchase optional Is this reservation fully pre-paid
Example : true
boolean
arrivalDate required The arrival date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)
bookingCode optional The GDS booking code (3 character roomTypeCode and 3 character ratePlanCode).
Pattern : ^[A-Z0-9]{6}$
Example : "string"
string
childAges optional Child Age
Max Items : 8
Example : [ 0 ]
< integer > array
departureDate required The departure date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)
numAdults required The number of adults per room.
Minimum value : 0
Example : 0
integer
numChildren optional The number of children per room.
Minimum value : 0
Example : 0
integer
numCribs optional The number of cribs per room.
Example : 0
integer
numRollAways optional The number of rollaway beds per room.
Example : 0
integer
promoCode optional Promotion code that the rate plan is derived from.
Pattern : ^[A-Z0-9]{1,6}$
Example : "string"
string
rateOverrides optional Max Items : 90
Example : RateOverride-DcRes
< RateOverride-DcRes > array
ratePlanCode optional A rate plan. May describe any of the following: SRP, Rate levels (0-9)
Pattern : ^[A-Z0-9]{2,6}$
Example : "string"
string
roomTypeCode optional Room Type Code
Pattern : ^[A-Z0-9]{2,6}$
Example : "string"
string
smokingRoom optional Indicates smoking is allowed or has been requested.
Example : true
boolean

DcStayGuarantee-DcRes

cxlPolicyCode optional The cancellation policy for the stay
Example : "string"
string
cxlPolicyDeadline optional The time stamp as defined by date-time - RFC3339 that represents the cancellation policy deadline for the property in UTC.
Example : "string"
string(date-time)
cxlPolicyDesc optional The cancellation policy description
Example : "string"
string
cxlPolicyLocalDeadline optional The time stamp in YYYY-MM-DDThh:mm format that represents the cancellation policy deadline for the property in the property’s local time.
Pattern : ^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]$
Example : "string"
string
deposit optional Example : Deposit-DcRes Deposit-DcRes
guarMethodCode required Guarantee method code
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
guarMethodDesc optional Guarantee method description
Example : "string"
string
guarPolicyCode optional The guarantee policy code for the stay
Example : "string"
string
guarPolicyDesc optional The guarantee policy description
Example : "string"
string
paymentCard optional Example : StayPaymentCard-DcRes StayPaymentCard-DcRes

DcStayGuest-DcRes

addresses required Min Items : 1
Max Items : 3
Example : StayAddress-DcRes
< StayAddress-DcRes > array
emails optional Max Items : 4
Example : StayEmail-DcRes
< StayEmail-DcRes > array
honorsNumber optional Hilton Honors Number.
Pattern : ^\d{1,24}$
Example : "string"
string
name required Example : StandardName-DcRes StandardName-DcRes
phones optional Max Items : 5
Example : StayPhone-DcRes
< StayPhone-DcRes > array

DcStayRateDetail-DcRes

chargeDetails optional Example : CategoryTotalDetail-DcRes < CategoryTotalDetail-DcRes > array
childRates optional Child rate for a given age range
Max Items : 6
Example : [ 0.0 ]
< number(double) > array
cribRate optional Daily crib rate
Example : 0.0
number(double)
discountAmount optional Discount applied
Example : 0.0
number(double)
discountType optional Example : DiscountType-DcRes DiscountType-DcRes
effectiveDate optional The effective date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)
extraChildRate optional extra child rate
Example : 0.0
number(double)
extraPersonRate optional extra person charge
Example : 0.0
number(double)
rate1Person optional Room rate for 1 person in room
Example : 0.0
number(double)
rate2Person optional Room rate for 2 persons in room
Example : 0.0
number(double)
rate3Person optional Room rate for 3 persons in room
Example : 0.0
number(double)
rate4Person optional Room rate for 4 persons in room
Example : 0.0
number(double)
rollawayRate optional Daily roll-away rate
Example : 0.0
number(double)
roomRate optional One night rate in effect for this rate period for the number of guests. Excludes extra bed costs, taxes and service charges.
Example : 0.0
number(double)
serviceCharges optional Example : ServiceCharge-DcRes < ServiceCharge-DcRes > array
taxes optional Example : Tax-DcRes < Tax-DcRes > array

DcStayRatePlan-DcRes

advancePurchase optional Is this reservation fully pre-paid
Example : true
boolean
promoCode optional Promotion code that the rate plan is derived from.
Pattern : ^[A-Z0-9]{1,6}$
Example : "string"
string
ratePlanCode required A rate plan. May describe any of the following: SRP, Rate levels (0-9)
Pattern : ^[A-Z0-9]{2,6}$
Example : "string"
string
ratePlanName optional Long form name of a rate plan
Pattern : ^((?![\|\=\;])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,20}$
Example : "string"
string
serviceChargesAndTaxesIncluded optional Indicates if service charges and taxes are included in the rates
Example : true
boolean

DcStayRoomType-DcRes

extraBedPermitted optional Indicates if an extra bed is permitted in the the room.
Example : true
boolean
roomOccupancy optional The maximum allowed occupancy of the room
Example : 0
integer
roomTypeCode required Room Type Code
Pattern : ^[A-Z0-9]{2,6}$
Example : "string"
string
roomTypeDesc optional Room Type Description
Example : [ "string" ]
< string > array
smokingRoom optional Indicates smoking is allowed or has been requested.
Example : true
boolean

Deposit-DcRes

amount required Deposit Amount
Example : 0.0
number(double)
currencyCode optional ISO 4217 standard currency code
Pattern : ^[A-Z]{3}$
Example : "string"
string
dueDate required The deposit due date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)

DiscountType-DcRes

Type : enum (percentOff, percentAdd, amountOff, amountAdd)

EmailType-DcRes

home/business/travel/other

Type : enum (home, business, travel, other)

ErrorDetail-DcRes

code required Example : 0 integer
context required Example : "string" string
message required Example : "string" string
notifications optional Example : ErrorNotification-DcRes < ErrorNotification-DcRes > array

ErrorNotification-DcRes

code optional Error Notification Code or identifier
Example : "string"
string
fields optional Example : [ "string" ] < string > array
message required Example : "string" string
otaErrorCode optional Online travel agency error code.
Example : 0
integer

PartnerType-DcRes

Travel partner type (air).

Type : enum (air)

PeriodType-DcRes

Period Type.

Type : enum (perNight, perStay)

RateOverride-DcRes

amount required Override Amount
Example : 0.0
number(double)
effectiveDate required The effective date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)

ResDeposit-DcRes

amount required Deposit Amount
Example : 0.0
number(double)
dueDate optional The deposit due date as defined by full-date - RFC3339 (YYYY-MM-DD).
Example : "string"
string(date)

ResPaymentCard-DcRes

Polymorphism : Composition

cardCode optional The unique two letter code for a credit card.
Pattern : ^[A-Z]{2}$
Example : "string"
string
cardExpireDate optional Card expiration date in the format of MMYY
Pattern : ((^0[1-9]|1[0-2])[0-9]{2}$)
Example : "string"
string
cardHolderAddress optional Address Line
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,35}(?<!\p{Zs})$
Example : "string"
string
cardHolderCity optional City name.
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"
string
cardHolderCountry optional name associated with the country code
Pattern : ^[A-Za-z .,-_()’]{1,60}$
Example : "string"
string
cardHolderName optional Card holder name
Pattern : ^((?![\|\=\;])[\p{L}\p{N}\p{M}\p{P} ]){1,75}$
Example : "string"
string
cardHolderState optional State code as defined by the ISO-3166-2 principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.
Pattern : ^[A-Z0-9]{1,3}$
Example : "string"
string
cardNumber optional Payment card number
Pattern : (^8\d{15}$|^\w{15}[CD]\d{4}$)
Example : "string"
string
cardPaymentType optional Example : CardPaymentType-DcRes CardPaymentType-DcRes
postalCode optional The billing postal code used to authorize the payment card
Pattern : ^(?!\p{Zs})[\p{L}\p{N}\p{Zs}-]{2,10}(?<!\p{Zs})$
Example : "string"
string
secureCustomerAuthenticationInfo optional Example : SecureCustomerAuthenticationInfo-DcRes SecureCustomerAuthenticationInfo-DcRes

ResStatus-DcRes

CRS Reservation Status

Type : enum (confirmed, inHouse, cancelled, checkout)

SecureCustomerAuthenticationInfo-DcRes

cavv optional The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session.
Pattern : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
Example : "string"
string
cavvAlgorithm optional The CAVV Algorithmn used during the authentication.
Pattern : ^[0-9a-zA-Z.]{1,10}$
Example : "string"
string
eCommerceIndicator optional The Electronic Commerce Indicator returned from the schemes for the 3D Secure 2 payment session.
Pattern : ^[a-zA-Z0-9]{1,10}$
Example : "string"
string
networkTxnRefTraceId optional Network Transaction Reference/Trace Identifier.
Pattern : ^[A-Z0-9]{1,50}$
Example : "string"
string
threeDAuthenticatedResponse optional Value indicating whether 3D Secure was offered for this payment.
Pattern : ^[a-zA-Z]{1,10}$
Example : "string"
string
threeDOfferedResponse optional A Boolean value indicating whether 3D Secure was offered for this payment.
Pattern : ^[a-zA-Z]{1,10}$
Example : "string"
string
threeDSVersion optional The current supported version of 3D Secure 2.
Pattern : ^[0-9.]{1,10}$
Example : "string"
string
transactionId optional The unique transaction identifier assigned by the 3DS to identify a single transaction.
Pattern : ^((?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)|[A-Za-z0-9-]{1,100})$
Example : "string"
string

ServiceCharge-DcRes

amount optional Service Charge Amount
Example : 0.0
number(double)
basis optional Example : BasisType-DcRes BasisType-DcRes
period optional Example : PeriodType-DcRes PeriodType-DcRes
type optional Example : ServiceChargeType-DcRes ServiceChargeType-DcRes

ServiceChargeType-DcRes

Service Charge Type

Type : enum (percent, flat)

SpecialRequest-DcRes

requestCodes optional Max Items : 7
Example : AmenityCode-DcRes
< AmenityCode-DcRes > array
requestText optional Booking request text
Pattern : ^((?!\|)[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,38}$
Example : "string"
string

StandardName-DcRes

firstName required Guest first name.
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"
string
lastName required Guest last name
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"
string
middleInit optional Middle Initial
Pattern : ^[\p{L}\p{M}]{1}$
Example : "string"
string
title optional Additional name text providing position, professional qualification, generational suffix, honorific, or veneration
Pattern : ^((?![\|\=\;])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,48}$
Example : "string"
string

StayAddress-DcRes

addressLine1 optional Address Line
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,35}(?<!\p{Zs})$
Example : "string"
string
addressLine2 optional Address Line
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,35}(?<!\p{Zs})$
Example : "string"
string
addressLine3 optional Address Line
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,35}(?<!\p{Zs})$
Example : "string"
string
addressLine4 optional Address Line
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,35}(?<!\p{Zs})$
Example : "string"
string
addressType required Example : StayAddressType-DcRes StayAddressType-DcRes
city optional City name.
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"
string
company optional Company Name
Pattern : ^(?!\p{Zs})((?![\|\=\;])[\p{L}\p{N}\p{M}\p{P}\p{S} ]){1,60}(?<!\p{Zs})$
Example : "string"
string
country optional ISO 3166-1 Alpha-2 country code.
Pattern : ^[A-Z]{2}$
Example : "string"
string
postalCode optional Guest zip code, may be present in a name based search
Pattern : ^(?!\p{Zs})[\p{L}\p{N}\p{Zs}-]{2,10}(?<!\p{Zs})$
Example : "string"
string
state optional State code as defined by the ISO-3166-2 principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.
Pattern : ^[A-Z0-9]{1,3}$
Example : "string"
string

StayAddressType-DcRes

home/business/travel

Type : enum (home, business, travel)

StayEmail-DcRes

emailAddress required Email address
Example : "string"
string
emailType required Example : EmailType-DcRes EmailType-DcRes

StayPaymentCard-DcRes

cardCode optional The unique two letter code for a credit card.
Pattern : ^[A-Z]{2}$
Example : "string"
string
cardExpireDate optional Card expiration date in the format of MMYY
Pattern : ((^0[1-9]|1[0-2])[0-9]{2}$)
Example : "string"
string
cardHolderAddress optional Address Line
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{S}\p{Zs}]){1,35}(?<!\p{Zs})$
Example : "string"
string
cardHolderCity optional City name.
Pattern : ^(?!\p{Zs})((?![\|\=\;\}\{])[\p{L}\p{N}\p{M}\p{P}\p{Zs}]){1,30}(?<!\p{Zs})$
Example : "string"
string
cardHolderCountry optional name associated with the country code
Pattern : ^[A-Za-z .,-_()’]{1,60}$
Example : "string"
string
cardHolderName optional Card holder name
Pattern : ^((?![\|\=\;])[\p{L}\p{N}\p{M}\p{P} ]){1,75}$
Example : "string"
string
cardHolderState optional State code as defined by the ISO-3166-2 principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.
Pattern : ^[A-Z0-9]{1,3}$
Example : "string"
string
cardNumber optional Payment card number
Pattern : (^8\d{15}$|^\w{15}[CD]\d{4}$)
Example : "string"
string
cardPaymentType optional Example : CardPaymentType-DcRes CardPaymentType-DcRes
postalCode optional The billing postal code used to authorize the payment card
Pattern : ^(?!\p{Zs})[\p{L}\p{N}\p{Zs}-]{2,10}(?<!\p{Zs})$
Example : "string"
string
secureCustomerAuthenticationInfo optional Example : SecureCustomerAuthenticationInfo-DcRes SecureCustomerAuthenticationInfo-DcRes

StayPhone-DcRes

phoneExtension optional Phone Extension
Pattern : ^[0-9]{1,6}$
Example : "string"
string
phoneNumber required Phone number
Pattern : ^[0-9]{7,15}$
Example : "string"
string
phoneType required Example : StayPhoneType-DcRes StayPhoneType-DcRes

StayPhoneType-DcRes

home/business/mobile/fax/travel

Type : enum (home, business, mobile, fax, travel)

Tax-DcRes

amount optional Tax amount
Example : 0.0
number(double)
basis optional Example : BasisType-DcRes BasisType-DcRes
period optional Example : PeriodType-DcRes PeriodType-DcRes
type optional Example : TaxType-DcRes TaxType-DcRes

TaxType-DcRes

(percent) = Percentage of tax basis, (flat) = Flat Change, (sum) = % of sum of tax basis and prior tax.

Type : enum (percent, flat, sum)

TravelPartner-DcRes

partnerCode required Travel Partner code (Frequent Flyer, etcetera)
Pattern : ^[A-Z0-9]{2}$
Example : "string"
string
partnerNumber required Travel partner number
Example : "string"
string
partnerType optional Example : PartnerType-DcRes PartnerType-DcRes