Variants & Vehicles API: PatchVariantProfile

API endpoints for vehicle variants, makes, models, and equipment

PatchVariantProfile

This method edits a variant profile.

This is an embedded section within the patchVariant API.
Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Variants/patchVariants(https://api.catch-e.com/docs/#/Quote%20%2F%20Variants/patchVariants)

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on QuoteVariants:Update

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

Use the HTTP Method 'PATCH' for consuming this web service.

URL Examples

https://api.catch-e.com/qt/variants/{variant_id}

Headers

KeyFormatNotesMandatory
Audit-User-IdstringPass a user_id here to create audit records with this user's details. This can only be done if the authenticated API user has Roles / Apis checked for the permission Audit:UserIdOverrideNo
Time-ZonestringRequest will be processed in the specified timezone. The timezone value can be given in several formats, none of which are case sensitive: As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'. As a string indicating an offset from UTC of the form :MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10; Default value : UTCNo

Body (JSON)

JSON FieldFormatNotesMandatory
variant_profile {no
variantprofileidstringMust be a matching existing record for the corresponding {variant_id} (in Path/URL).no
maintenanceserviceprofile_idstringno
tyre_idstringno
tyrespersetnumberv
tyrekmintervalnumberno
vehicletypeidstringno
datedateFormat yyyy-mm-dd. Defaults to '0000-00-00'.no
delivery_metronumberno
delivery_countrynumberno
residualadjustmentratenumberno
insurancetypeidstringno
relief_vehiclenumberno
}

Input Fields (JSON)

{ "variant_profile": { "maintenance_service_profile_id": "string", "tyre_id": "string", "tyres_per_set": 0, "tyre_km_interval": 0, "vehicle_type_id": "string", "date": "2023-04-20", "delivery_metro": 0, "delivery_country": 0, "residual_adjustment_rate": 0, "insurance_type_id": "string", "relief_vehicle": 0 } }

Response Details

Validation MessagesComments
200 OK
{ "acceleration": 5.7, "air_pollution_rating": 6.1, "ancap_rating": 5, "average_retail_net": 50000.77, "average_wholesale_net": 40000.77, "body_type_id": "100006", "build_year": 1970, "cam": "DOHC", "co2_emissions": 177, "configuration": "Config", "country": "Aussie", "current_vehicle_flag": "Y", "cylinders": 8, "data_source_id": "100000", "description": "An oldie but a good vehicle nonetheless", "doors": 5, "drive_type": "Rear Wheel Drive", "engine_cc": 2777, "engine_code": "ENGINECODE", "engine_configuration": "in-line", "engine_cycle": "MP1970V01", "engine_litres": "7", "engine_type": "Piston", "external_reference": "ExtReference2", "front_tyre_size": "235/60 R22", "fuel_capacity": 77, "fuel_combined": 9.1, "fuel_country": 8.1, "fuel_delivery": "MPI", "fuel_metro": 10.1, "fuel_type_translation_id": "100033", "gear_location": "Floor", "gears": 8, "good_retail_net": 55000.77, "good_wholesale_net": 45000.77, "greenhouse_rating": 5.1, "induction": "Aspirated", "kerb_weight": 2377, "list_price_gross": 77770.77, "list_price_gst": 7770.08, "list_price_net": 69930.69, "manufacturer_model_code": "MPTST1970", "model_id": "100569", "model_month": 12, "model_year": 1981, "overall_green_star_rating": 7.1, "payload": 477, "power_kw": 444, "power_plant_type_id": "11989672791877091928", "power_rpm": 4444, "private_maximum": 0, "private_minimum": 0, "rear_tyre_size": "235/60 R22", "seats": 5, "series": "One", "service_kms": 15000, "service_mths": 12, "service_profile_id": "0", "short_description": "An oldie but a goody", "status_flag": "active", "steering": "Rack & Pinion", "torque": 277, "torque_rpm": 4777, "towing_capacity": 3577, "trade_maximum": 0, "transmission": "Automatic", "valves_per_cylinder": 4, "variant_code": "MPAU1980APIVARIANT1", "variant_code_next": "NOT Applicable", "variant_code_previous": "", "variant_id": "182511", "variant_name": "GoGo Gone", "variant_profiles": { "variant_profile_id": "181180", "variant_id": "182511", "maintenance_service_profile_id": "100012", "tyre_id": "100001", "tyres_per_set": 4, "tyre_km_interval": 45001, "vehicle_type_id": "100001", "date": "1971-01-01", "delivery_metro": 777.77, "delivery_country": 888.88, "residual_adjustment_rate": 0.5, "insurance_type_id": "100004", "relief_vehicle": 0 }, "variant_sub_name": "Faster", "vehicle_type_id": "100001", "vfacts_class": "Medium", "vfacts_segment": "Medium2", "warranty_kms": 200000, "warranty_years": 5, "weight": 1077, "wheel_base": 2777, "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/182511" } }}

