Api.Wrapi

<back to all web services

GetComplexExtras

This resource is used to manage complex extras in HAPI.

The following routes are available for this service:
GET/extras/complex/{id}Get complex extras in HAPI.
AbstractExtrasRequest Parameters:
NameParameterData TypeRequiredDescription
IdformGUIDYesThe WRAPI GUID to retrieve a cached session / extras
WrapiComplexExtras Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<WrapiComplexExtra>No
WrapiComplexExtra Parameters:
NameParameterData TypeRequiredDescription
FacilityGroupformstringNo
DescriptionformstringNo
ProductsformList<WrapiComplexExtraProduct>No
WrapiComplexExtraProduct Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DescriptionformstringNo
TypesformList<Type>No
Type Parameters:
NameParameterData TypeRequiredDescription
DescriptionformDescriptionNo
OccupancyformOccupancyNo
PriceformServiceGroupPriceNo
CodeformstringNo
IdformstringNo
SearchServiceIdformstringNo
ParentServiceIdformstringNo
StatusformstringNo
AvailableTypesformstringNo
DateformDateNo
Description Parameters:
NameParameterData TypeRequiredDescription
ShortformShortNo
LongformLongNo
Short Parameters:
NameParameterData TypeRequiredDescription
Textformstring[]No
Long Parameters:
NameParameterData TypeRequiredDescription
Textformstring[]No
Occupancy Parameters:
NameParameterData TypeRequiredDescription
DefaultformintNo
MinimumformintNo
MaximumformintNo
MaxNumOfAdultsformintNo
MaxNumOfInfantsformintNo
MinAgeformintNo
MaxAgeformintNo
ServiceGroupPrice Parameters:
NameParameterData TypeRequiredDescription
AmountformAmountNo
Amount Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
ValueformstringNo
CurrencyformstringNo
Date Parameters:
NameParameterData TypeRequiredDescription
StartformStartNo
EndformEndNo
DurationformDurationNo
Start Parameters:
NameParameterData TypeRequiredDescription
DateformstringNo
End Parameters:
NameParameterData TypeRequiredDescription
DateformstringNo
Duration Parameters:
NameParameterData TypeRequiredDescription
EntityformstringNo
ValueformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /extras/complex/{id} HTTP/1.1 
Host: wrapi-api.dev.hotelplan.co.uk 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":[{"facilityGroup":"String","description":"String","products":[{"code":"String","description":"String","types":[{"description":{"short":{"text":["String"]},"long":{"text":["String"]}},"occupancy":{"default":0,"minimum":0,"maximum":0,"maxNumOfAdults":0,"maxNumOfInfants":0,"minAge":0,"maxAge":0},"price":{"amount":{"type":"String","value":"String","currency":"String"}},"code":"String","id":"String","searchServiceId":"String","parentServiceId":"String","status":"String","availableTypes":"String","date":{"start":{"date":"String"},"end":{"date":"String"},"duration":{"entity":"String","value":"String"}}}]}]}]}