Api.Wrapi

CreateBasket

This resource is used to manage baskets in HAPI.

The following routes are available for this service:
POST	/basket	Add a new basket in HAPI.

**CreateBasket** Parameters:
Name	Parameter	Data Type	Required	Description
Id	body	GUID	No	The WRAPI GUID to retrieve a cached session
From	body	string	Yes	The Departure Airport Code e.g. LGW
To	body	string	Yes	The Destination Resort Code e.g. ATLE
Property	body	string	No	The Property Code e.g. ATLE0104ACC. Supply either this or GIATA code
Giata	body	string	No	The GIATA Code e.g. 02137743. Supply either this or Property code
Room	body	string	Yes	The Room Code e.g. C4
Board	body	string	Yes	The Room Board Code e.g. HB
When	body	date	Yes	The Departure Date e.g. 2019-02-23
Nights	body	integer	Yes	The Duration e.g. 7
DateOffset	body	integer	No	The Date Offset - Used to extend the duration / adjust the accommodation start date for overnight flights
Adults	body	integer	Yes	The Number Of Adults e.g. 2
Children	body	integer	No	The Number Of Children e.g. 0
ChildAge	body	integer[]	No	The Ages of the Children (if Children > 0) e.g. 1,2,3

**AbstractRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BrandCode	form	string	Yes	The Brand Code e.g. INGH
CatalogueCode	form	string	Yes	The Catalogue Code e.g. 010
ProgramCode	form	string	Yes	The Program Code e.g. GBINA
CurrencyCode	form	string	Yes	The Currency Code e.g. GBP
Agent	form	string	No	The Agent Code e.g. thomascook

**WrapiBasket** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
ShortCode	form	string	No
Session	form	Session	No
Contents	form	Basket	No
Flights	form	List<FlightPair>	No
Accommodation	form	List<Offer>	No
HasValidOrder	form	bool	No

**AbstractResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**Session** Parameters:
Name	Parameter	Data Type	Required
AuthenticationId	form	string	No
Authenticated	form	bool	No
Token	form	string	No
Expires	form	DateTime	No
BasketId	form	string	No
SearchId	form	string	No
ProductId	form	string	No
Sender	form	string	No
Message	form	Message	No
OrderId	form	string	No

**Message** Parameters:
Name	Parameter	Data Type	Required
Text	form	string	No
TechnicalInfo	form	string	No
ProviderMessage	form	ProviderMessage	No
Type	form	string	No
Class	form	string	No
Id	form	string	No

**ProviderMessage** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string	No

**Basket** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Currency	form	string	No
Language	form	string	No
Product	form	Product	No
Travellers	form	Traveller[]	No
Discounts	form	Discount[]	No
Price	form	Price	No
PaymentCondition	form	PaymentCondition	No
PricePerPerson	form	decimal	No

**Product** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Reference	form	string	No
Status	form	string	No
BookOptions	form	BookOptions	No
Travellers	form	List<TravellerSummary>	No
Services	form	List<Service>	No
Included	form	List<IncludedDetail>	No

**BookOptions** Parameters:
Name	Parameter	Data Type	Required
Book	form	Book	No
Option	form	Option	No
Quote	form	Quote	No

**Book** Parameters:
Name	Parameter	Data Type	Required	Description
Allowed	form	bool	No

**Option** Parameters:
Name	Parameter	Data Type	Required
Allowed	form	bool	No
SetTo	form	string	No
Validity	form	Validity	No
ExtendValidity	form	ExtendValidity	No

**Validity** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	string	No

**ExtendValidity** Parameters:
Name	Parameter	Data Type	Required	Description
Allowed	form	bool	No
Date	form	string	No

**Quote** Parameters:
Name	Parameter	Data Type	Required	Description
Allowed	form	bool	No

**TravellerSummary** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Reference	form	int	No
Price	form	Price	No

**Price** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	decimal	No
Currency	form	string	No

**Service** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
ParentId	form	string	No
Reference	form	string	No
Status	form	string	No
Travellers	form	List<TravellerSummary>	No
Destination	form	Destination	No

**Destination** Parameters:
Name	Parameter	Data Type	Required	Description
Location	form	Location	No
Country	form	DestinationCountry	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Long** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string[]	No

**DestinationCountry** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**IncludedDetail** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Traveller	form	List<TravellerSummary>	No
Date	form	StartEndDate	No
Description	form	IncludedDescription	No
Price	form	ServiceDetailPrice	No
Property	form	PropertyType	No
IsDiscount	form	bool?	No

**StartEndDate** Parameters:
Name	Parameter	Data Type	Required	Description
Start	form	DateDate	No
End	form	DateDate	No

**DateDate** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	string	No

**IncludedDescription** Parameters:
Name	Parameter	Data Type	Required	Description
Long	form	Long	No

