ws
Car and Driving Master Webservice
The following operations are supported. For a formal definition, please review the Service Description.
-
GetAnnualTopTen
Return a list of the best selling cars this year. -
GetCapLookupTable
Get a complete list of cap id's and capcodes linked to each review. The returned review id can be used in GetReviewDetailsFromID(). Note - a lot of data is returned by this function, and when used in a browser it is likely to take a while simply because the browser takes a long time to render it. The call itself is quite fast. The results are returned in the captableentrylist element as a list of captableentry. -
GetCategories
Returns a list of vehicle categories for use in GetReviewsFromManufacturerCategoryAndType -
GetCategoriesDetailed
Returns a list of every category detailed. -
GetCategoriesFromCategoryType
Returns one of 3 alternative lists of vehicle categories for use in GetReviewsFromManufacturerCategoryAndType - CategoryType is one of main (a simple category structure used in the main site)/short (as main, but with shorter names)/scoring (a different structure, used for comparing scores between vehicles) -
GetCategoriesSub
As GetCategoriesDetailed, but only returns those categories that are subcategories of the specified parent (as taken from GetCategories) -
GetCustomNewsItemFromID
Returns single bespoke news item with the given ID. -
GetCustomNewsItems
Returns list of news items written specifically for your account for customers signed up to our custom newsfeed service only, ordered latest first. Howmany, if given, returns only that number of matches. Days is optional, and if given limits the results to just reviews from the past N days. This call does not contain items in the main news feed - call both this and GetNewsItems if you want both. -
GetCustomNewsItemsFromKeyword
Returns list of news items written specifically for your account, ordered latest first. Howmany, if given, returns only that number of matches. Keyword is the keyword to search for. -
GetCustomReviewDetailsFromID
Get a review given an ID from GetReviews... or GetTitles... calls. GetSummaries is optional - set to 'true' to include 150, 250 and 500 word summaries with the result if available, or nolinked to get summaries but no linked reviews . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetFeatureCategories
Returns list of feature categories, ordered alphabetically. If a category has no features yet, it is not returned in the list. -
GetFeatureFromID
Returns single feature with the given ID. -
GetFeatureTitles
Returns list of minimal feature records (no paragraph text), ordered latest first. Howmany, if given, returns only that number of matches. Category is optional and should be one of the list of categories returned by GetFeatureCategories(). Keyword, if given, returns only the features with that word in the title. To get the full feature, use GetFeaturesList or GetFeatureFromID. -
GetFeatures
Returns list of features, ordered latest first. Howmany, if given, returns only that number of matches. Category is optional, and if given should be taken from the list returned by GetFeatureCategories. Keyword, if given, returns only the features with that word in the title. -
GetInfoFromManufacturerSearchArgList
Get list of manufacturer/model/version (only - use GetInfoFullDataFromManufacturerModelVersion with the results to get the full data) for cars which match the given list of constraints (field/operand/value, where operand is one of eq/ne/lt/gt/lte/gte) in array of search arg format. Manufacturer is optional. -
GetInfoFromManufacturerSearchString
Get list of manufacturer/model/version (only - use GetInfoFullDataFromManufacturerModelVersion with the results to get the full data) for cars which match the given list of constraints in string format (#field1;lt;value1#field2;eq;value2#...) (List of field/operand/value triplets, where operand is one of eq/ne/lt/gt/lte/gte). Converts the string to versiondata format, and calls GetInfoFromManufacturerSearchArgList, so functionally identical. Manufacturer is optional. -
GetInfoFullDataFromManufacturerModelVersion
Get full range data (including each version) for all cars with the given manufacturer and model name. GetManufacturersFromCategoryAndType(info, ") returns a list of manufacturers. Both manufacturer and model are compulsory. Version is optional. -
GetInfoMinMaxDataFromManufacturerModel
Get min/max range data for all cars with the given manufacturer and model name. GetManufacturersFromCategoryAndType(info, ") returns a list of manufacturers. Model name is optional. -
GetInfoSearchFields
Get valid list of search fields for use in GetInfoFromManufacturerSearchArgList. -
GetLatestVideos
Returns list of our latest videos, ordered latest first. Howmany, if given, returns only that number of matches, and defaults to 5 if not given. -
GetLatestVideosByManufacturerAndDays
Returns list of our latest videos, ordered latest first. Howmany, if given, returns only that number of matches, and defaults to 5 if not given. Manufacturer is a comma separated list of manufacturers to constrain the search by. Days restricts the search to videos added in that number of days. -
GetLaunchEvents
Return all launch list events, or filtered if manufacturer and/or category is given. Howmany, if given, limits the number of records returned. FuturePast one of future/past/all, defaulting to future. PastMonths (optional) - limit past matches to this number of months in the past only. FutureMonths (optional) - limit future matches to this number of months in the future. ShowWholeMonth - yes/no (default no) - if set to yes, the future months/past months searches start at the beginning of the current month so that a complete launch pack for the current month is returned. All fields are optional. -
GetLaunchFromID
Return a particular launch list record specified by id. -
GetLaunches
Return all launch list info, or filtered if manufacturer and/or category is given. Howmany, if given, limits the number of records returned. Ordering is one of date/revdate/title/revtitle/category/revcategory, defaulting to date. FuturePast one of future/past/all, defaulting to future. PastMonths (optional) - limit past matches to this number of months in the past only. FutureMonths (optional) - limit future matches to this number of months in the future. ShowWholeMonth - yes/no (default no) - if set to yes, the future months/past months searches start at the beginning of the current month so that a complete launch pack for the current month is returned. All fields are optional. -
GetManufacturerComingSoon
Returns a list of upcoming changes for manufacturers. The manufacturers argument is optional and if blank returns information for each manufacturer. -
GetManufacturerIncentives
Returns a list of incentive schemes run by manufacturers. The manufacturers argument is optional and if blank returns information for each manufacturer. -
GetManufacturerWhatsNew
Returns a list of recent updates for manufacturers. The manufacturers argument is optional and if blank returns information for each manufacturer. -
GetManufacturers
Returns a list of all manufacturers -
GetManufacturersFromCategoryAndType
Find all manufacturers for a given category or type of article. Category, Type and ReturnCap are all optional. Type is one of new/used/family/longterm/van/launches/schemes/motorbike/caravan. DoCapSearch returns CAP Manufacturer data if set to True. -
GetModelsFromManufacturerCategoryAndType
Return the model names from all reviews that match manufacturer, category (as returned by GetCategories) and article type. Manufacturer must be given. Category is optional. Category may only be used for new and used car reviews. Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2/caravan/motorbike. More than one type can be passed in if separated by commas - e.g. new,womans,used. Note that only models for which reviews currently exist in our database will be returned. If docapsearch is set to true, the models returned are cap model strings; if docapmodellong is set to true this will be the longer version (e.g. A3 HATCHBACK), otherwise it will be the shorter version (e.g. A3) -
GetMonthlyTopTen
Return a list of the best selling cars this month. -
GetNewsItemFromID
Returns single news item with the given ID. -
GetNewsItemKeywords
Returns list of news items, ordered latest first. Howmany, if given, returns only that number of matches. Days is optional, and if given limits the results to just reviews from the past N days. -
GetNewsItems
Returns list of news items, ordered latest first. Howmany, if given, returns only that number of matches. Days is optional, and if given limits the results to just reviews from the past N days. -
GetNewsItemsFromKeyword
Returns list of news items, ordered latest first. Howmany, if given, returns only that number of matches. Keyword is the keyword to search for. -
GetPhotoClasses
Get list of photo classes, for use in GetPhotoTypes() -
GetPhotosFromPhotoClass
Get list of photos without types attached, and a list of photo types, for use in GetPhotosFromType(). Photoclasses is mandatory -
GetPhotosFromSubSubType
Get list of photos with types, subtype and subsubtype attached. Photoclasses, type, subtype and subsubtype are mandatory -
GetPhotosFromSubType
Get list of photos with types and subtype attached, but no subsubtype, and a list of subsubtypes for use in GetPhotosFromSubSubType(). Photoclasses, type, and subtype are mandatory -
GetPhotosFromType
Get list of photos with types but no subtype attached, and a list of subtypes, for use in GetPhotosFromSubType(). Photoclasses and type are mandatory -
GetPreferences
Returns a list of all preference types for use in GetVehicleFromCategoryAndPreferences and GetUsedVehicleFromCategoryAndPreferences -
GetPriceFullDataFromManufacturerModelVersion
Get full price data (including each version) for all cars with the given manufacturer and model name. GetManufacturersFromCategoryAndType(info, ") returns a list of manufacturers. Both manufacturer and model are compulsory. Version is optional. -
GetPriceMinMaxDataFromManufacturerModel
Get min/max price data for all cars with the given manufacturer and model name. GetManufacturersFromCategoryAndType(info, ") returns a list of manufacturers. Model name is optional. -
GetResizedImage
Returns a local path (add http://www.caranddriving.com on the front to get the full url) to a resized image in 'message'. Width and Height are the new height of the image, in pixels. If either dimension is zero, the image is resized keeping the aspect ratio the same. DPI is dots per inch, and if not given defaults to 72. Images are only created temporarily - they are removed after 1 hour. -
GetReviewDetailsFromID
Get a review given an ID from GetReviews... or GetTitles... calls. GetSummaries is optional - set to 'true' to include 150, 250 and 500 word summaries with the result if available, or nolinked to get summaries but no linked reviews . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetReviewsFromCapCode
Get full details of all reviews matching the given CAP code (alphanumeric string). Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2. More than one type can be passed in if separated by commas - e.g. new,womans,used. ; more than one capcode can be passed in if separated by commas. GetSummaries is optional - set to 'true' to include 150, 250 and 500 word summaries with the result if available. . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetReviewsFromCapID
Get full details of all reviews matching the given CAP ID (number). Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2. More than one type can be passed in if separated by commas - e.g. new,womans,used. GetSummaries is optional - set to 'true' to include 150, 250 and 500 word summaries with the result if available. . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetReviewsFromCategoryTypeAndPreferences
Recommend vehicles according to scores assigned to user preferences. Category, type and pref1 are mandatory; pref2 and pref3 are optional. Category must be in the GetCategories() list; Pref1, pref2 and pref3 must be from the GetPreferences() list; type must be from the GetTypes() list, typically 'used' or 'new'. Howmany is optional, and if given, limits the results to that number of reviews. Set hasphotosonly to true to return only reviews with photos attached, and hasvideosonly to true to return only reviews with videos attached. GetSummaries is optional - set to 'true' to include 150, 250 and 500 word summaries with the result if available. Set RangeReviewsOnly to true to return range reviews. . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetReviewsFromManufacturerCategoryAndType
Return the full review data that matches manufacturer, category (as returned by GetCategories) and article type. Either manufacturer or category must be given. Car Name is optional, and may be any single word from the car name, e.g. Fiesta. Category may only be used for new and used car reviews. Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2/caravan/motorbike. More than one type can be passed in if separated by commas - e.g. new,womans,used. Ordering is optional, and one of title/date/revtitle/revdate/rangetitle/rangedate/rangerevdate/rangerevtitle/typetitle/typedate/typerevtitle/typerevdate/typerangetitle/typerangedate/typerangerevdate/typerangerevtitle (range on the front indicates put 'range articles' first in the results list; type on the front indicates 'sort by type first'), defaulting to title. Howmany is optional, and if given, limits the results to that number of reviews. Set hasphotosonly to true to return only reviews with photos attached, and hasvideosonly to true to return only reviews with videos attached. GetSummaries is optional - set to 'true' to include 150, 250 and 500 word summaries with the result if available. If docapsearch is set to true, the carname will match against cap model data, and must be either a long or a short cap model string (either will work). If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetReviewsFromManufacturerSearchArgList
Get reviews for cars which match the given list of constraints (field/operand/value, where operand is one of eq/ne/lt/gt/lte/gte) in array of search arg format. Manufacturer is optional. -
GetReviewsFromManufacturerSearchString
Get list of reviews for cars which match the given list of constraints in string format (#field1;lt;value1#field2;eq;value2#...) (List of field/operand/value triplets, where operand is one of eq/ne/lt/gt/lte/gte). Converts the string to versiondata format, and calls GetReviewsFromManufacturerSearchArgList, so functionally identical. Manufacturer is optional. -
GetReviewsOfTheWeek
Get our current featured reviews (changes weekly). -
GetSteeringColumnDetailsFromID
Gets a Steering Column article with the given ID -
GetSteeringColumnFromKeywordAndWordCount
Returns a list of Steering Column articles with the given keyword (from GetSteeringColumnKeyWords) and wordcounts. Howmany, if given, limits the number of results returned. All arguments are optional. Howmany, minwords and Maxwords if given are integers -
GetSteeringColumnKeywords
Returns a list of keywords for use in GetSteeringColumnFromKeywordAndWordCount -
GetTitlesFromCapCode
Get titles of all reviews matching the given CAP code (alphanumeric string). Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2/caravan/motorbike. More than one type can be passed in if separated by commas - e.g. new,womans,used; more than one capcode can be passed in if separated by commas. . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetTitlesFromCapID
Get titles of all reviews matching the given CAP ID (number). Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2/caravan/motorbike. More than one type can be passed in if separated by commas - e.g. new,womans,used. . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetTitlesFromCategoryTypeAndPreferences
Recommend vehicles according to scores assigned to user preferences. Category, type and pref1 are mandatory; pref2 and pref3 are optional. Category must be in the GetCategories() list; Pref1, pref2 and pref3 must be from the GetPreferences() list; type must be from the GetTypes() list, typically 'used' or 'new'. Howmany is optional, and if given, limits the results to that number of reviews. Set hasphotosonly to true to return only reviews with photos attached, and hasvideosonly to true to return only reviews with videos attached. . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetTitlesFromManufacturerCategoryAndType
Return the titles (and some other minimal data) of all reviews that match manufacturer, category (as returned by GetCategories) and article type. Either manufacturer or category must be given. Car Name is optional, and may be any single word from the car name, e.g. Fiesta. Category may only be used for new and used car reviews. Type is optional, defaulting to all, and if given must be one of all/new/used/longterm/van/family/new1/new2/caravan/motorbike. More than one type can be passed in if separated by commas - e.g. new,womans,used. Ordering is optional, title/date/revtitle/revdate/rangetitle/rangedate/rangerevdate/rangerevtitle/typetitle/typedate/typerevtitle/typerevdate/typerangetitle/typerangedate/typerangerevdate/typerangerevtitle (range on the front indicates put 'range articles' first in the results list; type on the front indicates 'sort by type first'), defaulting to title. Howmany is optional, and if given, limits the results to that number of reviews. Set hasphotosonly to true to return only reviews with photos attached, and hasvideosonly to true to return only reviews with videos attached. Set RangeReviewsOnly to true to return range reviews. If docapsearch is set to true, the carname will match against cap model data, and must be either a long or a short cap model string (either will work). Set doskiplinkedreviews to true to not include linked review information (quicker). . If liveonly is set to false, all reviews, including retired/replaced reviews, are returned. This defaults to true. -
GetTitlesFromManufacturerSearchArgList
Get titles of reviews for cars which match the given list of constraints (field/operand/value, where operand is one of eq/ne/lt/gt/lte/gte) in array of search arg format. Manufacturer is optional. -
GetTitlesFromManufacturerSearchString
Get review titles for cars which match the given list of constraints in string format (#field1;lt;value1#field2;eq;value2#...) (List of field/operand/value triplets, where operand is one of eq/ne/lt/gt/lte/gte). Converts the string to versiondata format, and calls GetTitlesFromManufacturerSearchArgList, so functionally identical. Manufacturer is optional. -
GetTopReviewOfTheWeek
Get a single 'headline review' (changes weekly). -
GetTypes
Returns a list of article types - new/used/family/longterm etc. -
GetUsedCarSchemeFromID
Get details of franchise scheme. -
GetUsedCarSchemeTitles
Get minimal information on a list of franchise schemes (no paragraphs of text). Manufacturer is optional (if not present all are returned) -
GetUsedCarSchemes
Get list of franchise schemes. Manufacturer is optional (if not present all are returned) -
GetUsedCategoryGuideFromID
Get details of used car category guide given a category id from GetUsedCategoryGuides or GetUsedCategoryGuideTitles -
GetUsedCategoryGuideTitles
Returns list of used car category guide summaries. The category id can be fed into GetUsedCategoryGuideFromID to get the full record. -
GetUsedCategoryGuides
Returns list of the full details of all the used car category guides. -
GetVersion
Get the version number of the webservice as a string. -
HelloWorld
Test function that returns 'Hello World'. -
RefreshCache
Internal use only. -
RefreshImagesTest
Internal Use Only. -
TestOK
Internal use only.