Quote & Lease Operations API: Qq Vehicle lookup getMakes

API endpoints for quote (Qt_*) and lease (Qq_*) operations and fleet reports

Qq Vehicle lookup getMakes

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get a list of vehicle makes as make_id / name pairs. Suitable for use in a list box.

Makes are linked to Varaiants, and Variants are excluded if they have a status of 'pending'. So if all the Variants for a particular Make are at status 'pending', that Make will not be returned in the list.

Input Fields

	Query string key	Format	Notes	Mandatory
1	profile_required	yes/no	If yes only makes for variants that have an active qtvariantprofile record will be included. The default is no.	no
2	rownumberflag	yes/no	If yes will make each node unique i.e. , … if no all nodes will be the same i.e. . The default is yes.	no
3	data_source	varchar	The data source, eg. redbook, glass. Default is redbook	no

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getMakes?profile_required=yes&login=example1&password=example1

If you are using Glasses data instead of RedBook, you will need to add an additional parameter to define this.

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getMakes?profile_required=yes&data_source=glass&login=example2&password=example2

Output Fields

	XML element	Format	Notes	Mandatory
1	make_id	integer	Unique make identifier	no
2	name	string	Name of make	no

Output Example

100000

ALFA ROMEO

100001

ASIA MOTORS

Error Codes

	Error Codes
1	CATCHEERRORNOMAKES_FOUND
2	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORNOMAKES_FOUND

Qq Vehicle lookup getModelYears

Synopsis

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get a list of model years for a given vehicle model. Suitable for use in a list box, using as both the option and value properties.

Model Years are linked to Varaiants, and Variants are excluded if they have a status of 'pending'. So if all the Variants for a particular Model Year are at status 'pending', that Model Year will not be returned in the list.

Input Fields

	Query string key	Format	Notes	Mandatory
1	model_id	integer	Unique model identifier	yes
2	profile_required	yes/no	If yes only model years for variants that have an active qtvariantprofile record will be included. The default is no.	no
3	rownumberflag	yes/no	If yes will make each node unique i.e. , … if no all nodes will be the same i.e. . The default is yes.	no

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getModelYears/?model_id= 100063

Output Fields

	XML element	Format	Notes	Mandatory
1	model_year	integer	Year e.g. 2007	no

Output Example

2007

2006

Error Codes

	Error Codes
1	CATCHEERRORNOMODEL_ID
2	CATCHEERRORNOMODELYEARSFOUND
3	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORNOMODELYEARSFOUND

Qq Vehicle lookup getModels

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get a list of models for a given vehicle make as modelid / name pairs. Suitable for use in a list box. Note that variants with a qtvariants.status_flag of 'pending' are excluded from the list of models and variants returned.

Models are linked to Varaiants, and Variants are excluded if they have a status of 'pending'. So if all the Variants for a particular Model are at status 'pending', that Model will not be returned in the list.

Input Fields

	Query string key	Format	Notes	Mandatory
1	make_id	integer	Unique make identifier	yes
2	profile_required	yes/no	If yes only models for variants that have an active qtvariantprofile record will be included. The default is no.	no
3	rownumberflag	yes/no	If yes will make each node unique i.e. , … if no all nodes will be the same i.e. . The default is yes.	no
4	data_source	varchar	The data source, eg. redbook, glass. Default is redbook	no

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getModels/?make_id=100001&login=example1&password=example1

If you are using Glasses data instead of RedBook, you will need to add an additional parameter to define this.

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getModels/?make_id=100001&data_source=glass&login=example2&password=example2

Output Fields

	XML element	Format	Notes	Mandatory
1	model_id	integer	Unique model identifier	no
2	name	string	Name of model	no
3	CATCHEERRORTOOMANY_REQUESTS	Rest call requests exceeded the limit set in .

Output Example

100063

147

Error Codes

	Error Codes	Notes
1	CATCHEERRORNOMAKES_FOUND	No Makes found
2	CATCHEERRORNOMODELS_FOUND	No Models found

Error output

CATCHEERRORNOMAKES_FOUND

Qq Vehicle lookup getOptionalEquipment