**ServiceDetailPrice** Parameters:
Name	Parameter	Data Type	Required	Description
PerTraveller	form	ServiceDetailPerTavellerPrice[]	No
Total	form	Price	No

**ServiceDetailPerTavellerPrice** Parameters:
Name	Parameter	Data Type	Required
TravellerReference	form	int	No
Amount	form	decimal	No
Currency	form	string	No

**PropertyType** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No

**Traveller** Parameters:
Name	Parameter	Data Type	Required
Salutation	form	string	No
Title	form	string	No
WrapiTitle	form	string	No
Gender	form	string	No
FirstName	form	string	No
LastName	form	string	No
DateOfBirth	form	string	No
TravellerType	form	TravellerType	No
CalculatedAge	form	int	No
Allocated	form	bool	No

**Discount** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
Code	form	string	No
Reference	form	Reference	No

**Reference** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
Id	form	string	No

**Price** Parameters:
Name	Parameter	Data Type	Required	Description
Sell	form	Sell	No

**Sell** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	decimal	No
Currency	form	string	No

**PaymentCondition** Parameters:
Name	Parameter	Data Type	Required
OpenAmount	form	ConditionSell	No
Immediately	form	Immediately	No
Conditions	form	List<Condition>	No
AllowedPaymentMethods	form	AllowedPaymentMethods	No

**ConditionSell** Parameters:
Name	Parameter	Data Type	Required
NullableAmount	form	string	No
Amount	form	decimal	No
Currency	form	string	No

**Immediately** Parameters:
Name	Parameter	Data Type	Required	Description
PaymentAmount	form	ConditionSell	No
Percent	form	decimal	No

**Condition** Parameters:
Name	Parameter	Data Type	Required
DueDate	form	DateTime	No
PaymentAmount	form	ConditionSell	No
Percent	form	decimal	No

**AllowedPaymentMethods** Parameters:
Name	Parameter	Data Type	Required	Description
PaymentMethods	form	PaymentMethod[]	No

**PaymentMethod** Parameters:
Name	Parameter	Data Type	Required	Description
CreditCard	form	CreditCard	No

**CreditCard** Parameters:
Name	Parameter	Data Type	Required	Description
CardBrand	form	string	No

**FlightPair** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Outbound	form	Transport	No
Inbound	form	Transport	No
Value	form	double	No

**Transport** Parameters:
Name	Parameter	Data Type	Required
Origin	form	Gateway	No
Destination	form	Gateway	No
Date	form	Date	No
Flight	form	Flight	No
Price	form	TransportPrice	No
Surcharge	form	TransportSurcharge	No
RequiredAction	form	RequiredAction	No
SearchServiceId	form	string	No
Status	form	TransportStatus	No
AvailableSeats	form	int	No
SkiSeats	form	int	No
FlightMessage	form	string	No

**Gateway** Parameters:
Name	Parameter	Data Type	Required	Description
Location	form	Location	No
Country	form	GatewayCountry	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**GatewayCountry** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Date** Parameters:
Name	Parameter	Data Type	Required
Departure	form	Departure	No
Arrival	form	Arrival	No
Duration	form	int	No

**Departure** Parameters:
Name	Parameter	Data Type	Required
Date	form	string	No
Time	form	string	No
Utc	form	string	No

**Arrival** Parameters:
Name	Parameter	Data Type	Required
Date	form	string	No
Time	form	string	No
Utc	form	string	No

**Flight** Parameters:
Name	Parameter	Data Type	Required
Carrier	form	Carrier	No
FlightNumber	form	string	No
Class	form	Class	No
Baggage	form	Baggage	No
Routing	form	Routing	No
Property	form	Property	No
Code	form	string	No

**Carrier** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Description	No

**Description** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string[]	No

**Class** Parameters:
Name	Parameter	Data Type	Required	Description
BookingClass	form	string	No
CabinClass	form	CabinClass	No

**CabinClass** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	Long	No
Code	form	string	No

**Baggage** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
Quantity	form	string	No
Weight	form	string	No
Unit	form	string	No

**Routing** Parameters:
Name	Parameter	Data Type	Required
Departure	form	RoutingDeparture	No
Arrival	form	RoutingArrival	No
Carrier	form	Carrier	No
FlightNumber	form	string	No
Class	form	Class	No
Date	form	Date	No
AircraftType	form	AircraftType	No
Baggage	form	Baggage	No
OperationType	form	string	No

**RoutingDeparture** Parameters:
Name	Parameter	Data Type	Required	Description
Airport	form	Airport	No
City	form	City	No

**Airport** Parameters:
Name	Parameter	Data Type	Required	Description
Destination	form	Location	No
Country	form	GatewayCountry	No