| A successful response returns all fields in the and tables. |
| 422 Unprocessable Entity | | |

{ "validation_messages": { "variant_profile": { "variant_profile_id": { "noRecordFound": "No variant associated record matching the input was found" } } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

| It looks like this Variant Profile is not linked to the Variant ID. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |

Get a list of variants

This method will list the makes and its detail.

This method requires the QuoteVariants:Get permission to be associated with your role.

By default only 'web_services' role is linked in

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Input Fields (Header)

  • Header should contain the 'Accept' Key with the Value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input Fields (Body)

  • make_id (string) — Make id No
  • model id (string) — Model id No
  • variant_code (string) — Variant code. This field supports the wildcard % operator (See Wildcard % operator notes below). No
  • variant_name (string) — Variant name. This field supports the wildcard % operator (See Wildcard % operator notes below). No
  • bodytypeid (string) — Body type id No
  • datasourceid (string) — Data source id No
  • profilerequiredflag (string) — If yes, display variants that have a qtvariantprofiles record with a 'date' valid for the current invocation date. I.e. the must be on or before the date the API is run. yes No
  • includeinactiveflag (string) — Set to yes if inactive items required in the list. Defaults to 'no' no No
  • page (string) — Page number. Defaults to 1 1 No
  • page_size (string) — Page size. Defaults to 25 records per page. 25 No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Input URL Examples

https://api.test.catch-e.com/qt/variants?make_id=100009&model_id=100157&model_year=2001&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=5

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/?variant_code=AUVTESL2017AEAT&page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/variants/?variant_code=AUVTESL2017AEAT" }, "last": { "href": "https://api.test.catch-e.com/qt/variants/?variant_code=AUVTESL2017AEAT&page=1" } }, "_embedded": { "qt_variants": [ { "acceleration": 2.7, "air_pollution_rating": 0, "ancap_rating": 5, "average_retail_net": 95818.18, "average_wholesale_net": 83636.36, "battery_ac_charge_outlet": "", "battery_ac_fast_charge": "240V 40A 9.6kW - 625 min", "battery_capacity": 100, "battery_charge_socket_type": "Type 2", "battery_dc_fast_charge": "Tesla Supercharger - 0-80%", "battery_warranty_kms": 0, "battery_warranty_years": 0, "body_type_id": "100006", "build_year": 2017, "cam": "", "co2_emissions": 0, "configuration": "", "country": "UNITED STATES", "current_vehicle_flag": "N", "cylinders": 0, "data_source_id": "100001", "description": "P100D Sportback Sedan 5dr Reduction Gear 1sp AWD AC450kW", "doors": 5, "drive_type": "Four Wheel Drive", "electric_engine_km_range": 0, "energy_consumption": 200, "engine_cc": 0, "engine_code": "", "engine_configuration": "", "engine_cycle": "", "engine_litres": "", "engine_type": "Electric", "external_reference": "", "front_tyre_size": "245/45 R19", "fuel_capacity": 0, "fuel_combined": 0, "fuel_country": 0, "fuel_delivery": "", "fuel_metro": 0, "fuel_type_translation_id": "100018", "gear_location": "Column", "gears": 1, "good_retail_net": 104272.73, "good_wholesale_net": 90681.82, "greenhouse_rating": 0, "induction": "", "kerb_weight": 0, "list_price_gross": 251577, "list_price_gst": 19043.54, "list_price_net": 190435.38, "make_id": "100072", "manufacturer_model_code": "", "model_id": "131148", "model_month": 7, "model_year": 2017, "overall_green_star_rating": 0, "payload": 0, "power_kw": 0, "power_plant_type_id": "11989672791877091925", "power_rpm": 0, "private_maximum": 0, "private_minimum": 0, "rear_tyre_size": "245/45 R19", "seats": 5, "series": "", "service_kms": 20000, "service_mths": 12, "service_profile_id": "0", "short_description": "TESLA MODEL S P100D SPORTBACK SEDAN AWD", "status_flag": "active", "steering": "Rack and Pinion", "torque": 0, "torque_rpm": 0, "towing_capacity": 0, "trade_maximum": 0, "trade_minimum": 0, "transmission": "Reduction Gear", "valves_per_cylinder": 0, "variant_code": "AUVTESL2017AEAT", "variant_code_next": "AUVTESL2017AEAY", "variant_code_previous": "AUVTESL2017AEAO", "variant_id": "158007", "variant_name": "P100D Sportback Sedan AWD", "variant_paints": null, "variant_profiles": { "variant_profile_id": "156712", "variant_id": "158007", "maintenance_service_profile_id": "100015", "tyre_id": "0", "tyres_per_set": 4, "tyre_km_interval": 45000, "vehicle_type_id": "100001", "date": "0000-00-00", "delivery_metro": 600, "delivery_country": 800, "residual_adjustment_rate": 0, "insurance_type_id": "0", "relief_vehicle": 0 }, "variant_sub_name": "", "vehicle_type_id": "100006", "vfacts_class": "", "vfacts_segment": "", "warranty_kms": 80000, "warranty_years": 4, "weight": 0, "wheel_base": 2960, "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/158007" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1}

Error Codes

DetailComments
401 - Unauthorized
"detail": "Unauthorized"Login token has expired. You need to generate new token.
403 - Forbidden
"detail": "Forbidden"You do not have permissions for this request.
DetailValidation MessagesComments
422 - Unprocessable Entity
"detail": "Failed Validation""make_id": { "notDigits": "The input must contain only digits"}make_id passed needs to be integer.
"detail": "Failed Validation""model_id": { "notDigits": "The input must contain only digits"}model_id passed needs to be integer.
"detail": "Failed Validation""model_year": { "notGreaterThanInclusive": "The input is not greater than or equal to '1920'" }model_year passed cannot be less than 1920.
"detail": "Failed Validation""model_year": { "notLessThanInclusive": "The input is not less or equal than '2021'" }model_year passed cannot be greater than the following year.
"detail": "Failed Validation""datasourceid": { "notDigits": "The input must contain only digits"}datasourceid passed needs to be integer.
"detail": "Failed Validation""bodytypeid": { "notDigits": "The input must contain only digits"}bodytypeid passed needs to be integer.
"detail": "Failed Validation""variant_name": { "stringLengthTooShort": "The input is less than 2 characters long" }variant_name length should be greater than one character.
"detail": "Failed Validation""variant_code": { "stringLengthTooShort": "The input is less than 2 characters long" }variant_code length should be greater than one character.

Get a variant by variant id

This method will return requested variant details.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on QuoteVariants:Get

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Input Fields (Header)

  • Header should contain the 'Accept' Key with the Value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input Fields (Body)

FieldFormatNotesMandatory
variant_idstringVariant idYes

Input URL Examples

https://api.test.catch-e.com/qt/variants/100000

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/?variant_code=AUVTESL2017AEAT&page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/variants/?variant_code=AUVTESL2017AEAT" }, "last": { "href": "https://api.test.catch-e.com/qt/variants/?variant_code=AUVTESL2017AEAT&page=1" } }, "_embedded": { "qt_variants": [ { "acceleration": 2.7, "air_pollution_rating": 0, "ancap_rating": 5, "average_retail_net": 95818.18, "average_wholesale_net": 83636.36, "battery_ac_charge_outlet": "", "battery_ac_fast_charge": "240V 40A 9.6kW - 625 min", "battery_capacity": 100, "battery_charge_socket_type": "Type 2", "battery_dc_fast_charge": "Tesla Supercharger - 0-80%", "battery_warranty_kms": 0, "battery_warranty_years": 0, "body_type_id": "100006", "build_year": 2017, "cam": "", "co2_emissions": 0, "configuration": "", "country": "UNITED STATES", "current_vehicle_flag": "N", "cylinders": 0, "data_source_id": "100001", "description": "P100D Sportback Sedan 5dr Reduction Gear 1sp AWD AC450kW", "doors": 5, "drive_type": "Four Wheel Drive", "electric_engine_km_range": 0, "energy_consumption": 200, "engine_cc": 0, "engine_code": "", "engine_configuration": "", "engine_cycle": "", "engine_litres": "", "engine_type": "Electric", "external_reference": "", "front_tyre_size": "245/45 R19", "fuel_capacity": 0, "fuel_combined": 0, "fuel_country": 0, "fuel_delivery": "", "fuel_metro": 0, "fuel_type_translation_id": "100018", "gear_location": "Column", "gears": 1, "good_retail_net": 104272.73, "good_wholesale_net": 90681.82, "greenhouse_rating": 0, "induction": "", "kerb_weight": 0, "list_price_gross": 251577, "list_price_gst": 19043.54, "list_price_net": 190435.38, "make_id": "100072", "manufacturer_model_code": "", "model_id": "131148", "model_month": 7, "model_year": 2017, "overall_green_star_rating": 0, "payload": 0, "power_kw": 0, "power_plant_type_id": "11989672791877091925", "power_rpm": 0, "private_maximum": 0, "private_minimum": 0, "rear_tyre_size": "245/45 R19", "seats": 5, "series": "", "service_kms": 20000, "service_mths": 12, "service_profile_id": "0", "short_description": "TESLA MODEL S P100D SPORTBACK SEDAN AWD", "status_flag": "active", "steering": "Rack and Pinion", "torque": 0, "torque_rpm": 0, "towing_capacity": 0, "trade_maximum": 0, "trade_minimum": 0, "transmission": "Reduction Gear", "valves_per_cylinder": 0, "variant_code": "AUVTESL2017AEAT", "variant_code_next": "AUVTESL2017AEAY", "variant_code_previous": "AUVTESL2017AEAO", "variant_id": "158007", "variant_name": "P100D Sportback Sedan AWD", "variant_paints": null, "variant_profiles": { "variant_profile_id": "156712", "variant_id": "158007", "maintenance_service_profile_id": "100015", "tyre_id": "0", "tyres_per_set": 4, "tyre_km_interval": 45000, "vehicle_type_id": "100001", "date": "0000-00-00", "delivery_metro": 600, "delivery_country": 800, "residual_adjustment_rate": 0, "insurance_type_id": "0", "relief_vehicle": 0 }, "variant_sub_name": "", "vehicle_type_id": "100006", "vfacts_class": "", "vfacts_segment": "", "warranty_kms": 80000, "warranty_years": 4, "weight": 0, "wheel_base": 2960, "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/158007" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1}

Error Codes

DetailComments
401 - Unauthorized
"detail": "Unauthorized"Login token has expired. You need to generate new token.
403 - Forbidden
"detail": "Forbidden"You do not have permissions for this request.
404 - Not Found
"detail": "Invalid variant id"Entered variant_id cannot be found.