Sphinx.Api

<back to all web services

BatchRequest

This service is used to execute a batch request.

The following routes are available for this service:
POST/{brandCode}/{programcode}/batch

To override the Content-type in your clients 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 /csv/reply/BatchRequest HTTP/1.1 
Host: sphinx-api-v2.dev.hotelplan.co.uk 
Content-Type: text/csv
Content-Length: length

SearchAvailability,SearchRouteAvailability,GetAirports,GetDeparturePoints,GetFerryports,GetDurations,GetAccommodationRatings,GetAccommodationTypes,GetBoardBasis,GetDepartureMonthPrices,GetDepartureAirportPrices,GetDeparturePointPrices,GetDepartureDateBestPrices,GetDestinationPrices,GetResort,GetResorts,GetTravelDates,BrandCode,ProgramCode,Index,AppNameString,Version,RequestUrl,Ip,RequestId,MetaData
"{page:0,pageSize:0,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}}","{page:0,pageSize:0,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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}","{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}}",,"{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}}","{year:0,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}}",String,String,String,String,String,String,String,00000000000000000000000000000000,{String:String}


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

SearchAvailability,SearchRouteAvailability,GetAirports,GetDeparturePoints,GetFerryports,GetDurations,GetAccommodationRatings,GetAccommodationTypes,GetBoardBasis,GetDepartureMonthPrices,GetDeparturePointPrices,GetDepartureAirportPrices,GetDestinationPrices,GetDepartureDateBestPrices,GetResort,GetResorts,GetTravelDates,RequestId,ResponseStatus
"{totalRecords:0,totalPages:0,requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{totalRecords:0,totalPages:0,requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}","{requestId:00000000000000000000000000000000,responseStatus:{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}}",00000000000000000000000000000000,"{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}"