**City** Parameters:
Name	Parameter	Data Type	Required	Description
Destination	form	Location	No
Country	form	GatewayCountry	No

**RoutingArrival** Parameters:
Name	Parameter	Data Type	Required	Description
Airport	form	Airport	No
City	form	City	No

**AircraftType** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Property** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No

**TransportPrice** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	Amount	No

**Amount** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
Value	form	string	No
ActualValue	form	double	No
Currency	form	string	No

**TransportSurcharge** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	Amount	No

**RequiredAction** Parameters:
Name	Parameter	Data Type	Required	Description
Action	form	string	No

**Offer** Parameters:
Name	Parameter	Data Type	Required
Accommodation	form	Accommodation	No
Price	form	OfferPrice	No
OfferId	form	string	No

**Accommodation** Parameters:
Name	Parameter	Data Type	Required
Destination	form	Destination	No
Date	form	Date	No
Product	form	Product	No
Rooms	form	List<Room>	No
Price	form	AccommodationPrice	No
Surcharge	form	AccommodationSurcharge	No
RequiredAction	form	RequiredAction	No
AccommodationId	form	string	No

**Destination** Parameters:
Name	Parameter	Data Type	Required	Description
Location	form	Location	No
Country	form	DestinationCountry	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**DestinationCountry** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Date** Parameters:
Name	Parameter	Data Type	Required
CheckIn	form	CheckIn	No
CheckOut	form	CheckIn	No
Duration	form	Duration	No

**CheckIn** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	string	No

**Duration** Parameters:
Name	Parameter	Data Type	Required	Description
Entity	form	string	No
Value	form	string	No

**Product** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Address	form	Address	No
Rating	form	Rating	No
Code	form	string	No

**Address** Parameters:
Name	Parameter	Data Type	Required	Description
Structured	form	Structured	No

**Structured** Parameters:
Name	Parameter	Data Type	Required
Firm	form	string	No
Name	form	string	No
Address	form	StructuredAddress	No

**StructuredAddress** Parameters:
Name	Parameter	Data Type	Required
ZipCode	form	string	No
City	form	string	No
Country	form	Country	No

**Country** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	Long	No

**Rating** Parameters:
Name	Parameter	Data Type	Required	Description
Type	form	string	No
Value	form	string	No

**Room** Parameters:
Name	Parameter	Data Type	Required
Description	form	Description	No
Occupancy	form	Occupancy	No
Price	form	AccommodationPrice	No
Surcharge	form	AccommodationSurcharge	No
Board	form	List<Board>	No
Code	form	string	No
RoomId	form	string	No
Status	form	RoomStatus	No
AvailableRooms	form	int	No
UnallocatedRooms	form	int	No
Type	form	string	No

**Description** Parameters:
Name	Parameter	Data Type	Required	Description
Short	form	Short	No
Long	form	RoomLong	No

**Short** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string[]	No

**RoomLong** Parameters:
Name	Parameter	Data Type	Required	Description
Text	form	string[]	No

**Occupancy** Parameters:
Name	Parameter	Data Type	Required
Default	form	int	No
Minimum	form	int	No
Maximum	form	int	No
MinNumOfAdults	form	int	No
MaxNumOfAdults	form	int	No
MaxNumOfInfants	form	int	No
IncludeInfants	form	bool	No
NoChildren	form	bool	No
MinAge	form	int	No
MaxAge	form	int	No
MinChildAge	form	int	No
MaxChildAge	form	int	No

**AccommodationPrice** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	Amount	No

**Amount** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
Value	form	string	No
Currency	form	string	No

**AccommodationSurcharge** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	Amount	No

**Board** Parameters:
Name	Parameter	Data Type	Required
Description	form	Description	No
Price	form	AccommodationPrice	No
Surcharge	form	AccommodationSurcharge	No
Code	form	string	No
SearchServiceId	form	string	No
Default	form	bool	No

**OfferPrice** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	OfferPriceAmount	No

**OfferPriceAmount** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
BaseAmount	form	OfferPriceBaseAmount	No
MaxAmount	form	OfferPriceMaxAmount	No

**OfferPriceBaseAmount** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	No
Currency	form	string	No

**OfferPriceMaxAmount** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	No
Currency	form	string	No

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

HTTP + CSV

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

POST /basket HTTP/1.1 
Host: wrapi-api.dev.hotelplan.co.uk 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"from":"String","to":"String","property":"String","giata":"String","room":"String","board":"String","when":"0001-01-01T00:00:00.0000000","nights":0,"dateOffset":0,"adults":0,"children":0,"childAge":[0],"brandCode":"String","catalogueCode":"String","programCode":"String","currencyCode":"String","agent":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'WrapiBasket' using the custom 'csv' filter}No parameterless constructor defined for this object.