Synopsis

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get a list of optional equipment and corresponding prices for a given vehicle variant. The value returned is in a Description/List Price (Gross) pair uniquely identified by Optional Equipment ID.

Input Fields

	Query string key	Format	Notes	Mandatory
1	variant_id	integer	Unique variant identifier	yes

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getOptionalEquipment/?variant_id=115637

Output Fields

	XML element	Format	Notes	Mandatory
1	description	string	Optional Equipment	yes
2	listpricegross	string	Gross List Price	yes
3	option_type	string	Option Type	yes

Output Example

Alarm 889.90 factory

Error Codes

	Error Codes
1	CATCHEERRORNOVARIANT_ID
2	CATCHEERRORVARIANTOPTIONALEQUIPMENTNOT_FOUND
3	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORVARIANTOPTIONALEQUIPMENTNOT_FOUND

Qq Vehicle lookup getStandardEquipment

Synopsis

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get a list of standard equipment for a given vehicle variant. The value returned is a Description uniquely identified by Standard Equipment ID.

Input Fields

	Query string key	Format	Notes	Mandatory
1	variant_id	integer	Unique variant identifier	yes

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getStandardEquipment/?variant_id=115637

Output Fields

	XML element	Format	Notes	Mandatory
1	description	string	Standard Equipment	yes

Output Example

Multi-function Steering Wheel

Error Codes

	Error Codes
1	CATCHEERRORNOVARIANT_ID
2	CATCHEERRORVARIANTSTANDARDEQUIPMENTNOT_FOUND
3	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORVARIANTSTANDARDEQUIPMENTNOT_FOUND

Qq Vehicle lookup getVariantPhotos

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get list of photo codes and corresponding types for a given vehicle variant. Photo codes are provided by the vehicle data supplier, and are typically used as the file name for each image. Types describe the orientation of the photo e.g. 'front'.

Input Fields

	Query string key	Format	Notes	Mandatory
1	variant_id	integer	Unique variant identifier	yes
2	data_source	varchar	The data source, eg. redbook, glass. Default is redbook. I.e if you are using Glasses data, this must be specified.	no

Redbook

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getVariantPhotos/?variant_id==136785&login=######&password=######

Glasses

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getVariantPhotos/?variant_id=136785&login=######&password=######&data_source=glass

Output Fields

	XML element	Format	Notes	Mandatory
1	photo_code	string	Photo code provided by data supplier. Used as image file name.	yes
2	type	string	Orientation of the photo, values include 'front', 'rear', 'interior', 'side', 'engine'.	yes

Output Example

AUDI0381

AUDI0380

Error Codes

	Error Codes
1	CATCHEERRORNOVARIANT_ID
2	CATCHEERRORVARIANTPHOTOSNOTFOUND
3	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORVARIANTPHOTOSNOTFOUND

Photo services

Use the photo code acquired above to retrieve a photo. The photo code is also available from the getQuote) service output field photo_code.

There are different services for Redbook and Glasses and they are shown in the examples below. These services do not require a login/password to be passed as they are required in preceding functions.

Redbook

https://clientname.catch-e.net.au/core/services/Redbook/photos/AUS/#PHOTO_CODE#.jpgExample, photo code VOLK5VC1, use:https://demo.catch-e.net.au/core/services/Redbook/photos/AUS/VOLK5VC1.jpg

Glasses

https://clientname.catch-e.net.au/core/services/Glass/photos/AUS/#PHOTO_CODE#.jpgExample, photo code T4I16A, use:https://demo.catch-e.net.au/core/services/Glass/photos/AUS/T4I16A.jpg

Qq Vehicle lookup getVariant

Synopsis

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get field values for a given vehicle variant returning individually requested fields or all fields if none are requested. These values can be used with other services in the lease web services family, e.g. getQuote.

Input Fields

	Query string key	Format	Notes	Mandatory
1	variant_id	integer	Unique variant identifier	yes
2	return[fieldname]*	mixed	Field Name(s) prefixed with 'return_'	no

see Field List below

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getVariant/?variant_id=115637&return_list_price_net=&return_list_price_gst=&login=example1&password=example1

Output Fields

	XML element	Format	Notes	Mandatory
