Sphinx.Api

<back to all web services

GetDepartureMonthPrices

This service is used to get the best prices using the search criteria, grouped for the departure month.

The following routes are available for this service:
GET/{brandCode}/{programcode}/prices/months

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

HTTP + JSV

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

POST /jsv/reply/GetDepartureMonthPrices HTTP/1.1 
Host: sphinx-api-v2.dev.hotelplan.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	key: 
	[
		String
	],
	from: 
	[
		String
	],
	fromGroup: 
	[
		String
	],
	to: 
	[
		{
			country: String,
			region: 0,
			resort: 0,
			resortCode: String,
			arrivalAirport: String
		}
	],
	toCountries: 
	[
		String
	],
	toRegions: 
	[
		0
	],
	toResorts: 
	[
		0
	],
	toResortCodes: 
	[
		String
	],
	when: 
	[
		0001-01-01
	],
	whenWindow: 
	[
		0001-01-01
	],
	years: 
	[
		0001-01-01
	],
	months: 
	[
		0001-01-01
	],
	nights: 
	[
		0
	],
	adults: 0,
	children: 0,
	infants: 0,
	propertyCode: 
	[
		String
	],
	maxPrice: 0,
	minPrice: 0,
	minSaving: 0,
	maxSaving: 0,
	boardBasis: 
	[
		String
	],
	accommodationPropertyType: 
	[
		String
	],
	accommodationRating: 
	[
		0
	],
	singleRoom: False,
	offer: String,
	offers: 
	[
		String
	],
	self: False,
	routeKey: String,
	hasOfferCode: False,
	roomQuantity: 0,
	groupField: String,
	freeText: 
	[
		String
	],
	sortField: String,
	sortOrder: Default,
	extraAgeBand: 
	[
		String
	],
	extraProductType: 
	[
		String
	],
	includeExtras: False,
	brandCode: String,
	programCode: String,
	index: String,
	appNameString: String,
	version: String,
	requestUrl: String,
	ip: String,
	requestId: 00000000000000000000000000000000,
	metaData: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	requestId: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}