{ "opencollection": "1.0.0", "info": { "name": "Car Configurator Components References API", "version": "2.0" }, "items": [ { "info": { "name": "References", "type": "folder" }, "items": [ { "info": { "name": "Get All Available Markets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets", "params": [ { "name": "language", "value": "", "type": "query", "description": "This is a ISO language string e.g. 'de' and is spoken in Austria 'AT', Germany 'DE' and Swiss 'CH'." }, { "name": "country", "value": "", "type": "query", "description": "This is a ISO country string e.g. Germany 'DE' or Swiss 'CH'." }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get all available `Markets`. Optional query params **language** or **country** may be used to filter the result." }, { "info": { "name": "Get the Market with the Given marketId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Gets the `Market` for the given **marketId**. There are no query parameters to filter the result." }, { "info": { "name": "Get All Available Bodies for the Given marketId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/bodies", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "classId", "value": "", "type": "query", "description": "This is a class id e.g. '176' for 'A-Class' in Germany." }, { "name": "bodyId", "value": "", "type": "query", "description": "This is a body id e.g. '1' for 'Limousine' in Germany." }, { "name": "productGroups", "value": "", "type": "query", "description": "Specifies to which product groups the vehicles belong which should be returned. The product groups are separated from each other by a comma and are case sensitive. Allowed values are:\n * PKW\n * VAN\n * SMART" }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get all available `VehicleBodies` for the given **marketId**. Optional query params **classId** **bodyId** or **productGroups** may be used to filter the result and must conform to the pattern [0-9A-Z_-]+." }, { "info": { "name": "Get the Body for the Given marketId and bodyId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/bodies/:bodyId", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "bodyId", "value": "", "type": "path", "description": "This is a body id e.g. '1' for 'Limousine' in Germany." }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get the `VehicleBody` for the given **marketId** and **bodyId**." }, { "info": { "name": "Get All Available Classes for the Given marketId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/classes", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "classId", "value": "", "type": "query", "description": "This is a class id e.g. '176' for 'A-Class' in Germany." }, { "name": "bodyId", "value": "", "type": "query", "description": "This is a body id e.g. '1' for 'Limousine' in Germany." }, { "name": "productGroups", "value": "", "type": "query", "description": "Specifies to which product groups the vehicles belong which should be returned. The product groups are separated from each other by a comma and are case sensitive. Allowed values are:\n * PKW\n * VAN\n * SMART" }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get all available `VehicleClasses` objects for the given **marketId**. Optional query params **classId**, **bodyId** or **productGroups** may be used to filter the result and must conform to the pattern [0-9A-Z_-]+." }, { "info": { "name": "Get the Class for the Given marketId and classId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/classes/:classId", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "classId", "value": "", "type": "path", "description": "This is a class id e.g. '176' for 'A-Klasse' in Germany." }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get the `VehicleClass` for the given **marketId** and **classId**." }, { "info": { "name": "Get All Available Models for the Given marketId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/models", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "classId", "value": "", "type": "query", "description": "This is a class id e.g. '176' for 'A-Class' in Germany." }, { "name": "bodyId", "value": "", "type": "query", "description": "This is a body id e.g. '1' for 'Limousine' in Germany." }, { "name": "baumuster4prefix", "value": "", "type": "query", "description": "The first four digits of a baumuster are called baumuster4prefix e.g. '1760' for 'Berline' in France." }, { "name": "baumuster", "value": "", "type": "query", "description": "This is a baumuster e.g. '176042' for 'A 180 Limousine' in Germany." }, { "name": "nationalSalesType", "value": "", "type": "query", "description": "This is the national sales type (NST) of a distinct baumuster. There is no predefined pattern for the NST, each market defines its NST. e.g. 'E07' in France, 0001 in Germany and ZA1 in South Africa Using the NST markets can define market specific conditions. e.g. different initial configuration, etc." }, { "name": "productGroups", "value": "", "type": "query", "description": "Specifies to which product groups the vehicles belong which should be returned. The product groups are separated from each other by a comma and are case sensitive. Allowed values are:\n * PKW\n * VAN\n * SMART" }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get the available `VehicleModels` for the given **marketId**. Optional query params **classId**, **bodyId**, **baumuster4prefix**, **baumuster**, **nationalSalesType** or **productGroups** maybe used to filter the result. The baumuster4prefix must conform to the pattern [0-9]{4}." }, { "info": { "name": "Get the Model for the Given marketId and modelId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/models/:modelId", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "modelId", "value": "", "type": "path", "description": "Minimal string that identifies a model e.g. '176042_002'. If no nationalSalesType is available, the modelId only consists of the baumuster e.g. '176042'." }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get the `VehicleModel` object for the given **marketId** and **modelId**." }, { "info": { "name": "Get All Configured Active Product Groups for the Given marketId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/markets/:marketId/productgroups", "params": [ { "name": "marketId", "value": "", "type": "path", "description": "This is a ISO 3166 language country string e.g. 'de_DE' or 'en_GB'." }, { "name": "fieldsFilter", "value": "", "type": "query", "description": "Specifies which fields should be included in the result. If this filter is not used, per default all fields are returned." } ] }, "docs": "Get all configured active product groups for the given **marketId**." }, { "info": { "name": "countriesGET", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/countries", "params": [ { "name": "page", "value": "", "type": "query", "description": "The index of the page to be returned. If this parameter is omitted, the first page will be returned.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The index of the page to be returned. If this parameter is omitted, the first page will be returned.\n" } ] }, "docs": "This request returns the countries supported by the Dealer API" } ] } ], "bundled": true }