1	[field_name]*	mixed	Field names and values	no

see Field List below

Output Example

36355.00

Error Codes

	Error Codes
1	CATCHEERRORNOVARIANT_ID
2	CATCHEERRORVARIANTNOT_FOUND
3	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORNOVARIANT_ID

Field List

#	Field Name	#	Field Name
1	variant_id	30	engine_configuration
2	variant_code	31	fuel_delivery
3	model_month	32	cam
4	build_year	33	steering
5	description	34	induction
6	short_description	35	power_kw
7	series	36	power_rpm
8	configuration	37	torque
9	variant_name	38	torque_rpm
10	variantsubname	39	wheel_base
11	transmission	40	weight
12	gears	41	payload
13	gear_location	42	towing_capacity
14	doors	43	kerb_weight
15	seats	44	country
16	engine_cc	45	fuel_capacity
17	engine_litres	46	fronttyresize
18	cylinders	47	reartyresize
19	valvespercylinder	48	engine_code
21	drive_type	49	manufacturermodelcode
22	engine_cycle	50	acceleration
23	engine_type	51	warranty_years
24	fuel_metro	52	warranty_kms
25	fuel_country	53	service_kms
26	fuel_combined	54	service_mths
27	listpricegross	55	co2_emissions
28	listpricenet
29	listpricegst

Qq Vehicle lookup getVariants

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use Quotes / Variants APIs instead.

Get a list of variant_id / description pairs for a given vehicle model, model year, and body type. Suitable for use in a list box.

Limiting variant selection

Variants are only selected if they have an 'active' status flag. You can use a scheduled query to exclude variants by setting the status_flag to 'pending'.

Note: 'Pending' may be used in scheduler jobs during the process of updating variant information and service profiles. These should be checked to ensure the update is not disruptive or reversed during routine updates.

Example:

## Set status_flag for commercial vehicles with payload over 1000kgs, and also any vehicle with a list_price_gross of $0, to 'pending' to prevent them being available on a web calculatorUPDATE qt_variants AS t1, qt_body_types AS t2SET t1.status_flag = 'pending'WHERE t1.body_type_id = t2.body_type_id AND ((t2.body_type IN ('UTILITY','CAB CHASSIS','TRAYTOP','BUS','VAN','WAGON','VAN WAGON','BUS CHASSIS') AND payload > '1000') ORt1.list_price_gross = 0);

Input Fields

	Query string key	Format	Notes	Mandatory
1	model_id	integer	Unique model identifier	yes
2	model_year	integer	Year e.g. 2007	yes
3	bodytypeid	integer	Unique body type identify	yes
4	data_source	varchar	The data source, eg. redbook, glass. Default is redbook	no
5	profile_required	yes/no	If yes only variants that have an active qtvariantprofile record will be included. The default is no.	no
6	rownumberflag	yes/no	If yes will make each node unique i.e. , … if no all nodes will be the same i.e. . The default is yes.	no

Input URL Example

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getVariants/?model_id=100063&model_year=2007&body_type_id=100006&login=example1&password=example1

If you are using Glasses data instead of RedBook, you will need to add an additional parameter to define this.

https://yourname.catch-e.net.au/services/qq/vehicle_lookup/getVariants/?model_id=100063&model_year=2007&body_type_id=100006&data_source=glass&login=example2&password=example2

Output Fields

	XML element	Format	Notes	Mandatory
1	variant_id	integer	Unique variant identifier	no
2	description	integer	Variant description	no

Output Example

115637

MY2005 JTD M-JET Hatchback 5dr Man 6sp 1.9DT

115639

MY2005 Selespeed Hatchback 3dr SA 5sp 2.0i

115643

MY2005 Selespeed Hatchback 5dr SA 5sp 2.0i

Error Codes

	Error Codes
1	CATCHEERRORNOMODEL_ID
2	CATCHEERRORNOMODEL_YEAR
3	CATCHEERRORNOBODYTYPEID
4	CATCHEERRORNOVARIANTS_FOUND
5	CATCHEERRORTOOMANY_REQUESTS

Error output

CATCHEERRORNOVARIANTS_FOUND