{
"swagger": "2.0",
"info": {
"version": "4_2_26082_1401",
"title": "TecRMI Services REST API"
},
"host": "rmi-services.tecalliance.net",
"schemes": [
"https"
],
"paths": {
"/rest/Adjust/VehicleHasAdjust": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/VehicleHasAdjust",
"description": "Checks whether the vehicle has adjustment data.",
"operationId": "getAdjust_VehicleHasAdjust",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/List": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/List",
"description": "Delivers a country specific list to generate the adjustment data topic tree for the type id in the given language.",
"operationId": "getAdjust_List",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/MainGroupData": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/MainGroupData",
"description": "Delivers a collection with the adjustment data for the selected vehicle, main group and country.",
"operationId": "getAdjust_MainGroupData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdValueSubGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/SubGroupData": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/SubGroupData",
"description": "Delivers a collection with the adjustment data for the selected vehicle, sub group and country.",
"operationId": "getAdjust_SubGroupData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AdValueSubGroup"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/ItemMpData": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/ItemMpData",
"description": "Delivers a collection with the adjustment data for the selected type, item and country.",
"operationId": "getAdjust_ItemMpData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AdValueItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/MainGroupHtml": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/MainGroupHtml",
"description": "Delivers a country specific string which contains the HTML lines for an adjustment data HTML file.",
"operationId": "getAdjust_MainGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"required": true,
"type": "boolean"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/SubGroupHtml": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/SubGroupHtml",
"description": "Delivers a string which contains the HTML lines for an adjustment data HTML file for the given sub group.",
"operationId": "getAdjust_SubGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"required": true,
"type": "boolean"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/ItemHtml": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/ItemHtml",
"description": "Delivers a string which contains the HTML lines for an adjustment data HTML file for the given item.",
"operationId": "getAdjust_ItemHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"required": true,
"type": "boolean"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/ImageNamesForMainGroup": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/ImageNamesForMainGroup",
"description": "Delivers a country specific collection of strings which contains the picture names necessary for the adjustment data layout.",
"operationId": "getAdjust_ImageNamesForMainGroup",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/ImageNamesForSubGroup": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/ImageNamesForSubGroup",
"description": "Delivers a country specific collection of strings which contains the picture names necessary for the adjustment data layout.",
"operationId": "getAdjust_ImageNamesForSubGroup",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/ImageNamesForItemMp": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/ImageNamesForItemMp",
"description": "Delivers a country specific collection of strings which contains the picture names necessary for the adjustment data layout.",
"operationId": "getAdjust_ImageNamesForItemMp",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Adjust/Image": {
"get": {
"tags": [
"Adjust"
],
"summary": "/rest/Adjust/Image",
"description": "Returns a byte array which contains the requested adjustment data image.",
"operationId": "getAdjust_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/PartsByOe": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/PartsByOe",
"description": "Retrieves a collection of spare parts for the selected TecRMI type id and spare part number in the given language.",
"operationId": "getAudit_PartsByOe",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.PartsByOeMsg.PartialOen} this string has to\r\ncover the whole number (partialOEN = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"required": true,
"type": "string"
},
{
"name": "partialOen",
"in": "query",
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"required": true,
"type": "boolean"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPartData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/TimesWorkListForCoo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/TimesWorkListForCoo",
"description": "Delivers a country specific list to generate the labour times topic tree for the TecRMI type id\r\nwith the selected labour times body id and the selected filters in the given language.",
"operationId": "getAudit_TimesWorkListForCoo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Parameter will not be used at the moment.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/TimesWorkStepsForCoo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/TimesWorkStepsForCoo",
"description": "Delivers a country specific list to generate a labour time work position for the TecRMI \r\ntype Id with the selected labour times body id, item mount position id, kind of repair id\r\nand the selected filters in the given language.",
"operationId": "getAudit_TimesWorkStepsForCoo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Parameter will not be used at the moment.",
"required": false,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/TimesWorkListForApos": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/TimesWorkListForApos",
"description": "Delivers a country specific list to generate the labour times topic tree for the TecRMI \r\ntype id with the selected labour times body id and filters in the given language.",
"operationId": "getAudit_TimesWorkListForApos",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/TimesWorkStepsForApos": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/TimesWorkStepsForApos",
"description": "Delivers a country specific list to generate a labour times position for the TecRMI type id with\r\nthe selected labour times body id, item mount position id, kind of repair id and the selected\r\nfilters in the given language.",
"operationId": "getAudit_TimesWorkStepsForApos",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"required": false,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the vehicle tree ID.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/TimesWorkListForOeNo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/TimesWorkListForOeNo",
"description": "Delivers a country specific list to generate the labour times topic tree for the\r\ngiven type id, body id and the selected filters in the given language.",
"operationId": "getAudit_TimesWorkListForOeNo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.TimesWorkListForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"required": false,
"type": "string"
},
{
"name": "partialOen",
"in": "query",
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"required": true,
"type": "boolean"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/TimesWorkStepsForOeNo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/TimesWorkStepsForOeNo",
"description": "Delivers a country specific list to generate a labour times work position for the\r\ngiven type id, body id, item mount position id, kind of repair id and the selected filters\r\nin the given language.",
"operationId": "getAudit_TimesWorkStepsForOeNo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.TimesWorkStepsForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"required": false,
"type": "string"
},
{
"name": "partialOen",
"in": "query",
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"required": true,
"type": "boolean"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/MaintenanceSubGroupsForCoo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/MaintenanceSubGroupsForCoo",
"description": "Delivers a country specific object to generate the maintenance data topic tree for the\r\nTecRMI type id with the selected maintenance body id and the selected filter in the given language.",
"operationId": "getAudit_MaintenanceSubGroupsForCoo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Parameter will not be used at the moment.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdSubGroups"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/MaintenanceWorkStepsForCoo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/MaintenanceWorkStepsForCoo",
"description": "Delivers a country specific list to generate a labour time work position for the TecRMI type id\r\nwith the selected maintenance body id, item mount position, kind of repair id and the selected\r\nfilter in the given language.",
"operationId": "getAudit_MaintenanceWorkStepsForCoo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the qualifier collection maintenance variants. This value can be fetched\r\nby using the web service method CooGroupQualCols.",
"required": false,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/MaintenanceSubGroupsForApos": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/MaintenanceSubGroupsForApos",
"description": "Delivers a country specific object to generate the maintenance topic tree for the\r\nTecRMI type id with the selected maintenance data body id and the selected filter\r\nin the given language.",
"operationId": "getAudit_MaintenanceSubGroupsForApos",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdSubGroups"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/MaintenanceWorkStepsForApos": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/MaintenanceWorkStepsForApos",
"description": "Delivers a country specific list to generate a maintenance work position for the TecRMI type id\r\nwith the selected maintenance data body id, item mount position id, kind of repair id and the selected\r\nfilter in the given language.",
"operationId": "getAudit_MaintenanceWorkStepsForApos",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"required": false,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/MaintenanceSubGroupsForOeNo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/MaintenanceSubGroupsForOeNo",
"description": "Delivers a country specific object to generate the maintenance topic tree for the TecRMI \r\ntype id with the selected maintenance data body id and filter in the given language.",
"operationId": "getAudit_MaintenanceSubGroupsForOeNo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.MaintenanceSubGroupsForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"required": false,
"type": "string"
},
{
"name": "partialOen",
"in": "query",
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"required": true,
"type": "boolean"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdSubGroups"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Audit/MaintenanceWorkStepsForOeNo": {
"get": {
"tags": [
"Audit"
],
"summary": "/rest/Audit/MaintenanceWorkStepsForOeNo",
"description": "Delivers a country specific list to generate a labour times work position for the\r\ngiven TecRMI type id with the selected maintenance data body id, item mount position id, kind of\r\nrepair id and the selected filter in the given language.",
"operationId": "getAudit_MaintenanceWorkStepsForOeNo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.MaintenanceWorkStepsForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"required": false,
"type": "string"
},
{
"name": "partialOen",
"in": "query",
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"required": true,
"type": "boolean"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/ItemMpIdForGenArt": {
"get": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/ItemMpIdForGenArt",
"description": "Delivers a collection of item mount positions for a TecDoc generic article.",
"operationId": "getBasket_ItemMpIdForGenArt",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "genArtNo",
"in": "query",
"description": "Gets or sets the generic article number to search for.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "genKritNo",
"in": "query",
"description": "Gets or sets the generic criterion number to search for.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genKritValue",
"in": "query",
"description": "Gets or sets the generic criterion value to search for.",
"required": false,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/CalcResultHtml": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/CalcResultHtml",
"description": "Delivers a country specific string which contains HTML-code from which a HTML-File for the calculation result can be generated.",
"operationId": "postBasket_CalcResultHtml",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class CalcResultHtmlMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/CalcResultHtmlMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/CalcResultHtmlWithComplexityReference": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/CalcResultHtmlWithComplexityReference",
"description": "Delivers a country specific string which contains HTML-code from which a HTML-File for the calculation result can be generated.",
"operationId": "postBasket_CalcResultHtmlWithComplexityReference",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class CalcResultHtmlWithComplexityReferenceMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/CalcResultHtmlWithComplexityReferenceMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/CalcResultHtmlWithWorkPositions": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/CalcResultHtmlWithWorkPositions",
"description": "Delivers a country specific string which contains HTML-code from which a HTML-File for the calculation result can be generated.\r\nThe work positions to be calculated are selected by their ItemMpId, KorId, QualColId and only for Md flag.",
"operationId": "postBasket_CalcResultHtmlWithWorkPositions",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class CalcResultHtmlWithWorkPositionsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/CalcResultHtmlWithWorkPositionsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/CalcResultHtmlWithWorkPositionsWithComplexityReference": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/CalcResultHtmlWithWorkPositionsWithComplexityReference",
"description": "Delivers a country specific string which contains HTML-code from which a HTML-File for the calculation result can be generated.\r\nThe work positions to be calculated are selected by their ItemMpId, KorId, QualColId and only for Md flag.",
"operationId": "postBasket_CalcResultHtmlWithWorkPositionsWithComplexityReference",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class CalcResultHtmlWithWorkPositionsWithComplexityReferenceMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/CalcResultHtmlWithWorkPositionsWithComplexityReferenceMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/WorkCalc": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/WorkCalc",
"description": "Delivers a collection containing the calculated work positions for the selected TecRMI type id\r\nand work ids with the given labour times body id and maintenance data body id.",
"operationId": "postBasket_WorkCalc",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class WorkCalcMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkCalcMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InWorkCalcResultValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/WorkCalcWithComplexityReference": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/WorkCalcWithComplexityReference",
"description": "Delivers a collection containing the calculated work positions for the selected TecRMI type id\r\nand work ids with the given labour times body id and maintenance data body id.",
"operationId": "postBasket_WorkCalcWithComplexityReference",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class WorkCalcWithComplexityReferenceMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkCalcWithComplexityReferenceMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InWorkCalcWithComplexityResultValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/WorkCalcWithWorkPositions": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/WorkCalcWithWorkPositions",
"description": "Delivers a collection containing the calculated work positions for the selected TecRMI type id\r\nand work ids with the given labour times body id and maintenance data body id.",
"operationId": "postBasket_WorkCalcWithWorkPositions",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class WorkCalcWithWorkPositionsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkCalcWithWorkPositionsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InWorkCalcResultValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/WorkCalcWithWorkPositionsWithComplexityReference": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/WorkCalcWithWorkPositionsWithComplexityReference",
"description": "Delivers a collection containing the calculated work positions for the selected TecRMI type id\r\nand work ids with the given labour times body id and maintenance data body id.",
"operationId": "postBasket_WorkCalcWithWorkPositionsWithComplexityReference",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class WorkCalcWithWorkPositionsWithComplexityReferenceMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkCalcWithWorkPositionsWithComplexityReferenceMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InWorkCalcWithComplexityResultValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/GenArtsForItemMpIds": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/GenArtsForItemMpIds",
"description": "Delivers a collection with the TecDoc generic article numbers for the given item mount position ids.",
"operationId": "postBasket_GenArtsForItemMpIds",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtsForItemMpIdsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtsForItemMpIdsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InItemMpGenArt"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/GenArtsForWorkIds": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/GenArtsForWorkIds",
"description": "Delivers a collection with all the TecDoc generic article numbers for the given work ids.",
"operationId": "postBasket_GenArtsForWorkIds",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtsForWorkIdsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtsForWorkIdsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InItemMpGenArt"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/PartsForItemMps": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/PartsForItemMps",
"description": "Delivers collection of spare parts for the given item mount positions.",
"operationId": "postBasket_PartsForItemMps",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PartsForItemMpsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PartsForItemMpsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPaintPartSetItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/PartsForItemMpsIncludingQualifiers": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/PartsForItemMpsIncludingQualifiers",
"description": "Delivers collection of spare parts for the given item mount positions. Including a list where the Qualifier Collection identifier is split into its parts.\r\nIf this split list should be used to filter out not suitable parts, if there is no exact filter match use the part labeled with the qualifier collection standard.",
"operationId": "postBasket_PartsForItemMpsIncludingQualifiers",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PartsForItemMpsIncludingQualifiersMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PartsForItemMpsIncludingQualifiersMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPartSetItemMpWithQualifiers"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/PartsForWorks": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/PartsForWorks",
"description": "Delivers all existing spare part information for the given list of work ids.",
"operationId": "postBasket_PartsForWorks",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PartsForWorksMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PartsForWorksMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPaintPartSetItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/PartsForWorksIncludingQualifiers": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/PartsForWorksIncludingQualifiers",
"description": "Delivers all existing spare part information for the given list of work ids. Including a list where the Qualifier Collection identifier is split into its parts.\r\nIf this split list should be used to filter out not suitable parts, if there is no exact filter match use the part labeled with the qualifier collection standard.",
"operationId": "postBasket_PartsForWorksIncludingQualifiers",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PartsForWorksIncludingQualifiersMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PartsForWorksIncludingQualifiersMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPartSetItemMpWithQualifiers"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/PartsForWorksWithWorkPositions": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/PartsForWorksWithWorkPositions",
"description": "Delivers all existing spare part information for the given list of work ids.",
"operationId": "postBasket_PartsForWorksWithWorkPositions",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PartsForWorksWithWorkPositionsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PartsForWorksWithWorkPositionsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPaintPartSetItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/PartsForWorksWithWorkPositionsIncludingQualifiers": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/PartsForWorksWithWorkPositionsIncludingQualifiers",
"description": "Delivers all existing spare part information for the given list of work ids. Including a list where the Qualifier Collection identifier is split into its parts.\r\nIf this split list should be used to filter out not suitable parts, if there is no exact filter match use the part labeled with the qualifier collection standard.",
"operationId": "postBasket_PartsForWorksWithWorkPositionsIncludingQualifiers",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PartsForWorksWithWorkPositionsIncludingQualifiersMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PartsForWorksWithWorkPositionsIncludingQualifiersMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPartSetItemMpWithQualifiers"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Prices/WorkMetadata": {
"post": {
"tags": [
"Basket"
],
"summary": "/rest/Prices/WorkMetadata",
"description": "Gets the metadata associated with the passed labour times work ids.\r\nThe metadata consists of a flag whether there is a hint in the Adjustment data module that new fastener (e.g. new screws or nuts) has to be used for this work.",
"operationId": "postBasket_WorkMetadata",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of message classWorkMetadataMsg",
"required": true,
"schema": {
"$ref": "#/definitions/WorkMetadataMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkMetadata"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/VehicleHasComfortWiring": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/VehicleHasComfortWiring",
"description": "Checks whether comfort wiring data exists for the given TecRMI type id.",
"operationId": "getComfortWiring_VehicleHasComfortWiring",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/ManualList": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/ManualList",
"description": "Delivers a country specific list to generate a manual tree for the TecRMI type id in the selected language.",
"operationId": "getComfortWiring_ManualList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CwdMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/MainGroupHtml": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/MainGroupHtml",
"description": "Delivers a string with country specific content which contains lines of HTML from which an HTML file can be generated.",
"operationId": "getComfortWiring_MainGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/SubGroupHtml": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/SubGroupHtml",
"description": "Delivers a country specific string which contains HTML lines from which an HTML file can be generated.",
"operationId": "getComfortWiring_SubGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/ManualHtml": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/ManualHtml",
"description": "Delivers a country specific string which contains HTML lines of manual.",
"operationId": "getComfortWiring_ManualHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"required": true,
"type": "boolean"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/LinkedComfortWiringDiagrams": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/LinkedComfortWiringDiagrams",
"description": "The result of an m-link is an item number. This method checks whether none, one or more manuals are available for the given country.",
"operationId": "getComfortWiring_LinkedComfortWiringDiagrams",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CwdItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/ImageNamesForComfortWiringManual": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/ImageNamesForComfortWiringManual",
"description": "Delivers a collection of strings which contains the image names necessary for the manual.",
"operationId": "getComfortWiring_ImageNamesForComfortWiringManual",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComfortWiring/Image": {
"get": {
"tags": [
"ComfortWiring"
],
"summary": "/rest/ComfortWiring/Image",
"description": "Returns a byte array which contains the requested comfort wiring diagram image.",
"operationId": "getComfortWiring_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/ApplicationTexts": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/ApplicationTexts",
"description": "Delivers a collection of all application text ids and the corresponding texts in the selected language.",
"operationId": "getCommon_ApplicationTexts",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationText"
}
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/ApplicationText": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/ApplicationText",
"description": "Delivers the application text with the given id in the selected language.",
"operationId": "getCommon_ApplicationText",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "textId",
"in": "query",
"description": "Gets or sets the identifier of the text.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ping": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/ping",
"description": "A ping for the API to test if the service is available and running.",
"operationId": "getCommon_Ping",
"consumes": [],
"produces": [],
"responses": {
"204": {
"description": "No Content"
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/Countries": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/Countries",
"description": "Retrieves a collection of all countries supported by the system. Countries codes are referring to the ISO 3166-1 standard.",
"operationId": "getCommon_Countries",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "kindOfModule",
"in": "query",
"description": "Gets or sets the kind of module after which the collection of supporting countries should be filtered. Possible enumeration values: - `0` = Default
- `1` = Coo
- `2` = CooNew
- `3` = AD
- `4` = BG
- `5` = LT
- `6` = MD
- `7` = DI
- `8` = SOS
- `9` = TD
- `10` = TM
- `11` = WD
- `12` = CO
- `13` = CooUser
- `14` = Ctrl
- `15` = IN
- `16` = VT
- `17` = Info
- `18` = Portal
- `19` = FR
- `20` = MP
- `21` = CWD
- `22` = Paint
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22
]
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdditionalCountryInfo"
}
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/Languages": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/Languages",
"description": "Retrieves a collection of all languages supported by the system. Language codes are referring to the ISO 639-1 standard. By passing null as\r\nLanguagesMsg.LanguageCode the result will be a collection where each language name is written in his own language (eg: en -> English (GB); de -\r\n> Deutsch; ru -> русский; etc). Passing a valid language code by this property all the language names will be in the given language.",
"operationId": "getCommon_Languages",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.\r\nBy passing null the result of the web service method Languages\r\nwill be a collection where each language name is in his own language (eg: en -> English (GB); de -> Deutsch; ru -> русский; etc.\r\nPassing a valid language code by this property all the language names will be in the given language.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdditionalLanguageInfo"
}
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/QualifierGroupList": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/QualifierGroupList",
"description": "Delivers a collection of qualifier groups in the given language.",
"operationId": "getCommon_QualifierGroupList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/QualifierGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/GetPossibleLinkTypes": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/GetPossibleLinkTypes",
"description": "Delivers a collection of possible values for the enum KindOfLinkTypes.",
"operationId": "getCommon_GetPossibleLinkTypes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LinkTypeData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/WorkPosOnlyForReferenceText": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/WorkPosOnlyForReferenceText",
"description": "Gets the text for explaining the 'only for reference' flag in the labour times, maintenance\r\ndata or basket module.",
"operationId": "getCommon_WorkPosOnlyForReferenceText",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/GetAdOnlyForReferenceText": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/GetAdOnlyForReferenceText",
"description": "Gets the text explaing the 'only for reference flag' in technical data or filling amounts\r\nin the basket module.",
"operationId": "getCommon_GetAdOnlyForReferenceText",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/GetInNotToOrderText": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/GetInNotToOrderText",
"description": "Gets the text explaining the 'not to order' flag in the spare part proposal.",
"operationId": "getCommon_GetInNotToOrderText",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/GetWorkPosTecRmiTimeText": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/GetWorkPosTecRmiTimeText",
"description": "Get the text for explaining the 'TecRMI work time' flag in the labour times, maintenance\r\ndata or basket module.",
"operationId": "getCommon_GetWorkPosTecRmiTimeText",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/GetWorkPosCompositeTimeText": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/GetWorkPosCompositeTimeText",
"description": "Gets the text explaining the 'composite time' flag in the labour times, maintenance data or\r\nbasket module.",
"operationId": "getCommon_GetWorkPosCompositeTimeText",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/VersionInfo": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/VersionInfo",
"description": "Gets the build number of the release, the version number of the solution and the DB Version number.",
"operationId": "getCommon_VersionInfo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VersionInfo"
}
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/AdditionalVehicleInformationForServiceBook": {
"get": {
"tags": [
"Common"
],
"summary": "/rest/Common/AdditionalVehicleInformationForServiceBook",
"description": "Fetches additional information towards a vehicle to be used in ServiceBook.",
"operationId": "getCommon_AdditionalVehicleInformationForServiceBook",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AdditionalVehicleInformationForServiceBook"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Common/QualifierCollections": {
"post": {
"tags": [
"Common"
],
"summary": "/rest/Common/QualifierCollections",
"description": "Delivers a collection of detailed information about the given qualifier collection ids.",
"operationId": "postCommon_QualifierCollections",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class QualifierCollectionsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/QualifierCollectionsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/QualifierCollection"
}
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/VehicleHasComponents": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/VehicleHasComponents",
"description": "Checks whether the selected vehicle has part position data.",
"operationId": "getComponentLocations_VehicleHasComponents",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/List": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/List",
"description": "Delivers a country specific list to generate a part position tree for the vehicle type in the selected language.",
"operationId": "getComponentLocations_List",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PpMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/ManualHtml": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/ManualHtml",
"description": "Delivers a string which contains HTML-lines from which a HTML-file for the part position\r\nmanual can be generated.",
"operationId": "getComponentLocations_ManualHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"required": true,
"type": "boolean"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets the time of the kind of work. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url. It is used where documents contains links\r\nto other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/ImageNamesForComponents": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/ImageNamesForComponents",
"description": "Delivers a collection of strings which contain the image names necessary for the part position manual.",
"operationId": "getComponentLocations_ImageNamesForComponents",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/Image": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/Image",
"description": "Returns a byte array which contains the requested part position image",
"operationId": "getComponentLocations_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/LinkedTechnicalData": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/LinkedTechnicalData",
"description": "Gets the technical data which are linked to this part position document.",
"operationId": "getComponentLocations_LinkedTechnicalData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageLinkId",
"in": "query",
"description": "Gets or sets the identifier of the image link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/LinkedTechnicalManuals": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/LinkedTechnicalManuals",
"description": "Gets the technical manuals which are linked to this part position document.",
"operationId": "getComponentLocations_LinkedTechnicalManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageLinkId",
"in": "query",
"description": "Gets or sets the identifier of the image link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched\r\nby using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TmItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/LinkedLabourTimes": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/LinkedLabourTimes",
"description": "Gets the labour times data which are linked to this part position document.",
"operationId": "getComponentLocations_LinkedLabourTimes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageLinkId",
"in": "query",
"description": "Gets or sets the identifier of the image link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched\r\nby using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "ltBodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtItemMpKor"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/LinkedWiringDiagram": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/LinkedWiringDiagram",
"description": "Gets the wiring diagrams which are linked to this part position document.",
"operationId": "getComponentLocations_LinkedWiringDiagram",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageLinkId",
"in": "query",
"description": "Gets or sets the identifier of the image link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched\r\nby using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/LinkedDiagnostics": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/LinkedDiagnostics",
"description": "Gets the diagnostics data which are linked to this part position document.",
"operationId": "getComponentLocations_LinkedDiagnostics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageLinkId",
"in": "query",
"description": "Gets or sets the identifier of the image link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Components/LinkedFuseRelais": {
"get": {
"tags": [
"ComponentLocations"
],
"summary": "/rest/Components/LinkedFuseRelais",
"description": "Gets the diagnostics data which are linked to this part position document.",
"operationId": "getComponentLocations_LinkedFuseRelais",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageLinkId",
"in": "query",
"description": "Gets or sets the identifier of the image link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "componentId",
"in": "query",
"description": "Gets or sets the identifier of the component.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FrBoxItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComponentTree/AddInfoKeys": {
"get": {
"tags": [
"ComponentTree"
],
"summary": "/rest/ComponentTree/AddInfoKeys",
"description": "Delivers a collection with the available optional additional information keys\r\nfor components depending on the given class id.",
"operationId": "getComponentTree_AddInfoKeys",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "classId",
"in": "query",
"description": "Gets or sets the class id.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKey"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComponentTree/AddInfoKeyIdValues": {
"get": {
"tags": [
"ComponentTree"
],
"summary": "/rest/ComponentTree/AddInfoKeyIdValues",
"description": "Gets the list of values for the given additional information key in the given language.",
"operationId": "getComponentTree_AddInfoKeyIdValues",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "addInfoKeyId",
"in": "query",
"description": "Gets or sets the id of the additional information key whose values should be returned from the method\r\nAddInfoKeyIdValues(GetVtAddInfoKeyIdValuesMsg).\r\nThe possible id can be fetched by a calling the web service method\r\nAddInfoKeys(GetVtAddInfoKeysMsg).",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComponentTree/GetComponentTreeTypeDetails": {
"get": {
"tags": [
"ComponentTree"
],
"summary": "/rest/ComponentTree/GetComponentTreeTypeDetails",
"description": "Delivers a collection with all component type details from a component type for the given\r\ncountry in the selected language, filtered by the given filter parameters.",
"operationId": "getComponentTree_GetComponentTreeTypeDetails",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CoTypeDetail"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComponentTree/Classes": {
"post": {
"tags": [
"ComponentTree"
],
"summary": "/rest/ComponentTree/Classes",
"description": "Delivers a collection with all component classes for the given country in the selected language,\r\nfiltered by the given filter parameter.",
"operationId": "postComponentTree_Classes",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class ClassesMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/ClassesMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CoClass"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComponentTree/Makes": {
"post": {
"tags": [
"ComponentTree"
],
"summary": "/rest/ComponentTree/Makes",
"description": "Delivers a collection with all component manufacturers for the given component class id\r\nand country in the selected language, filtered by the given filter parameter.",
"operationId": "postComponentTree_Makes",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class MakesMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/MakesMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CoMake"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/ComponentTree/Types": {
"post": {
"tags": [
"ComponentTree"
],
"summary": "/rest/ComponentTree/Types",
"description": "Delivers a collection with all component types from a component manufacturer for the\r\ngiven country in the selected language, filtered by the given filter parameters.",
"operationId": "postComponentTree_Types",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class TypesMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/TypesMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CoType"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/VehicleHasDiagnostics": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/VehicleHasDiagnostics",
"description": "Checks whether diagnosis data is available for the given vehicle.",
"operationId": "getDiagnosticValues_VehicleHasDiagnostics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/ComponentsForType": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/ComponentsForType",
"description": "Gets a country specific list of components with diagnostic data for the given vehicle.",
"operationId": "getDiagnosticValues_ComponentsForType",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiComponentType"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/List": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/List",
"description": "Delivers a country specific list to generate a diagnostic tree for the given component in the selected language.",
"operationId": "getDiagnosticValues_List",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/MainGroupHtml": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/MainGroupHtml",
"description": "Delivers a country specific string which contains HTML-lines from which an HTML-file for the diagnostic manuals of a main group can be generated.",
"operationId": "getDiagnosticValues_MainGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the identifier of the main group.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "printView",
"in": "query",
"description": "Determines whether a document for printing or the normal document should be created.",
"required": true,
"type": "boolean"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/SubGroupHtml": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/SubGroupHtml",
"description": "Delivers a country specific string which contains HTML-lines from which an HTML-file for the diagnostic manuals of a sub group can be generated.",
"operationId": "getDiagnosticValues_SubGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the identifier of the sub group.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "printView",
"in": "query",
"description": "Determines whether a document for printing or the normal document should be created.",
"required": true,
"type": "boolean"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/ManualHtml": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/ManualHtml",
"description": "Delivers a country specific string which contains HTML-lines from which an HTML-file for the diagnostic manual can be generated.",
"operationId": "getDiagnosticValues_ManualHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "systemQualColId",
"in": "query",
"description": "Gets or sets the id of the system qualifier collection.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "qualColId",
"in": "query",
"description": "Gets or sets the id of the qualifier collection. The id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"required": true,
"type": "boolean"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url. It is used where documents contains links\r\nto other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/ConnectorConditions": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/ConnectorConditions",
"description": "Gets the connector conditions.",
"operationId": "getDiagnosticValues_ConnectorConditions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiConnectorCondition"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/Value": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/Value",
"description": "Gets the diagnostics value.",
"operationId": "getDiagnosticValues_Value",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "systemQualColId",
"in": "query",
"description": "Gets or sets the id of the system qualifier collection.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "qualColId",
"in": "query",
"description": "Gets or sets the id of the qualifier collection. The id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "includeCondition",
"in": "query",
"description": "Determines whether the condition should be included.",
"required": true,
"type": "boolean"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the component type id.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiDiagnosticsValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/ImageNamesForDiagnostics": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/ImageNamesForDiagnostics",
"description": "Delivers a collection of strings which contain the image names necessary for the diagnostic manual.",
"operationId": "getDiagnosticValues_ImageNamesForDiagnostics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "systemQualColId",
"in": "query",
"description": "Gets or sets the id of the system qualifier collection.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "qualColId",
"in": "query",
"description": "Gets or sets the id of the qualifier collection. The id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the component type id.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/Image": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/Image",
"description": "Returns a stream which contains the requested diagnostic image.",
"operationId": "getDiagnosticValues_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/LinkedTechnicalData": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/LinkedTechnicalData",
"description": "Gets the technical data which are linked to this diagnostic manual.",
"operationId": "getDiagnosticValues_LinkedTechnicalData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "query",
"description": "Gets or sets identifier of the content.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/LinkedTechnicalManuals": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/LinkedTechnicalManuals",
"description": "Gets the technical manuals which are linked to this diagnostic manual.",
"operationId": "getDiagnosticValues_LinkedTechnicalManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "query",
"description": "Gets or sets the identifier of the content.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TmManual"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/LinkedLabourTimes": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/LinkedLabourTimes",
"description": "Gets the labour times work positions which are linked to this diagnostic manual.",
"operationId": "getDiagnosticValues_LinkedLabourTimes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "query",
"description": "Gets or sets the identifier of the content.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "ltBodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction. The id can be fetched by using the\r\nequivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets the kind of work time. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtItemMpKor"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/LinkedWiringDiagrams": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/LinkedWiringDiagrams",
"description": "Gets the wiring diagrams which are linked to this diagnostic manual.",
"operationId": "getDiagnosticValues_LinkedWiringDiagrams",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "query",
"description": "Gets or sets identifier of the content.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/LinkedRELAYSFUSES": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/LinkedRELAYSFUSES",
"description": "Gets the fuse and relays manuals which are linked to this diagnostic manual.",
"operationId": "getDiagnosticValues_LinkedRelaysFuses",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "query",
"description": "Gets or sets the identifier of the content.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FrBoxItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/LinkedPartPosition": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/LinkedPartPosition",
"description": "Gets the part position manuals which are linked to this diagnostic manual.",
"operationId": "getDiagnosticValues_LinkedPartPosition",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "query",
"description": "Gets or sets identifier of the content.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PpItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Diagnostics/MeasuringUnits": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/Diagnostics/MeasuringUnits",
"description": "Gets the measuing units.",
"operationId": "getDiagnosticValues_MeasuringUnits",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiMeasuringUnit"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/diagnostics/ErrorCode": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/diagnostics/ErrorCode",
"description": "Delivers a country specific list of diagnostic ItemMps for the given type, component and error code in the selected language",
"operationId": "getDiagnosticValues_ErrorCode",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "errorCode",
"in": "query",
"description": "Gets or sets the OEBD error code. Value must start with P followed by 4 digits long error code. Use leading 0 for error codes with less then 4 digits. Example P0001.",
"required": true,
"type": "string"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiItemMpDetailed"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/diagnostics/ItemList": {
"get": {
"tags": [
"DiagnosticValues"
],
"summary": "/rest/diagnostics/ItemList",
"description": "Delivers a country specific list of diagnostic ItemMps for the given type, component and item id in the selected language",
"operationId": "getDiagnosticValues_ItemList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "itemID",
"in": "query",
"description": "Gets or sets the identifier of the diagnostics item.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiItemMpDetailed"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/VehicleHasGraphics": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/VehicleHasGraphics",
"description": "Checks whether the vehicle has body graphics data.",
"operationId": "getGraphics_VehicleHasGraphics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/BodiesForGraphics": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/BodiesForGraphics",
"description": "Delivers a country specific list including all existing\r\nbody qualifier collections for the type id in the selected language.",
"operationId": "getGraphics_BodiesForGraphics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/ManualList": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/ManualList",
"description": "Gets the body graphics list.",
"operationId": "getGraphics_ManualList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/VehicleHtml": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/VehicleHtml",
"description": "Delivers a country specific string which contains the HTML lines for a body graphics vehicle overview HTML file.",
"operationId": "getGraphics_VehicleHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/MaingroupHtml": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/MaingroupHtml",
"description": "Delivers a country specific string which contains the HTML lines for a body graphics main group HTML file.",
"operationId": "getGraphics_MaingroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/SubGroupQuals": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/SubGroupQuals",
"description": "Gets the sub group qualifier collection in the given language for the given vehicle, country and main group.",
"operationId": "getGraphics_SubGroupQuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/SubgroupHtml": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/SubgroupHtml",
"description": "Delivers a country specific string which contains the HTML lines for a body graphics sub group HTML file.",
"operationId": "getGraphics_SubgroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "subGroupQualCol",
"in": "query",
"description": "Gets or sets the sub group qualifier collection.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/LinkedTechnicalManuals": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/LinkedTechnicalManuals",
"description": "Delivers a county specific list of technical manuals that are associated with the given item.",
"operationId": "getGraphics_LinkedTechnicalManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "itemGroupId",
"in": "query",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TmItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/LinkedAdjustmentData": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/LinkedAdjustmentData",
"description": "Delivers a county specific list of technical data that are associated with the given item.",
"operationId": "getGraphics_LinkedAdjustmentData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemGroupId",
"in": "query",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/LinkedWorkPositions": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/LinkedWorkPositions",
"description": "Delivers a country specific list of work positions (item mount positions- and kind of repair ids and their texts)\r\nin the given language that are associated with the given item for the given vehicle.",
"operationId": "getGraphics_LinkedWorkPositions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ShowPaint",
"in": "query",
"description": "Enable Paint.",
"required": false,
"type": "boolean"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemGroupId",
"in": "query",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgPaintItemMpKor"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/LinkedSpareParts": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/LinkedSpareParts",
"description": "Delivers a country specific list of spare parts that are associated with the given item. It is possible that for an item\r\nthere are more then one part sets founded differing by their part qualifier collections.",
"operationId": "getGraphics_LinkedSpareParts",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "ShowPaint",
"in": "query",
"description": "Enable Paint.",
"required": false,
"type": "boolean"
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemGroupId",
"in": "query",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InPaintPartSetItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/PreselectedData": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/PreselectedData",
"description": "Gets a string which can be passed to the javascript method highlightLinked to highlight the parts which are\r\npreviously selected.",
"operationId": "postGraphics_PreselectedData",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PreselectedDataMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/PreselectedDataMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/VehicleImage": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/VehicleImage",
"description": "Returns a Base64 encoded byte array which contains the requested body graphics vehicle overview image.",
"operationId": "getGraphics_VehicleImage",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/MaingroupImage": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/MaingroupImage",
"description": "Returns a Base64 encoded byte array which contains the requested body graphics main group image.",
"operationId": "getGraphics_MaingroupImage",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/SubgroupImage": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/SubgroupImage",
"description": "Returns a Base64 encoded byte array which contains the requested body graphics sub group image.",
"operationId": "getGraphics_SubgroupImage",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "subGroupQualCol",
"in": "query",
"description": "Gets or sets the sub group qualifier which identified the variant of the sub group image.\r\nThis id can be fetched by using SubGroupQuals(SubGroupQualsMsg)\" webservice method.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/JavaScriptCode": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/JavaScriptCode",
"description": "Gets java script code used by the body graphics HTML and SVG documents.",
"operationId": "getGraphics_JavaScriptCode",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link URL.\r\nThe actual link information is going to be added at the end of this url.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"example": {
"Version": {
"Major": 0,
"Minor": 0,
"Build": -1,
"Revision": -1,
"MajorRevision": -1,
"MinorRevision": -1
},
"StatusCode": 0,
"ReasonPhrase": "string",
"Headers": [],
"IsSuccessStatusCode": false
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/VehicleHasGraphicsGenArt": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/VehicleHasGraphicsGenArt",
"description": "Checks whether the vehicle has TecDoc body graphics data.",
"operationId": "getGraphics_VehicleHasGraphicsGenArt",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/BodiesForGraphicsGenArt": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/BodiesForGraphicsGenArt",
"description": "returns the TecRMI kind of vehicle body for a given TecDoc kind of vehicle body.",
"operationId": "getGraphics_BodiesForGraphicsGenArt",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "tecDocBodyId",
"in": "query",
"description": "Gets or sets the identifier of the tec document body.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtManualList": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtManualList",
"description": "Gets the body graphics list based on given TecDoc generic article numbers.",
"operationId": "postGraphics_GenArtManualList",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtManualListMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtManualListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgMainGroupTecDoc"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtVehicleHtml": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtVehicleHtml",
"description": "Delivers a country specific string which contains the HTML lines for a body graphics vehicle overview HTML file based on the given TecDoc generic article numbers.",
"operationId": "postGraphics_GenArtVehicleHtml",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtVehicleHtmlMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtVehicleHtmlMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtVehicleImage": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtVehicleImage",
"description": "Returns a Base64 encoded byte array which contains the requested body graphics\r\nvehicle overview image filtered by the passed list of TecDoc generic articles.",
"operationId": "postGraphics_GenArtVehicleImage",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class VehicleImageMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtVehicleImageMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtMaingroupHtml": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtMaingroupHtml",
"description": "Delivers a country specific string which contains the HTML lines for a body graphics main group HTML file based on the given TecDoc generic article numbers.",
"operationId": "postGraphics_GenArtMaingroupHtml",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtMaingroupHtmlMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtMaingroupHtmlMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtMaingroupImage": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtMaingroupImage",
"description": "Returns a Base64 encoded byte array which contains the requested body graphics\r\nmain group image filtered by the passed list of TecDoc generic articles.",
"operationId": "postGraphics_GenArtMaingroupImage",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtMaingroupImageMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtMaingroupImageMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtSubGroupQuals": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtSubGroupQuals",
"description": "Gets the sub group qualifier collection in the given language for the given vehicle, country and main group.",
"operationId": "postGraphics_GenArtSubGroupQuals",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtSubGroupQualsMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtSubGroupQualsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtSubgroupHtml": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtSubgroupHtml",
"description": "Delivers a country specific string which contains the HTML lines for a body graphics sub group HTML file based on the given TecDoc generic article numbers.",
"operationId": "postGraphics_GenArtSubgroupHtml",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtSubgroupHtmlMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtSubgroupHtmlMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/GenArtSubgroupImage": {
"post": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/GenArtSubgroupImage",
"description": "Returns a Base64 encoded byte array which contains the requested body graphics\r\nsub group image filtered by the passed list of TecDoc generic articles.",
"operationId": "postGraphics_GenArtSubgroupImage",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class GenArtSubgroupImageMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/GenArtSubgroupImageMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Graphics/LinkedGenArt": {
"get": {
"tags": [
"Graphics"
],
"summary": "/rest/Graphics/LinkedGenArt",
"description": "Delivers a list of TecDoc generic article numbers for the given TecRMI ItemMpId's.",
"operationId": "getGraphics_LinkedGenArt",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "itemGroupId",
"in": "query",
"description": "Gets or sets a list of identifiers of the part item mps.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/VehicleHasMaintenance": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/VehicleHasMaintenance",
"description": "Checks whether the vehicle has service (maintenance) data.",
"operationId": "getMaintenance_VehicleHasMaintenance",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/BodiesForMaintenance": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/BodiesForMaintenance",
"description": "Delivers a country specific list including all existing bodies for the typeId in the selected language.",
"operationId": "getMaintenance_BodiesForMaintenance",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdBodyQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/MakeInfoManuals": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/MakeInfoManuals",
"description": "Fetches the manual ids for selecting an existing manufacturer information as HTML from calling the method\r\nManualHtml(ManualHtmlMsg).",
"operationId": "getMaintenance_MakeInfoManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdTmLinkedManual"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/SubGroups": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/SubGroups",
"description": "Delivers a country specific object to generate the maintenance topic tree\r\nfor the TecRMI type id with the selected body and filter in the given language.",
"operationId": "getMaintenance_SubGroups",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdSubGroups"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorkSteps": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorkSteps",
"description": "Delivers a country specific list to generate a maintenance work position for the given vehicle, body, item mount position and\r\nkind of repair in the given language.",
"operationId": "getMaintenance_WorkSteps",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the topic tree id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorkStepsWithComplexityReference": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorkStepsWithComplexityReference",
"description": "Delivers a country specific list to generate a maintenance work position for the given vehicle, body, item mount position and\r\nkind of repair in the given language including a reference about their complexity.",
"operationId": "getMaintenance_WorkStepsWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the topic tree id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosWithComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorkStepsSuggestedWork": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorkStepsSuggestedWork",
"description": "Gets a collection with suggested works for the passed work.",
"operationId": "getMaintenance_GetMdWorkstepsSuggestedWork",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the topic tree id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosSuggestion"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorkStepsSuggestedWorkWithComplexityReference": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorkStepsSuggestedWorkWithComplexityReference",
"description": "Gets a collection with suggested works for the passed work including a reference about their complexity.",
"operationId": "getMaintenance_WorkStepsSuggestedWorkWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the topic tree id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosSuggestionWithComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorkStepsIncludingQualifiers": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorkStepsIncludingQualifiers",
"description": "Delivers a country specific list to generate a maintenance work position for the given vehicle, body, item mount position and\r\nkind of repair in the given language. Including a list where the Qualifier Collection identifier is split into its parts. If this split list\r\nshould be used to filter out not suitable work steps, if there is no exact filter match use the work step labeled with the qualifier collection standard.",
"operationId": "getMaintenance_WorkStepsIncludingQualifiers",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosWithQualifiers"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorkStepsIncludingQualifiersWithComplexityReference": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorkStepsIncludingQualifiersWithComplexityReference",
"description": "Delivers a country specific list to generate a maintenance work position for the given vehicle, body, item mount position and\r\nkind of repair in the given language. Including a reference about their complexity and a list where the Qualifier Collection identifier\r\nis split into its parts. If this split list should be used to filter out not suitable work steps, if there is no exact filter match use\r\nthe work step labeled with the qualifier collection standard.",
"operationId": "getMaintenance_WorkStepsIncludingQualifiersWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosWithQualifiersComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/Works": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/Works",
"description": "Delivers a country specific object to generate the maintenance topic tree for the vehicle type, the selected maintenance data body in the selected language and the related work steps info.",
"operationId": "getMaintenance_Works",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdSubGroupWorks"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/WorksWithComplexityReference": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/WorksWithComplexityReference",
"description": "Delivers a country specific object to generate the maintenance topic tree for the vehicle type,\r\nthe selected maintenance data body in the selected language and the related work steps info.\r\nIt contains also a reference about the complexity of these works.",
"operationId": "getMaintenance_WorksWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdSubGroupWorksWithComplexityReference"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/VehicleBodyImageName": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/VehicleBodyImageName",
"description": "Gets the vehicle body image name and reference for the passed vehicle.",
"operationId": "getMaintenance_VehicleBodyImageName",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdVehicleBodyImage"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/Image": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/Image",
"description": "Returns a base64 encoded string which contains the requested maintenance data image.",
"operationId": "getMaintenance_GetMdImage",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/MaintenancePlanData": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/MaintenancePlanData",
"description": "Delivers the country specific raw data object for creating the maintenance plan.",
"operationId": "postMaintenance_MaintenancePlanData",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class MaintenancePlanDataMsg",
"required": true,
"schema": {
"$ref": "#/definitions/MaintenancePlanDataMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdServicePlan"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/MaintenancePlanHtml": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/MaintenancePlanHtml",
"description": "Delivers a country specific string which contains HTML lines from\r\nwhich an HTML file for the maintenance plan can be generated.",
"operationId": "postMaintenance_MaintenancePlanHtml",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class MaintenancePlanHtmlMsg",
"required": true,
"schema": {
"$ref": "#/definitions/MaintenancePlanHtmlMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/VehicleHasServiceProposal": {
"get": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/VehicleHasServiceProposal",
"description": "Checks if service finder is available for the selected vehicle.",
"operationId": "getMaintenance_GetVehicleHasMdServiceProposal",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/PossibleGearboxCodes": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/PossibleGearboxCodes",
"description": "Maintenance possible gearbox codes.",
"operationId": "postMaintenance_PossibleGearboxCodes",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class PossibleGearboxCodesMsg",
"required": true,
"schema": {
"$ref": "#/definitions/PossibleGearboxCodesMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK. Possible enumeration values: - `65` = AutomaticGearBox
- `77` = ManualGearBox
- `81` = AutomatedGearBox
",
"schema": {
"type": "array",
"items": {
"format": "int32",
"enum": [
65,
77,
81
],
"type": "integer"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/PossibleCooGroupFilterParameters": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/PossibleCooGroupFilterParameters",
"description": "Maintenance posible coo group filter parameters.",
"operationId": "postMaintenance_PossibleCooGroupFilterParameters",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class\r\n PosibleCooGroupFilterParametersMsg",
"required": true,
"schema": {
"$ref": "#/definitions/PossibleCooGroupFilterParametersMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CooPossibleFilterParameters"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/ServiceProposalCooGroups": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/ServiceProposalCooGroups",
"description": "Maintenance service proposal coo groups.",
"operationId": "postMaintenance_ServiceProposalCooGroups",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class ProposalCooGroupsMsg",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceProposalCooGroupsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CooGroupQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/ServiceProposalCooGroupsIncludingQualifiers": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/ServiceProposalCooGroupsIncludingQualifiers",
"description": "Maintenance service proposal coo groups.",
"operationId": "postMaintenance_ServiceProposalCooGroupsIncludingQualifiers",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class ServiceProposalCooGroupsIncludingQualifiersMsg",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceProposalCooGroupsIncludingQualifiersMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CooGroupQualColWithQualifiers"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/ServiceProposal": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/ServiceProposal",
"description": "Delivers a list of work positions which should have be done in the last service and a list of work positions which should be done in the next service for the selected vehicle, current mileage (in kilometres) and initial registration date for a specific vehicle.. This method is NOT applicable for the country GB. For the country GB use the method {M:RestRMI.Areas.Md.Controllers.MaintenanceController.ServiceProposalMiles(RestRMI.Areas.Md.Models.ServiceProposalMilesMsg)}",
"operationId": "postMaintenance_ServiceProposal",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class ProposalMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceProposalMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdServiceProposal"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Maintenance/ServiceProposalMiles": {
"post": {
"tags": [
"Maintenance"
],
"summary": "/rest/Maintenance/ServiceProposalMiles",
"description": "Delivers a list of work positions which should be done in the last service and a list of work positions which should be done in the next service for the selected vehicle, current mileage (in miles) and initial registration date for a specific vehicle. This method is ONLY applicable for the country GB. For other countries use the method {M:RestRMI.Areas.Md.Controllers.MaintenanceController.ServiceProposal(RestRMI.Areas.Md.Models.ServiceProposalMsg)}",
"operationId": "postMaintenance_ServiceProposalMiles",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class ProposalMsg.",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceProposalMilesMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MdServiceProposalMiles"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/VehicleHasManuals": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/VehicleHasManuals",
"description": "Checks whether the vehicle has manual data.",
"operationId": "getManuals_VehicleHasManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/ManualList": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/ManualList",
"description": "Delivers a country specific list to generate a manual tree for the typeId in the selected language.",
"operationId": "getManuals_ManualList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TmMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/LinkedTechnicalManuals": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/LinkedTechnicalManuals",
"description": "The result of an m-link is an item number. This method checks whether none, one or more manuals are available for the given country.",
"operationId": "getManuals_LinkedTechnicalManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TmItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/LinkedTechnicalManualsForWork": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/LinkedTechnicalManualsForWork",
"description": "The result of an m-link is an item number. This method checks whether none, one or more manuals are available for the given country.",
"operationId": "getManuals_LinkedTechnicalManualsForWork",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "workId",
"in": "query",
"description": "Gets or sets the TecRMI work id which identifies a work position unique.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TmItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/ManualHtml": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/ManualHtml",
"description": "Delivers a string which contains HTML-code from which a HTML-file for the manual can be generated.",
"operationId": "getManuals_ManualHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"required": true,
"type": "boolean"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "showOeNoAsLink",
"in": "query",
"description": "Gets or sets a value indicating whether the part numbers of the original equipment manufacturer should be displayed as a link or not.\r\nFor this property to take effect the property PrintView has to be set to False.",
"required": false,
"type": "boolean"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/ErrorCodeSearchHtml": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/ErrorCodeSearchHtml",
"description": "Generates an HTML-string containing the filtered error codes for the given vehicle.",
"operationId": "getManuals_ErrorCodeSearchHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "errorCode",
"in": "query",
"description": "Gets or sets the error code to search for.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/ImageNamesForManual": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/ImageNamesForManual",
"description": "Delivers a collection of strings which contains the image names necessary for the manual.",
"operationId": "getManuals_ImageNamesForManual",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Manuals/Image": {
"get": {
"tags": [
"Manuals"
],
"summary": "/rest/Manuals/Image",
"description": "Returns a base64 encoded string which contains the requested technical manual image.",
"operationId": "getManuals_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/ForMake": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/ForMake",
"description": "Gets a country specific list of information for the given vehicle manufacturer in the given language.",
"operationId": "getNotes_ForMake",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "makeId",
"in": "query",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/ForRange": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/ForRange",
"description": "Gets a country specific list of information for the given model range in the given language.",
"operationId": "getNotes_ForRange",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "rangeId",
"in": "query",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/ForType": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/ForType",
"description": "Gets a country specific list of information for the given vehicle type in the given language.",
"operationId": "getNotes_ForType",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/AllInfosForType": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/AllInfosForType",
"description": "Gets a country specific list of information for the given vehicle manufacturer in the given language.",
"operationId": "getNotes_AllInfosForType",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "includeOutededInfos",
"in": "query",
"description": "Gets or sets a value indicating whether outdated information should be included in the result.",
"required": true,
"type": "boolean"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoDataExtended"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/ForMainGroup": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/ForMainGroup",
"description": "Gets a country specific list of information for the given main group in the given language.",
"operationId": "getNotes_ForMainGroup",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/ForSubGroup": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/ForSubGroup",
"description": "Gets a country specific list of information for the given sub group in the given language.",
"operationId": "getNotes_ForSubGroup",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Notes/ForItemMp": {
"get": {
"tags": [
"Notes"
],
"summary": "/rest/Notes/ForItemMp",
"description": "Gets the information for the type id and item mount position id.",
"operationId": "getNotes_ForItemMp",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/InfoData"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/VehicleHasRelaysFuses": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/VehicleHasRelaysFuses",
"description": "Checks whether the selected vehicle has fuse and relays data.",
"operationId": "getRelaysFuses_VehicleHasRelaysFuses",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/ComponentsForType": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/ComponentsForType",
"description": "Delivers a country specific list of components which contains fuse and relays data for the given vehicle.",
"operationId": "getRelaysFuses_ComponentsForType",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FrComponentType"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/BoxDetailList": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/BoxDetailList",
"description": "Delivers a country specific object to generate a fuse and relays tree for the given component in the selected language.",
"operationId": "getRelaysFuses_BoxDetailList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/FrBoxItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/BoxOverviewHtml": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/BoxOverviewHtml",
"description": "Delivers a country specific string which contains HTML-lines from which an HTML-file for the box overview graphic can be generated.",
"operationId": "getRelaysFuses_BoxOverviewHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of\r\nthis url.",
"required": true,
"type": "string"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the id of the component type.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/BoxDetailHtml": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/BoxDetailHtml",
"description": "Delivers a country specific string which contains HTML-lines from which an HTML-file for the box detail manual can be generated.",
"operationId": "getRelaysFuses_BoxDetailHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of\r\nthis url.",
"required": true,
"type": "string"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the component type id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"required": true,
"type": "boolean"
},
{
"name": "boxConfigurationMappingId",
"in": "query",
"description": "Gets or sets the identifier of the box configuration mapping.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "buildPeriodQualColId",
"in": "query",
"description": "Gets or sets the identifier of the build period qualifier collection.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/BoxOverviewImageName": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/BoxOverviewImageName",
"description": "Delivers a collection of strings which contain the image names necessary for the box overview graphic.",
"operationId": "getRelaysFuses_BoxOverviewImageName",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the id of the component type.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/LinkedTechnicalData": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/LinkedTechnicalData",
"description": "Gets the technical data which are linked to this fuse and relays document.",
"operationId": "getRelaysFuses_LinkedTechnicalData",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the identifier of the item mount position.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/LinkedTechnicalManuals": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/LinkedTechnicalManuals",
"description": "Gets the technical manuals which are linked to this fuse and relays document.",
"operationId": "getRelaysFuses_LinkedTechnicalManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the identifier of the item mount position.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TmItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/LinkedLabourTimes": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/LinkedLabourTimes",
"description": "Gets the labour times work positions which are linked to this fuse and relays document.",
"operationId": "getRelaysFuses_LinkedLabourTimes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "ltBodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction. The id can be fetched by using the\r\nequivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtItemMpKor"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/LinkedWiringDiagrams": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/LinkedWiringDiagrams",
"description": "Gets the wiring diagrams which are linked to this fuse and relays document.",
"operationId": "getRelaysFuses_LinkedWiringDiagrams",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the identifier of the item mp.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WdItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/LinkedDiagnostics": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/LinkedDiagnostics",
"description": "Gets the diagnostic manuals which are linked to this fuse and relays document.",
"operationId": "getRelaysFuses_LinkedDiagnostics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "diComponentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the diagnose component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/LinkedPartPosition": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/LinkedPartPosition",
"description": "Gets the part position manuals which are linked to this fuse and relays document.",
"operationId": "getRelaysFuses_LinkedPartPosition",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the identifier of the item mount position.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PpItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/RelaysFuses/BoxConfigurations": {
"get": {
"tags": [
"RelaysFuses"
],
"summary": "/rest/RelaysFuses/BoxConfigurations",
"description": "Gets an alternative topic tree for the module fuse and relays with search functionality.",
"operationId": "getRelaysFuses_BoxConfigurations",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the component type.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchText",
"in": "query",
"description": "Gets or sets the filter string.\r\nA search will only be performed if this search text is set to a value unequal NULL.",
"required": false,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FrMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/Auth/Login": {
"post": {
"tags": [
"Authentication"
],
"summary": "/Auth/Login",
"description": "Login method which logs in a user and returns the header Auth-Token (\"X-AuthToken\")\r\nneeded for calling other RMI Rest web service methods.",
"operationId": "postServiceAuthentication_Login",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "credentials",
"in": "body",
"description": "Information describing the login.",
"required": true,
"schema": {
"$ref": "#/definitions/LoginCredentials"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
},
"options": {
"tags": [
"Authentication"
],
"summary": "/Auth/Login",
"description": "Login method which logs in a user and returns the header Auth-Token (\"X-AuthToken\")\r\nneeded for calling other RMI Rest web service methods.",
"operationId": "optionsServiceAuthentication_Login",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "credentials",
"in": "body",
"description": "Information describing the login.",
"required": true,
"schema": {
"$ref": "#/definitions/LoginCredentials"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
},
"head": {
"tags": [
"Authentication"
],
"summary": "/Auth/Login",
"description": "Login method which logs in a user and returns the header Auth-Token (\"X-AuthToken\")\r\nneeded for calling other RMI Rest web service methods.",
"operationId": "headServiceAuthentication_Login",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "credentials",
"in": "body",
"description": "Information describing the login.",
"required": true,
"schema": {
"$ref": "#/definitions/LoginCredentials"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/Auth/Logout": {
"post": {
"tags": [
"Authentication"
],
"summary": "/Auth/Logout",
"description": "Logout method.",
"operationId": "postServiceAuthentication_Logout",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
},
"options": {
"tags": [
"Authentication"
],
"summary": "/Auth/Logout",
"description": "Logout method.",
"operationId": "optionsServiceAuthentication_Logout",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
},
"head": {
"tags": [
"Authentication"
],
"summary": "/Auth/Logout",
"description": "Logout method.",
"operationId": "headServiceAuthentication_Logout",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"401": {
"description": "User is not authenticated."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/VehicleHasBulletins": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/VehicleHasBulletins",
"description": "Checks whether SOS data exists for the given type id.",
"operationId": "getSos_VehicleHasBulletins",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/FilterValues": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/FilterValues",
"description": "Delivers a collection of allowed search values for filtering the manual list.",
"operationId": "getSos_FilterValues",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/SosFilterValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/ManualList": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/ManualList",
"description": "Delivers a country specific list to generate a manual topic tree for the given type id in the selected language.",
"operationId": "getSos_ManualList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "showAllMaingroups",
"in": "query",
"description": "Gets or sets a value indicating whether all main groups should be shown in the result.",
"required": true,
"type": "boolean"
},
{
"name": "showAllSubgroups",
"in": "query",
"description": "Gets or sets a value indicating whether all sub groups should be shown in the result.",
"required": true,
"type": "boolean"
},
{
"name": "qualifierFilter",
"in": "query",
"description": "Gets or sets the qualifier id after which the result should be filtered.\r\nPassing null means no filtering.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/SosMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/LinkedSosManuals": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/LinkedSosManuals",
"description": "The result of an m-link is an item number. This method checks whether none, one or more manuals are available for the given country.",
"operationId": "getSos_LinkedSosManuals",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SosItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/ManualHtml": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/ManualHtml",
"description": "Delivers a string which contains HTML-lines from which an SOS HTML file for the manual can be generated.",
"operationId": "getSos_ManualHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"required": true,
"type": "boolean"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/ImageNamesForSosManual": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/ImageNamesForSosManual",
"description": "Delivers a collection of strings which contains the image names necessary for the manual.",
"operationId": "getSos_ImageNamesForSosManual",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Bulletins/Image": {
"get": {
"tags": [
"Sos"
],
"summary": "/rest/Bulletins/Image",
"description": "Returns a base64 encoded string which contains the requested technical manual image.",
"operationId": "getSos_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/VehicleHasTimes": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/VehicleHasTimes",
"description": "Checks whether the vehicle has labour times data.",
"operationId": "getTimes_VehicleHasTimes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/BodiesForTimes": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/BodiesForTimes",
"description": "Delivers a country specific list including all existing bodies for the type id in the given language.",
"operationId": "getTimes_BodiesForTimes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtBodyQualCol"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkList": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkList",
"description": "Delivers a country specific list to generate the labour times topic tree for the selected vehicle and body in the selected language.\r\nThe result can be filtered by passing a search string to the property searchText.",
"operationId": "getTimes_WorkList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "showPaint",
"in": "query",
"description": "Enable Paint.",
"required": false,
"type": "boolean"
},
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "searchText",
"in": "query",
"description": "Filters the the labour times work list by the given search text value. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and SearchText is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtPaintMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkSteps": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkSteps",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, item mount position id and\r\nkind of repair id in the selected language.",
"operationId": "getTimes_WorkSteps",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsWithComplexityReference": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsWithComplexityReference",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, item mount position id and\r\nkind of repair id in the selected language including a reference about their complexity.",
"operationId": "getTimes_WorkStepsWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosWithComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsSuggestedWork": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsSuggestedWork",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, item mount position id and\r\nkind of repair id in the selected language including work position which are suggested",
"operationId": "getTimes_WorkStepsSuggestedWork",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosSuggestion"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsSuggestedWorkWithComplexityReference": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsSuggestedWorkWithComplexityReference",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, item mount position id and\r\nkind of repair id in the selected language including work position which are suggested and a reference about their complexity.",
"operationId": "getTimes_WorkStepsSuggestedWorkWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosSuggestionWithComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsIncludingQualifiers": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsIncludingQualifiers",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, item mount position id and\r\nkind of repair id in the selected language. Including a list where the Qualifier Collection identifier is split into its parts.\r\nIf this split list should be used to filter out not suitable work steps, if there is no exact filter match use the work step labeled\r\nwith the qualifier collection standard.",
"operationId": "getTimes_WorkStepsIncludingQualifiers",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosWithQualifiers"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsIncludingQualifiersWithComplexityReference": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsIncludingQualifiersWithComplexityReference",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, item mount position id and\r\nkind of repair id in the selected language. Including a list where the Qualifier Collection identifier is split into its parts.\r\nIf this split list should be used to filter out not suitable work steps, if there is no exact filter match use the work step labeled\r\nwith the qualifier collection standard.",
"operationId": "getTimes_WorkStepsIncludingQualifiersWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualColId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosWithQualifiersComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsForSubgroup": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsForSubgroup",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, subgroup id in the selected language.",
"operationId": "getTimes_WorkStepsForSubgroup",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualCodId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPos"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsForSubgroupWithComplexityReference": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsForSubgroupWithComplexityReference",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, subgroup id in the selected language\r\nincluding a reference about their complexity.",
"operationId": "getTimes_WorkStepsForSubgroupWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualCodId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosWithComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsSuggestedWorkForSubGroup": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsSuggestedWorkForSubGroup",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, subgroup id in the selected language including\r\nworks which are suggested to do also.",
"operationId": "getTimes_WorksStepsSuggestedWorkForSubGroup",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualCodId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosSuggestion"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/WorkStepsSuggestedWorkForSubGroupWithComplexityReference": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/WorkStepsSuggestedWorkForSubGroupWithComplexityReference",
"description": "Delivers a country specific list to generate a labour times work position for the given type id, body id, subgroup id in the selected language including\r\nworks which are suggested to do also and a reference about the complexity.",
"operationId": "getTimes_WorkStepsSuggestedWorkForSubGroupWithComplexityReference",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "bodyQualCodId",
"in": "query",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "subGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic sub group id. The id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtWorkPosSuggestionWithComplexityReference"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/RawTools": {
"get": {
"tags": [
"Times"
],
"summary": "/rest/Times/RawTools",
"description": "Returns the information about required specials tools which are necessary to do the selected work position.",
"operationId": "getTimes_RawTools",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "korId",
"in": "query",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/LtItemMpKorRawTools"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Times/RawToolsForWorkIds": {
"post": {
"tags": [
"Times"
],
"summary": "/rest/Times/RawToolsForWorkIds",
"description": "Returns the information about required specials tools which are necessary to do the passed work ids.",
"operationId": "postTimes_RawToolsForWorkIds",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of message classRawToolsMsg",
"required": true,
"schema": {
"$ref": "#/definitions/RawToolsForWorkIdsMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LtItemMpKorRawToolsForWorks"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Tyres/VehicleHasTyres": {
"get": {
"tags": [
"Tyres"
],
"summary": "/rest/Tyres/VehicleHasTyres",
"description": "Checks whether the vehicle has tyre data.",
"operationId": "getTyres_VehicleHasTyres",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Tyres/AllTyresForType": {
"get": {
"tags": [
"Tyres"
],
"summary": "/rest/Tyres/AllTyresForType",
"description": "Gets all the tyres for the selected typeId.",
"operationId": "getTyres_AllTyresForType",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TdTyre"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Tyres/TyreTypes": {
"get": {
"tags": [
"Tyres"
],
"summary": "/rest/Tyres/TyreTypes",
"description": "Retrieves all tyre types available with all known tyre types and corresponding ABE (general operating licence),\r\nKBA (german federal motor transport authority) or VSN (part of the kba number) for the given TecRMI vehicle type id.",
"operationId": "getTyres_TyreTypes",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TdTyreType"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Tyres/Tyres": {
"get": {
"tags": [
"Tyres"
],
"summary": "/rest/Tyres/Tyres",
"description": "Retrieves all tyre data available for a given tyre type id to generate a tyre data sheet.",
"operationId": "getTyres_Tyres",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "tyreTypeId",
"in": "query",
"description": "Gets or sets the id of the tyre whose data should be called. This id can be fetched by calling the\r\nweb service method TyreTypes(TyreTypesMsg)",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TdTyre"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Tyres/AllTyresForTypeHtml": {
"get": {
"tags": [
"Tyres"
],
"summary": "/rest/Tyres/AllTyresForTypeHtml",
"description": "Gets all the tyres for the selected typeId as a HTML-string.",
"operationId": "getTyres_AllTyresForTypeHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Tyres/TyreTypesHtml": {
"get": {
"tags": [
"Tyres"
],
"summary": "/rest/Tyres/TyreTypesHtml",
"description": "Retrieves all tyre data available for a given tyre type id and generate a HTML string.",
"operationId": "getTyres_TyreTypesHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "tyreTypeId",
"in": "query",
"description": "Gets or sets the id of the tyre whose data should be called. This id can be fetched by calling the\r\nweb service method TyreTypes(GetTdTyreTypesMsg).",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/AvailableModules": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/AvailableModules",
"description": "Delivers the information about which kind of data exists for the given TecRMI type Id.",
"operationId": "getVehicleTree_AvailableModules",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeModul"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/GetVtTypeDetailByNatVehicleNo": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/GetVtTypeDetailByNatVehicleNo",
"description": "Delivers a collection with all detailed information from the vehicle tree for the\r\nselected national vehicle ID and country in the given language.",
"operationId": "getVehicleTree_TypeDetailByNatVehicleNo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "natVehicleNo",
"in": "query",
"description": "Gets or sets the national vehicle identifier like swiss type no or the identifier\r\nform the german federal motor transport authority (KBANr) to search for.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeDetail"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/MakeIdForRangeIdMsg": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/MakeIdForRangeIdMsg",
"description": "Delivers the TecRMI make id for a given TecRMI range id.",
"operationId": "getVehicleTree_MakeIdForRangeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "rangeId",
"in": "query",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/MakeIdForTypeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/MakeIdForTypeId",
"description": "Delivers the TecRMI make id for a given TecRMI type id.",
"operationId": "getVehicleTree_MakeIdForTypeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/RangeIdForTypeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/RangeIdForTypeId",
"description": "Delivers the TecRMI range id for a given TecRMI type id.",
"operationId": "getVehicleTree_RangeIdForTypeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/AddInfoKeys": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/AddInfoKeys",
"description": "Delivers a country specific list with all additional information fields for the vehicle tree.",
"operationId": "getVehicleTree_AddInfoKeys",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "classId",
"in": "query",
"description": "Gets or sets the class id.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKey"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/AddInfoKeyIdValues": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/AddInfoKeyIdValues",
"description": "Delivers a collection with all texts which are available for the selected addition info key id and given language.",
"operationId": "getVehicleTree_AddInfoKeyIdValues",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "addInfoKeyId",
"in": "query",
"description": "Gets or sets the id of the additional information key whose values should be returned from the method\r\nAddInfoKeyIdValues(GetVtAddInfoKeyIdValuesMsg).\r\nThe possible id can be fetched by a calling the web service method\r\nAddInfoKeys(GetVtAddInfoKeysMsg).",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/SecondaryCriteriaAddInfoKeys": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/SecondaryCriteriaAddInfoKeys",
"description": "Returns the secondary criteria for truck VIN filter of the vehicle tree.",
"operationId": "getVehicleTree_SecondaryCriteriaAddInfoKeys",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "makeId",
"in": "query",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "classId",
"in": "query",
"description": "Gets or sets the TecDoc class id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "vin",
"in": "query",
"description": "The vehicle identification number",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VtAddInfoSecondaryCriteria"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/AdcMakeIdByTcdMakeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/AdcMakeIdByTcdMakeId",
"description": "Maps a TecDoc vehicle make id to the associated TecRMI make id.",
"operationId": "getVehicleTree_AdcMakeIdByTcdMakeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "tcdMakeId",
"in": "query",
"description": "Gets or sets the make id from TecDoc.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/AdcRangeIdByTcdRangeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/AdcRangeIdByTcdRangeId",
"description": "Maps a TecDoc vehicle range id to the associated TecRMI range id.",
"operationId": "getVehicleTree_AdcRangeIdByTcdRangeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "tcdRangeId",
"in": "query",
"description": "Gets or sets the range id from TecDoc.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/AdcTypeIdByTcdTypeAndClass": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/AdcTypeIdByTcdTypeAndClass",
"description": "Returns the TecRMI type Id for the given TecDoc TypeId and TecDoc ClassId.",
"operationId": "getVehicleTree_AdcTypeIdByTcdTypeAndClass",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "tcdTypeId",
"in": "query",
"description": "Gets or sets the TecDoc type id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "classId",
"in": "query",
"description": "Gets or sets the ClassID mentioned in the documentation.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TcdMakeIdByAdcMakeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TcdMakeIdByAdcMakeId",
"description": "Maps an TecRMI make id to the associated TecDoc vehicle make id.",
"operationId": "getVehicleTree_TcdMakeIdByAdcMakeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "makeId",
"in": "query",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TcdRangeIdByAdcRangeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TcdRangeIdByAdcRangeId",
"description": "Maps an TecRMI vehicle range id to the associated TecDoc range id.",
"operationId": "getVehicleTree_TcdRangeIdByAdcRangeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "rangeId",
"in": "query",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"format": "int32",
"type": "integer"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TcdTypeAndClassByAdcTypeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TcdTypeAndClassByAdcTypeId",
"description": "Returns the TecDoc type- and classId for the given TecRMI type Id.",
"operationId": "getVehicleTree_TcdTypeAndClassByAdcTypeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VtTcdTypeClass"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/VinFilterIsPossible": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/VinFilterIsPossible",
"description": "Vt vin filter is possible.",
"operationId": "getVehicleTree_VinFilterIsPossible",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "vin",
"in": "query",
"description": "Gets or sets the vin.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TcdKritNumberValueByVinFilter": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TcdKritNumberValueByVinFilter",
"description": "Gets TecDoc criteria numbers value by vin filter.",
"operationId": "getVehicleTree_TcdKritNumberValueByVinFilter",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the identifier of the vehicle tree.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "vin",
"in": "query",
"description": "The vehicle identification number.",
"required": true,
"type": "string"
},
{
"name": "secondaryCritera",
"in": "query",
"description": "Gets or sets the secondary vehicle search parameter.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TcdKritNumberValue"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/vehicleTree/JatoIdsByAdcTypeId": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/vehicleTree/JatoIdsByAdcTypeId",
"description": "Returns a list of assigned Jato ids for the passed vehicle identifier and country code.",
"operationId": "getVehicleTree_JatoIdsByAdcTypeId",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/JatoIdsByVehicleResponseMsg"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/vehicleTree/VehicleIdsByNationalVehicleNo": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/vehicleTree/VehicleIdsByNationalVehicleNo",
"description": "Gets the RMI and TecDoc vehicle identifiers by passing the national vehicle number like German Kba Number or Swiss registration numbers\r\nand a parameter indicating the kind of the national vehicle number. The used country (Germany or Swiss) is chosen by this parameter",
"operationId": "getVehicleTree_VehicleIdsByNationalVehicleNo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "kindOfNationalVehicleNo",
"in": "query",
"description": "Gets the kind of the national vehicle number passed as parameter nationalVehicleNo. Possible enumeration values: - `12` = GermanKBaNr
- `24` = SwissTypeNo
- `124` = SwissNumberPlate
- `224` = SwissRegistrationNo
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
12,
24,
124,
224
]
},
{
"name": "nationalVehicleNo",
"in": "query",
"description": "Gets the national vehicle number to look for.\r\nThe used country depends on this parameter.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeTreeIds"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/vehicleTree/VehicleIdsByNationalVehicleNoSearch": {
"get": {
"tags": [
"VehicleTree"
],
"summary": "/rest/vehicleTree/VehicleIdsByNationalVehicleNoSearch",
"description": "Gets the RMI and TecDoc vehicle identifiers by passing the only the national vehicle number like German Kba Number or Swiss registration numbers.\r\nBased on the format of the passed search string the method determines the country to use and the kind of the search.",
"operationId": "getVehicleTree_VehicleIdsByNationalVehicleNoSearch",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "searchString",
"in": "query",
"description": "Gets or sets the the national vehicle number to search for.\r\nBased of the format of this parameter the type of search is determined as well as the country to use.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeTreeIds"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/MakeList": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/MakeList",
"description": "Delivers a country specific list with all vehicle makes for the given module. By using the filter functionality\r\nthe result can further be restricted.",
"operationId": "postVehicleTree_MakeList",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class MakeListMsg",
"required": true,
"schema": {
"$ref": "#/definitions/MakeListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtMake"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/MakeListTcd": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/MakeListTcd",
"description": "Delivers a country specific list with all vehicle makes for the given module. By using the filter functionality\r\nthe result can further be restricted. Returns additionally the TecDoc make ids.",
"operationId": "postVehicleTree_MakeListTcd",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class MakeListMsg",
"required": true,
"schema": {
"$ref": "#/definitions/MakeListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtMakeTcd"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/RangeList": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/RangeList",
"description": "Delivers a country specific list with all vehicle ranges for the given make id and module. By using the filter functionality\r\nthe result can further be restricted.",
"operationId": "postVehicleTree_RangeList",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class RangeListMsg",
"required": true,
"schema": {
"$ref": "#/definitions/RangeListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtRange"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/RangeListTcd": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/RangeListTcd",
"description": "Delivers a country specific list with all vehicle ranges for the given make id and module. By using the filter functionality\r\nthe result can further be restricted. Returns additionally the TecDoc range Ids.",
"operationId": "postVehicleTree_RangeListTcd",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class RangeListMsg",
"required": true,
"schema": {
"$ref": "#/definitions/RangeListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtRangeTcd"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TypeList": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TypeList",
"description": "Delivers a country specific list with all vehicle types for the given range id and module. By using the filter functionality\r\nthe result can further be restricted.",
"operationId": "postVehicleTree_TypeList",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class TypeListMsg",
"required": true,
"schema": {
"$ref": "#/definitions/TypeListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtType"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TypeListTcd": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TypeListTcd",
"description": "Delivers a country specific list with all vehicle types for the given range id and module. By using the filter functionality\r\nthe result can further be restricted. Returns additonally the TecDoc KType or NType number.",
"operationId": "postVehicleTree_TypeListTcd",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class TypeListMsg",
"required": true,
"schema": {
"$ref": "#/definitions/TypeListMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeTcd"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TypeText": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TypeText",
"description": "Delivers a country specific type text for the given typeId in the selected language.",
"operationId": "postVehicleTree_TypeText",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class TypeTextMsg",
"required": true,
"schema": {
"$ref": "#/definitions/TypeTextMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/VehicleTree/TypeDetails": {
"post": {
"tags": [
"VehicleTree"
],
"summary": "/rest/VehicleTree/TypeDetails",
"description": "Delivers a collection with detailed information from the vehicle tree for the\r\nselected TecRMI type id and country in the given language.",
"operationId": "postVehicleTree_TypeDetails",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "input",
"in": "body",
"description": "Instance of the message class TypeDetailsMsg",
"required": true,
"schema": {
"$ref": "#/definitions/VtTypeDetailMsg"
}
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeDetail"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/VehicleHasWiring": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/VehicleHasWiring",
"description": "Checks whether wiring data exists for the given TecRMI type id.",
"operationId": "getWiring_VehicleHasWiring",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/ManualList": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/ManualList",
"description": "Delivers a country specific list to generate a manual tree for the TecRMI type id in the selected language.",
"operationId": "getWiring_ManualList",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "textSearch",
"in": "query",
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"required": false,
"type": "string"
},
{
"name": "genArtNumber",
"in": "query",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritNumber",
"in": "query",
"description": "Gets or sets the generic criterion number.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "genCritValue",
"in": "query",
"description": "Gets or sets the generic criterion value.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WdMainGroup"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/MainGroupHtml": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/MainGroupHtml",
"description": "Delivers a string with country specific content which contains lines of HTML from which an HTML file for the main group can be generated.",
"operationId": "getWiring_MainGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/WdSubGroupHtml": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/WdSubGroupHtml",
"description": "Delivers a country specific string which contains HTML lines from which an HTML file can be generated.",
"operationId": "getWiring_SubGroupHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "mainGroupId",
"in": "query",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/ManualHtml": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/ManualHtml",
"description": "Delivers a country specific string which contains HTML lines of manual.",
"operationId": "getWiring_ManualHtml",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "printView",
"in": "query",
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"required": true,
"type": "boolean"
},
{
"name": "kindOfWorkTime",
"in": "query",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"required": false,
"type": "integer",
"format": "int32",
"enum": [
0,
1
]
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkUrl",
"in": "query",
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"required": true,
"type": "string"
},
{
"name": "consumerId",
"in": "query",
"description": "Unique identifier for end user which receive the called data.",
"required": false,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/ImageNamesForWiringManual": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/ImageNamesForWiringManual",
"description": "Delivers a collection of strings which contains the image names necessary for the manual.",
"operationId": "getWiring_ImageNamesForWiringManual",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "manualId",
"in": "query",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/Image": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/Image",
"description": "Returns a byte array which contains the requested wiring diagram image.",
"operationId": "getWiring_Image",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "imageName",
"in": "query",
"description": "Gets or sets the name of the requested image.",
"required": true,
"type": "string"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/LinkedWiringDiagrams": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/LinkedWiringDiagrams",
"description": "The result of a w-link is an item number. This method checks whether none, one or more manuals are available for the given country.",
"operationId": "getWiring_LinkedWiringDiagrams",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "itemMpId",
"in": "query",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WdItemMp"
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/LinkedFuseRelais": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/LinkedFuseRelais",
"description": "The result of a link is an item number. This method checks whether none, one or more fuse and relay manuals are available for the given country.",
"operationId": "getWiring_LinkedFuseRelais",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkId",
"in": "query",
"description": "Gets or sets the identifier of the link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "componentTypeId",
"in": "query",
"description": "Gets or sets the component type id.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkType",
"in": "query",
"description": "Gets or sets the type of the link. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
]
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/FrBoxItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/LinkedPartPosition": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/LinkedPartPosition",
"description": "The result of a link is an item number. This method checks whether none, one or more part position manuals are available for the given country.",
"operationId": "getWiring_LinkedPartPosition",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkedId",
"in": "query",
"description": "Gets or sets the identifier of the link.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "linkType",
"in": "query",
"description": "Gets or sets the type of the link. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"required": true,
"type": "integer",
"format": "int32",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
]
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PpItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
},
"/rest/Wiring/LinkedDiagnostics": {
"get": {
"tags": [
"Wiring"
],
"summary": "/rest/Wiring/LinkedDiagnostics",
"description": "The result of an d-link is an item number. This method checks whether none, one or more diagnostic manuals are available for the given country.",
"operationId": "getWiring_LinkedDiagnostics",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"required": true,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"required": true,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "diComponentTypeId",
"in": "query",
"description": "Gets or sets the identifier of the diagnostic component type.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "diItemId",
"in": "query",
"description": "Gets or sets the identifier of the diagnostic item.",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "Origin",
"in": "header",
"description": "The origin",
"required": true,
"type": "string",
"default": ""
},
{
"name": "User-Agent",
"in": "header",
"description": "The user agent",
"required": true,
"type": "string",
"default": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm) Chrome/116.0.1938.76 Safari/537.36"
},
{
"name": "Authorization",
"in": "header",
"description": "The TecRMI Authorization",
"required": true,
"type": "string",
"default": "TecRMI {{AuthToken}}"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DiItemMp"
}
}
},
"401": {
"description": "User is not authenticated."
},
"403": {
"description": "User is not authorized to perform the requested operation."
},
"500": {
"description": "Internal server error occurred."
}
}
}
}
},
"definitions": {
"VehicleHasAdjustMsg": {
"description": "Class {VehicleHasAdjustMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"AdListMsg": {
"description": "Class {AdListMsg} is the base class for a few message classes and\r\ncontains the properties which are necessary to call web service methods\r\nList(AdListMsg),",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"AdMainGroup": {
"description": "Represents a main group of the adjustment data topic tree. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/AdSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"AdSubGroup": {
"description": "Represents a sub group of the adjustment data topic tree. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/AdItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"AdItemMp": {
"description": "Represents an item mount position of the adjustment data topic tree. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MainGroupDataMsg": {
"description": "Class {MainGroupDataMsg} contains the properties which are necessary to call web service methods\r\nMainGroupData(MainGroupDataMsg).",
"required": [
"MainGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"MainGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"AdValueSubGroup": {
"description": "Represents a sub group for adjustment data that has a collection of item mount positions.\r\nEach of the item mount positions has a list of values representing the actual adjustment data.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/AdValueItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Values": [
{
"ValueText": "string",
"QuantityText": "string",
"AdditionalText": "string",
"KindOfLink": 0,
"LinkValue": "string",
"ValueSortOrder": 0,
"QualColId": 0,
"QualColText": "string"
}
],
"IsOnlyForReference": false,
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"AdValueItemMp": {
"description": "Represents an item mount position along with a collection of their values.",
"type": "object",
"properties": {
"Values": {
"description": "Gets or sets a collection of values of this item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/AdValueData"
}
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether this instance is only for reference.",
"type": "boolean"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"Values": [
{
"ValueText": "string",
"QuantityText": "string",
"AdditionalText": "string",
"KindOfLink": 0,
"LinkValue": "string",
"ValueSortOrder": 0,
"QualColId": 0,
"QualColText": "string"
}
],
"IsOnlyForReference": false,
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"AdValueData": {
"description": "Represents value data for AD. This is the actual adjustment data.",
"type": "object",
"properties": {
"ValueText": {
"description": "Gets or sets the value text.",
"type": "string"
},
"QuantityText": {
"description": "Gets or sets the quantity text.",
"type": "string"
},
"AdditionalText": {
"description": "Gets or sets the additional text.",
"type": "string"
},
"KindOfLink": {
"format": "int32",
"description": "Gets or sets the kind of link. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
],
"type": "integer"
},
"LinkValue": {
"description": "Gets or sets the link value.",
"type": "string"
},
"ValueSortOrder": {
"format": "int32",
"description": "Gets or sets the value sort order.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"ValueText": "string",
"QuantityText": "string",
"AdditionalText": "string",
"KindOfLink": 0,
"LinkValue": "string",
"ValueSortOrder": 0,
"QualColId": 0,
"QualColText": "string"
}
},
"SubGroupDataMsg": {
"description": "Class {SubGroupDataMsg} contains the properties which are necessary to call the web service methods\r\nSubGroupData(SubGroupDataMsg).",
"required": [
"SubGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"ItemMpDataMsg": {
"description": "Class {ItemMpDataMsg} contains the properties which are necessary to call the web service methods\r\nItemMpData(ItemMpDataMsg).",
"required": [
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"AdMaingroupHtmlMsg": {
"description": "Class {AdMaingroupHtmlMsg} contains the properties which are necessary to call the web service method\r\nMainGroupHtml(AdMaingroupHtmlMsg).",
"required": [
"PrintView",
"LinkUrl",
"MainGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"type": "boolean"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"LinkUrl": "string",
"MainGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"AdSubGroupHtmlMsg": {
"description": "Class {AdSubGroupHtmlMsg} contains the properties which are necessary to call the web service method\r\nSubGroupHtml(AdSubGroupHtmlMsg).",
"required": [
"PrintView",
"LinkUrl",
"SubGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"type": "boolean"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"LinkUrl": "string",
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"ItemHtmlMsg": {
"description": "Class {ItemHtmlMsg} contains the properties which are necessary to call the web service method\r\nItemHtml(ItemHtmlMsg).",
"required": [
"PrintView",
"LinkUrl",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"type": "boolean"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"LinkUrl": "string",
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"ImageNamesForMainGroupMsg": {
"description": "Class {ImageNamesForMainGroupMsg} contains the properties which are necessary to call web service methods\r\nImageNamesForMainGroup(ImageNamesForMainGroupMsg).",
"required": [
"MainGroupId",
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"MainGroupId": 0,
"CountryCode": "string",
"TypeId": 0
}
},
"ImageNamesForSubGroupMsg": {
"description": "Class {ImageNamesForSubGroupMsg} contains the properties which are necessary to call the web service methods\r\nImageNamesForSubGroup(ImageNamesForSubGroupMsg).",
"required": [
"SubGroupId",
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"SubGroupId": 0,
"CountryCode": "string",
"TypeId": 0
}
},
"ImageNamesForItemMpMsg": {
"description": "Class {ImageNamesForItemMpMsg} contains the properties which are necessary to call the web service methods\r\nImageNamesForItemMp(ImageNamesForItemMpMsg),",
"required": [
"ItemMpId",
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ItemMpId": 0,
"CountryCode": "string",
"TypeId": 0
}
},
"ImageMsg": {
"description": "Class {ImageMsg} contains the properties which are necessary to call the web service methods\r\nImage(ImageMsg),",
"required": [
"ImageName"
],
"type": "object",
"properties": {
"ImageName": {
"description": "Gets or sets the name of the requested image.",
"type": "string"
}
},
"example": {
"ImageName": "string"
}
},
"PartsByOeMsg": {
"description": "Class {PartsByOeMsg} contains the properties which are necessary to call the web service method\r\nPartsByOe(PartsByOeMsg).",
"required": [
"SearchString",
"PartialOen",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"SearchString": {
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.PartsByOeMsg.PartialOen} this string has to\r\ncover the whole number (partialOEN = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"type": "string"
},
"PartialOen": {
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"type": "boolean"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"SearchString": "string",
"PartialOen": false,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"InPartData": {
"description": "Represents part data for IN.",
"type": "object",
"properties": {
"PartId": {
"format": "int32",
"description": "Gets or sets the part id.",
"type": "integer"
},
"PartNo": {
"description": "Gets or sets the part number.",
"type": "string"
},
"PartPrice": {
"format": "double",
"description": "Gets or sets the part price.",
"type": "number"
},
"PartPriceDate": {
"format": "date-time",
"description": "Gets or sets the part price date.",
"type": "string"
},
"PartPriceSupplier": {
"description": "Gets or sets the part price supplier.",
"type": "string"
},
"Amounts": {
"description": "Gets or sets a list of part amounts.",
"type": "array",
"items": {
"$ref": "#/definitions/InPartAmount"
}
},
"PartQualColId": {
"format": "int32",
"description": "Gets or sets the part qualifier collection id.",
"type": "integer"
},
"PartQualColText": {
"description": "Gets or sets the part qualifier collection text.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this part is denied.",
"type": "boolean"
},
"Currency": {
"description": "Gets or sets the currency.",
"type": "string"
},
"IsNotToOrder": {
"description": "Gets or sets a value indicating whether this part set qualifier collection is not to order.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"PartId": 0,
"PartNo": "string",
"PartPriceDate": "0001-01-01T00:00:00",
"PartPriceSupplier": "string",
"Amounts": [
{
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
],
"PartQualColId": 0,
"PartQualColText": "string",
"IsLocked": false,
"Currency": "string",
"IsNotToOrder": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"InPartAmount": {
"description": "Represents a part amount for IN.",
"type": "object",
"properties": {
"Amount": {
"format": "double",
"description": "Gets or sets the amount.",
"type": "number"
},
"Quantity": {
"description": "Gets or sets the quantity.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether this instance is only for reference.",
"type": "boolean"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
},
"TimesWorkListForCooMsg": {
"description": "Class {TimesWorkListForCooMsg} contains the properties which are necessary to call the web service methods\r\nTimesWorkListForCoo(TimesWorkListForCooMsg),",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Parameter will not be used at the moment.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SearchString": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"LtMainGroup": {
"description": "Represents a main group for labour times. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/LtSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"LtSubGroup": {
"description": "Represents a sub group for labour times. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/LtItemMpKor"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"LtItemMpKor": {
"description": "Represents an item mount position along with a kind of repair for labour times. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"TimesWorkStepsForCooMsg": {
"description": "Class {TimesWorkStepsForCooMsg} contains the properties which are necessary to call the web service methods\r\nTimesWorkStepsForCoo(TimesWorkStepsForCooMsg),",
"required": [
"KorId",
"KindOfWorkTime",
"BodyQualColId",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Parameter will not be used at the moment.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"SearchString": "string",
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"LtWorkPos": {
"description": "Represents a work position for labour times part of the AuDaLib which contains all necessary information for selecting a work position for\r\ncalculation.",
"type": "object",
"properties": {
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/LtExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/LtOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtExclWorkPos": {
"description": "Represents an exclusive work position for labour times. The selected main work position is\r\na composition of all the exclusive work positions.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtOptExclWorkPos": {
"description": "Represents an optional exclusive work position for a labour times work position\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "object",
"properties": {
"WorkPositionNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"TimesWorkListForAposMsg": {
"description": "Class {TimesWorkListForAposMsg} contains the properties which are necessary to call the web service methods\r\nTimesWorkListForApos(TimesWorkListForAposMsg),",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SearchString": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"TimesWorkStepsForAposMsg": {
"description": "Class {TimesWorkStepsForAposMsg} contains the properties which are necessary to call the web service methods\r\nTimesWorkStepsForApos(TimesWorkStepsForAposMsg),",
"required": [
"KorId",
"KindOfWorkTime",
"BodyQualColId",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the vehicle tree ID.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"SearchString": "string",
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"TimesWorkListForOeNoMsg": {
"description": "Class {TimesWorkListForOeNoMsg} contains the properties which are necessary to call the web service methods\r\nTimesWorkListForOeNo(TimesWorkListForOeNoMsg).",
"required": [
"BodyQualColId",
"PartialOen",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.TimesWorkListForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"type": "string"
},
"PartialOen": {
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"type": "boolean"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SearchString": "string",
"PartialOen": false,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"TimesWorkStepsForOeNoMsg": {
"description": "Class {TimesWorkStepsForOeNoMsg} contains the properties which are necessary to call the web service methods\r\nTimesWorkStepsForOeNo(TimesWorkStepsForOeNoMsg).",
"required": [
"KorId",
"KindOfWorkTime",
"BodyQualColId",
"PartialOen",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.TimesWorkStepsForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"type": "string"
},
"PartialOen": {
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"SearchString": "string",
"PartialOen": false,
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"MaintenanceSubGroupsForCooMsg": {
"description": "Class {MaintenanceSubGroupsForCooMsg} contains the properties which are necessary to call the web service methods\r\nMaintenanceSubGroupsForCoo(MaintenanceSubGroupsForCooMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Parameter will not be used at the moment.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SearchString": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"MdSubGroups": {
"description": "Represents a sub group for maintenance data.",
"type": "object",
"properties": {
"Services": {
"description": "Gets or sets the service list.",
"type": "array",
"items": {
"$ref": "#/definitions/MdItemMpKor"
}
},
"AdditionalWorks": {
"description": "Gets or sets a collection of additional maintenance work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdAddItemMpKor"
}
},
"IsMultipleServicesAllowed": {
"description": "Gets or sets a value indicating whether multiple service work positions can be selected or not.",
"type": "boolean"
},
"IsOnlyAdditionServiceAllowed": {
"description": "Gets or sets a value indicating whether it is allowed to select additional service work positions without having selected a service main work position or not.",
"type": "boolean"
}
},
"example": {
"Services": [
{
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"AdditionalWorks": [
{
"AddText": "string",
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"IsMultipleServicesAllowed": false,
"IsOnlyAdditionServiceAllowed": false
}
},
"MdItemMpKor": {
"description": "Represents an item mount position along with a kind of repair for maintenance data.",
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MdAddItemMpKor": {
"description": "Represents an item mount position along with a kind of repair and additional text for the maintenance data part of the AuDaLib.",
"type": "object",
"properties": {
"AddText": {
"description": "Gets or sets the additional text.",
"type": "string"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"AddText": "string",
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MaintenanceWorkStepsForCooMsg": {
"description": "Class {MaintenanceWorkStepsForCooMsg} contains the properties which are necessary to call the web service methods\r\nMaintenanceWorkStepsForCoo(MaintenanceWorkStepsForCooMsg),",
"required": [
"KorId",
"KindOfWorkTime",
"BodyQualColId",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the qualifier collection maintenance variants. This value can be fetched\r\nby using the web service method CooGroupQualCols.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"SearchString": "string",
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"MdWorkPos": {
"description": "Represents a work position for maintenance data part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.",
"type": "object",
"properties": {
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdExclWorkPos": {
"description": "Represents an exclusive work position for maintenance data work position. The selected main work position is\r\na composition of all the exclusive work positions.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdOptExclWorkPos": {
"description": "Represents an optional exclusive work position for maintenance data work position\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "object",
"properties": {
"WorkPositionNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MaintenanceSubGroupsForAposMsg": {
"description": "Class {MaintenanceSubGroupsForAposMsg} contains the properties which are necessary to call the web service methods\r\nMaintenanceSubGroupsForApos(MaintenanceSubGroupsForAposMsg),",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SearchString": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"MaintenanceWorkStepsForAposMsg": {
"description": "Class {MaintenanceWorkStepsForAposMsg} contains the properties which are necessary to call the web service methods\r\nMaintenanceWorkStepsForApos(MaintenanceWorkStepsForAposMsg),",
"required": [
"KorId",
"KindOfWorkTime",
"BodyQualColId",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original work position\r\nnumber from the car manufacturer to look for.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"SearchString": "string",
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"MaintenanceSubGroupsForOeNoMsg": {
"description": "Class {MaintenanceSubGroupsForOeNoMsg} contains the properties which are necessary to call the web service methods\r\nMaintenanceSubGroupsForOeNo(MaintenanceSubGroupsForOeNoMsg),",
"required": [
"BodyQualColId",
"PartialOen",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.MaintenanceSubGroupsForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"type": "string"
},
"PartialOen": {
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"type": "boolean"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SearchString": "string",
"PartialOen": false,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"MaintenanceWorkStepsForOeNoMsg": {
"description": "Class {MaintenanceWorkStepsForOeNoMsg} contains the properties which are necessary to call the web service methods\r\nMaintenanceWorkStepsForOeNo(MaintenanceWorkStepsForOeNoMsg).",
"required": [
"KorId",
"KindOfWorkTime",
"BodyQualColId",
"PartialOen",
"ItemMpId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SearchString": {
"description": "Gets or sets the string which contains the original equipment number (OEN) to look for.\r\nIn dependence on the value of the property {RestRMI.Areas.Audit.Models.MaintenanceWorkStepsForOeNoMsg.PartialOen} this string has to\r\ncover the whole number (PartialOen = false) or can be only a part of the whole\r\nnumber (PartialOen = true).",
"type": "string"
},
"PartialOen": {
"description": "Gets or sets a value indicating whether the search should find OE numbers\r\nwhere the entered search string is only a part of the number.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"SearchString": "string",
"PartialOen": false,
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"ItemMpIdForGenArtMsg": {
"description": "Class {ItemMpIdForGenArtMsg} contains the properties which are necessary to call the web service method\r\nItemMpIdForGenArt(ItemMpIdForGenArtMsg).",
"required": [
"GenArtNo"
],
"type": "object",
"properties": {
"GenArtNo": {
"format": "int32",
"description": "Gets or sets the generic article number to search for.",
"type": "integer"
},
"GenKritNo": {
"format": "int32",
"description": "Gets or sets the generic criterion number to search for.",
"type": "integer"
},
"GenKritValue": {
"description": "Gets or sets the generic criterion value to search for.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"GenArtNo": 0,
"GenKritNo": 0,
"GenKritValue": "string",
"ConsumerId": "string"
}
},
"CalcResultHtmlMsg": {
"description": "Class {CalcResultHtmlMsg} contains the properties which are necessary to call the web service method\r\nCalcResultHtml(CalcResultHtmlMsg).",
"required": [
"SelectedWorkIds",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedPartData": {
"description": "Gets or sets a collection with information about the parts which are actual selected.",
"type": "array",
"items": {
"$ref": "#/definitions/InSelectedPartValue"
}
},
"OptCalcParameters": {
"description": "Gets or sets a collection of optional calculation parameters. Passing values it is possible to improve the calculation\r\nresult by using small part addition, sales tax, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/CalcParameter"
}
},
"OptHeaderValues": {
"description": "Gets or sets a collection of optional header values. By passing values it is possible to display additional\r\ninformation on the html document like telephone number, date, job number, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/OptHeaderValue"
}
},
"SelectedWorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nwebservice methods MdWorkSteps(MdWorkStepsMsg and LtWorkSteps(LtWorkStepsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calc or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedPartData": [
{
"ItemMpId": 0,
"PartNo": "string",
"PartPrice": 0.0,
"PartAmount": 0.0,
"PartQualColId": 0,
"PartAmountQualColId": 0,
"KindOfPart": 0
}
],
"OptCalcParameters": [
{
"KindOfParameter": 0,
"ParameterValue": 0.0
}
],
"OptHeaderValues": [
{
"KindOfHeaderValue": 0,
"HeaderValue": "string"
}
],
"SelectedWorkIds": [
0
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InSelectedPartValue": {
"description": "Represents a selected part value for IN.",
"type": "object",
"properties": {
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"PartNo": {
"description": "Gets or sets the part number.",
"type": "string"
},
"PartPrice": {
"format": "double",
"description": "Gets or sets the part price.",
"type": "number"
},
"PartAmount": {
"format": "double",
"description": "Gets or sets the part amount.",
"type": "number"
},
"PartQualColId": {
"format": "int32",
"description": "Gets or sets the part qualifier collection id.",
"type": "integer"
},
"PartAmountQualColId": {
"format": "int32",
"description": "Gets or sets the part amount qualifier collection id.",
"type": "integer"
},
"KindOfPart": {
"format": "int32",
"description": "Gets or sets the kind of part. Possible enumeration values: - `0` = SparePart
- `5` = PaintMaterial
",
"enum": [
0,
5
],
"type": "integer"
}
},
"example": {
"ItemMpId": 0,
"PartNo": "string",
"PartPrice": 0.0,
"PartAmount": 0.0,
"PartQualColId": 0,
"PartAmountQualColId": 0,
"KindOfPart": 0
}
},
"CalcParameter": {
"description": "Class {CalcParameter} contains two properties which can be used to add additional parameters to the\r\ncalculation method (eg. sales tax or small part addition).",
"type": "object",
"properties": {
"KindOfParameter": {
"format": "int32",
"description": "Gets or sets the kind of parameter which describes what kind of information\r\nis passed through the property ParameterValue.\r\nPossible values are the members of the enum\r\nInKindOfOptCalcParam. Possible enumeration values: - `1` = MechanicsWorkHourRate
- `2` = BodyWorkHourRate
- `3` = ElectronicsWorkHourRate
- `4` = SalesTaxRate
- `5` = SmallPartAdditionRate
- `6` = PaintWorkHourRate
- `7` = PaintSmallPartAddition
- `8` = PaintFactorUni
- `9` = PaintFactorTwoLayered
- `10` = PaintFactorMultiLayered
- `11` = T1HourRate
- `12` = T2HourRate
- `13` = T3HourRate
- `14` = T4HourRate
",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"type": "integer"
},
"ParameterValue": {
"format": "double",
"description": "Gets or sets the value for the kind that is passed through the property\r\nKindOfParameter.",
"type": "number"
}
},
"example": {
"KindOfParameter": 0,
"ParameterValue": 0.0
}
},
"OptHeaderValue": {
"description": "Class {OptHeaderValue} contains two properties which can be used to add an addition information\r\nto generated HTML documents, e.g. the maintenance plan from the web service method\r\nMaintenancePlanHtml(MaintenancePlanHtmlMsg).\r\nTo display a phone number of example on the service plan set the property {OptHeaderValue.KindOfHeaderValue} to\r\nPhoneNo and the property {OptHeaderValue.HeaderValue} to the desired phone number. The possible values are the member of the\r\nAuDaLib.Interface.ObjectModel.Common.KindOfOptionalHeaderValue.",
"type": "object",
"properties": {
"KindOfHeaderValue": {
"format": "int32",
"description": "Gets or sets the kind of header value which describes what kind of information\r\nis passed through the property HeaderValue.\r\nPossible values are the members of the enum\r\nKindOfOptionalHeaderValue. Possible enumeration values: - `1` = Date
- `2` = Customer
- `3` = PhoneNo
- `4` = Job
- `5` = No
- `6` = Mileage
- `7` = Culture
- `8` = DecimalFormat
- `9` = WorkTime
",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"type": "integer"
},
"HeaderValue": {
"description": "Gets or sets the value for the kind that is passed through the property\r\nKindOfHeaderValue.",
"type": "string"
}
},
"example": {
"KindOfHeaderValue": 0,
"HeaderValue": "string"
}
},
"PaintWorkPosSettings": {
"description": "Represents settings for a work position for paint part of the AuDaLib\r\nwhich contains all necessary information for selected settings for a work position for calculation.",
"type": "object",
"properties": {
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position Id.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the item mount position text.",
"type": "string"
},
"KindOfAssembly": {
"format": "int32",
"description": "Gets or sets the kind of assembly. Possible enumeration values: - `1` = Screwed
- `2` = WeldedOrGlued
",
"enum": [
1,
2
],
"type": "integer"
},
"IsTwoSided": {
"description": "Gets or sets the two sided flag.",
"type": "boolean"
},
"AreaQualCol": {
"$ref": "#/definitions/QualCol",
"description": "Gets or sets the area qualifier collection."
},
"KindOfPaint": {
"format": "int32",
"description": "Gets or sets the kind of paint. Possible enumeration values: - `1` = Uni
- `2` = TwoLayered
- `3` = MultiLayered
",
"enum": [
1,
2,
3
],
"type": "integer"
},
"KindOfMaterial": {
"format": "int32",
"description": "Gets or sets the kind of material. Possible enumeration values: - `1` = Metal
- `2` = Plastic
",
"enum": [
1,
2
],
"type": "integer"
},
"KindOfInstallation": {
"format": "int32",
"description": "Gets or sets the kind of installation. Possible enumeration values: - `0` = Installed
- `1` = Dismounted
",
"enum": [
0,
1
],
"type": "integer"
},
"KindOfAdditions": {
"description": "Gets or sets the kind of additions.",
"type": "array",
"items": {
"format": "int32",
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer"
}
},
"KindOfPaintStage": {
"format": "int32",
"description": "Gets or sets the kind of paint stage. Possible enumeration values: - `1` = S1
- `2` = S2
- `3` = S3
- `4` = S4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"PaintGroupId": {
"format": "int32",
"description": "Gets or sets the paint group Id.",
"type": "integer"
}
},
"example": {
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
},
"QualCol": {
"description": "Class QualCol represents a qualifier collection.\r\nThe qualifier collection delivers a further differentiation for an item.",
"type": "object",
"properties": {
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"QualColId": 0,
"QualColText": "string"
}
},
"CalcResultHtmlWithComplexityReferenceMsg": {
"description": "Class {CalcResultHtmlWithComplexityReferenceMsg} contains the properties which are necessary to call the web service method\r\nCalcResultHtmlWithComplexityReference(CalcResultHtmlWithComplexityReferenceMsg).",
"required": [
"SelectedWorkIdsWithComplexity",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedPartData": {
"description": "Gets or sets a collection with information about the parts which are actual selected.",
"type": "array",
"items": {
"$ref": "#/definitions/InSelectedPartValue"
}
},
"OptCalcParameters": {
"description": "Gets or sets a collection of optional calculation parameters. Passing values it is possible to improve the calculation\r\nresult by using small part addition, sales tax, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/CalcParameter"
}
},
"OptHeaderValues": {
"description": "Gets or sets a collection of optional header values. By passing values it is possible to display additional\r\ninformation on the HTML document like telephone number, date, job number, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/OptHeaderValue"
}
},
"SelectedWorkIdsWithComplexity": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nweb service methods MdWorkSteps(MdWorkStepsMsg),\r\nWorks(WorksMsg)\r\nand LtWorkSteps(LtWorkStepsMsg).\r\nOptionally is it possible to pass an own complexity level together with the identifier which will then be used during the calculation.",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkIdWithComplexity"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calc or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedPartData": [
{
"ItemMpId": 0,
"PartNo": "string",
"PartPrice": 0.0,
"PartAmount": 0.0,
"PartQualColId": 0,
"PartAmountQualColId": 0,
"KindOfPart": 0
}
],
"OptCalcParameters": [
{
"KindOfParameter": 0,
"ParameterValue": 0.0
}
],
"OptHeaderValues": [
{
"KindOfHeaderValue": 0,
"HeaderValue": "string"
}
],
"SelectedWorkIdsWithComplexity": [
{
"WorkId": 0,
"Complexity": 1,
"DisplayComplexityString": "T1"
}
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InWorkIdWithComplexity": {
"description": "A work position identifier combined complexity.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the identifier of the work.",
"type": "integer"
},
"Complexity": {
"format": "int32",
"description": "Gets or sets an optional value to overwrite the default complexity reference value.\r\nIf it is set to the value NULL the complexity value from the database is used, otherwise the passed value! Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"DisplayComplexityString": {
"description": "Gets the display representation for the current complexity value.",
"type": "string",
"readOnly": true
}
},
"example": {
"WorkId": 0,
"Complexity": 1,
"DisplayComplexityString": "T1"
}
},
"CalcResultHtmlWithWorkPositionsMsg": {
"description": "Class {CalcResultHtmlWithWorkPositionsMsg} contains the properties which are necessary to call the web service method\r\nCalcResultHtmlWithWorkPositions(CalcResultHtmlWithWorkPositionsMsg).",
"required": [
"SelectedWorkPositions",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedPartData": {
"description": "Gets or sets a collection with information about the parts which are actual selected.",
"type": "array",
"items": {
"$ref": "#/definitions/InSelectedPartValue"
}
},
"OptCalcParameters": {
"description": "Gets or sets a collection of optional calculation parameters. Passing values it is possible to improve the calculation\r\nresult by using small part addition, sales tax, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/CalcParameter"
}
},
"OptHeaderValues": {
"description": "Gets or sets a collection of optional header values. By passing values it is possible to display additional\r\ninformation on the html document like telephone number, date, job number, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/OptHeaderValue"
}
},
"SelectedWorkPositions": {
"description": "Gets or sets a collection with selected work positions represented by ItemMpId, KorId, QualColId and only for maintenance. This values can be fetched by using the\r\nwebservice methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkPosition"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calc or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedPartData": [
{
"ItemMpId": 0,
"PartNo": "string",
"PartPrice": 0.0,
"PartAmount": 0.0,
"PartQualColId": 0,
"PartAmountQualColId": 0,
"KindOfPart": 0
}
],
"OptCalcParameters": [
{
"KindOfParameter": 0,
"ParameterValue": 0.0
}
],
"OptHeaderValues": [
{
"KindOfHeaderValue": 0,
"HeaderValue": "string"
}
],
"SelectedWorkPositions": [
{
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InWorkPosition": {
"description": "Represents a work position for IN.",
"type": "object",
"properties": {
"IsMdWorkPos": {
"description": "Gets or sets a value indicating whether this work position is a maintenance work position.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"CalcResultHtmlWithWorkPositionsWithComplexityReferenceMsg": {
"description": "Class {CalcResultHtmlWithWorkPositionsWithComplexityReferenceMsg} contains the properties which are necessary to call the web service method\r\nCalcResultHtmlWithWorkPositionsWithComplexityReference(CalcResultHtmlWithWorkPositionsWithComplexityReferenceMsg).",
"required": [
"SelectedWorkPositionsWithComplexity",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedPartData": {
"description": "Gets or sets a collection with information about the parts which are actually selected.",
"type": "array",
"items": {
"$ref": "#/definitions/InSelectedPartValue"
}
},
"OptCalcParameters": {
"description": "Gets or sets a collection of optional calculation parameters. Passing values it is possible to improve the calculation\r\nresult by using small part addition, sales tax, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/CalcParameter"
}
},
"OptHeaderValues": {
"description": "Gets or sets a collection of optional header values. By passing values it is possible to display additional\r\ninformation on the html document like telephone number, date, job number, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/OptHeaderValue"
}
},
"SelectedWorkPositionsWithComplexity": {
"description": "Gets or sets a collection with selected work positions represented by ItemMpId, KorId, QualColId and only for maintenance. This ids can be fetched by using the\r\nweb service methods MdWorkSteps(MdWorkStepsMsg),\r\nWorks(WorksMsg)\r\nand LtWorkSteps(LtWorkStepsMsg).\r\nOptionally is it possible to pass an own complexity level together with the identifier which will then be used during the calculation.",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkPositionWithComplexity"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calc or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedPartData": [
{
"ItemMpId": 0,
"PartNo": "string",
"PartPrice": 0.0,
"PartAmount": 0.0,
"PartQualColId": 0,
"PartAmountQualColId": 0,
"KindOfPart": 0
}
],
"OptCalcParameters": [
{
"KindOfParameter": 0,
"ParameterValue": 0.0
}
],
"OptHeaderValues": [
{
"KindOfHeaderValue": 0,
"HeaderValue": "string"
}
],
"SelectedWorkPositionsWithComplexity": [
{
"Complexity": 1,
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InWorkPositionWithComplexity": {
"description": "A work position extended with their complexity reference.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets an optional value to overwrite the default complexity reference value.\r\nIf it is set to the value NULL the complexity value from the database is used, otherwise the passed value! Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"IsMdWorkPos": {
"description": "Gets or sets a value indicating whether this work position is a maintenance work position.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"WorkCalcMsg": {
"description": "Class {WorkCalcMsg} contains the properties which are necessary to call the web service method\r\nWorkCalc(WorkCalcMsg).",
"required": [
"SelectedWorkIds",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedWorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nwebservice methods MdWorkSteps(MdWorkStepsMsg) and LtWorkSteps(LtWorkStepsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calculation or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedWorkIds": [
0
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InWorkCalcResultValue": {
"description": "Represents a work calculation result value for IN.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the work id.",
"type": "integer"
},
"WorkPositionNo": {
"description": "Gets or sets the work position number.",
"type": "string"
},
"KindOfWork": {
"format": "int32",
"description": "Gets or sets the kind of work id. Possible enumeration values: - `1` = Mechanics
- `2` = Body
- `3` = Electronics
- `4` = Paint
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"OriginalTime": {
"format": "float",
"description": "Gets or sets the original time.",
"type": "number"
},
"CalculatedTime": {
"format": "float",
"description": "Gets or sets the calculated time.",
"type": "number"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the kind of repair id.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the qualifier collection id.",
"type": "integer"
},
"WorkPosText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether this work calculation result value is a composite time.",
"type": "boolean"
},
"TopWorkid": {
"format": "int32",
"description": "Gets or sets the top work id.",
"type": "integer"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets the kind of work time data. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"Modul": {
"format": "int32",
"description": "Gets or sets the kind of module. Possible enumeration values: - `1` = Md
- `2` = Lt
- `3` = Paint
- `4` = FreePosition
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"Position": {
"format": "int32",
"description": "Gets or sets the position. Possible enumeration values: - `0` = WorkPosition
- `1` = InclusivePosition
- `2` = ExclusivePosition
",
"enum": [
0,
1,
2
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether this instance is only for reference.",
"type": "boolean"
},
"IsAdcTime": {
"description": "Gets or sets a value indicating whether this instance is adc time.",
"type": "boolean"
},
"IsNetWorkTime": {
"description": "Gets or sets a value indicating whether this work calculation result value is a net work time.",
"type": "boolean"
}
},
"example": {
"WorkId": 0,
"WorkPositionNo": "string",
"KindOfWork": 0,
"OriginalTime": 0.0,
"CalculatedTime": 0.0,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkPosText": "string",
"IsCompositeTime": false,
"TopWorkid": 0,
"KindOfWorkTimeData": 0,
"Modul": 0,
"Position": 0,
"IsOnlyForReference": false,
"IsAdcTime": false,
"IsNetWorkTime": false
}
},
"WorkCalcWithComplexityReferenceMsg": {
"description": "Class {WorkCalcWithComplexityReferenceMsg} contains the properties which are necessary to call the web service method\r\nWorkCalcWithComplexityReference(WorkCalcWithComplexityReferenceMsg).",
"required": [
"SelectedWorkIdsWithComplexity",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedWorkIdsWithComplexity": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nweb service methods MdWorkSteps(MdWorkStepsMsg) and LtWorkSteps(LtWorkStepsMsg).\r\nOptionally is it possible to pass an own complexity level together with the identifier which will then be used.",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkIdWithComplexity"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calculation or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedWorkIdsWithComplexity": [
{
"WorkId": 0,
"Complexity": 1,
"DisplayComplexityString": "T1"
}
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InWorkCalcWithComplexityResultValue": {
"description": "Represents a work calculation result value for IN.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the used complexity reference value. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the work id.",
"type": "integer"
},
"WorkPositionNo": {
"description": "Gets or sets the work position number.",
"type": "string"
},
"KindOfWork": {
"format": "int32",
"description": "Gets or sets the kind of work id. Possible enumeration values: - `1` = Mechanics
- `2` = Body
- `3` = Electronics
- `4` = Paint
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"OriginalTime": {
"format": "float",
"description": "Gets or sets the original time.",
"type": "number"
},
"CalculatedTime": {
"format": "float",
"description": "Gets or sets the calculated time.",
"type": "number"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the kind of repair id.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the qualifier collection id.",
"type": "integer"
},
"WorkPosText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether this work calculation result value is a composite time.",
"type": "boolean"
},
"TopWorkid": {
"format": "int32",
"description": "Gets or sets the top work id.",
"type": "integer"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets the kind of work time data. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"Modul": {
"format": "int32",
"description": "Gets or sets the kind of module. Possible enumeration values: - `1` = Md
- `2` = Lt
- `3` = Paint
- `4` = FreePosition
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"Position": {
"format": "int32",
"description": "Gets or sets the position. Possible enumeration values: - `0` = WorkPosition
- `1` = InclusivePosition
- `2` = ExclusivePosition
",
"enum": [
0,
1,
2
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether this instance is only for reference.",
"type": "boolean"
},
"IsAdcTime": {
"description": "Gets or sets a value indicating whether this instance is adc time.",
"type": "boolean"
},
"IsNetWorkTime": {
"description": "Gets or sets a value indicating whether this work calculation result value is a net work time.",
"type": "boolean"
}
},
"example": {
"Complexity": 1,
"WorkId": 0,
"WorkPositionNo": "string",
"KindOfWork": 0,
"OriginalTime": 0.0,
"CalculatedTime": 0.0,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkPosText": "string",
"IsCompositeTime": false,
"TopWorkid": 0,
"KindOfWorkTimeData": 0,
"Modul": 0,
"Position": 0,
"IsOnlyForReference": false,
"IsAdcTime": false,
"IsNetWorkTime": false
}
},
"WorkCalcWithWorkPositionsMsg": {
"description": "Class {WorkCalcWithWorkPositionsMsg} contains the properties which are necessary to call the web service method\r\nWorkCalcWithWorkPositions(WorkCalcWithWorkPositionsMsg).",
"required": [
"SelectedWorkPositions",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedWorkPositions": {
"description": "Gets or sets a collection with selected work positions represented by ItemMpId, KorId, QualColId and only for maintenance. This values can be fetched by using the\r\nwebservice methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkPosition"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calculation or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedWorkPositions": [
{
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"WorkCalcWithWorkPositionsWithComplexityReferenceMsg": {
"description": "Class {WorkCalcWithWorkPositionsWithComplexityReferenceMsg} contains the properties which are necessary to call the web service method\r\nWorkCalcWithWorkPositionsWithComplexityReference(WorkCalcWithWorkPositionsWithComplexityReferenceReferenceMsg).",
"required": [
"SelectedWorkPositionsWithComplexity",
"IsCompositeCalc",
"KindOfWorkTime",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedWorkPositionsWithComplexity": {
"description": "Gets or sets a collection with selected work positions represented by ItemMpId, KorId, QualColId and only for maintenance. This values can be fetched by using the\r\nwebservice methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkPositionWithComplexity"
}
},
"IsCompositeCalc": {
"description": "Gets or sets a value indicating whether the calculation should consider composite calculation or not.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedWorkPositionsWithComplexity": [
{
"Complexity": 1,
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsCompositeCalc": false,
"KindOfWorkTime": 0,
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"GenArtsForItemMpIdsMsg": {
"description": "Class {GenArtsForItemMpIdsMsg} contains the properties which are necessary to call the web service method\r\nGenArtsForItemMpIds(GenArtsForItemMpIdsMsg).",
"required": [
"ItemMpIds"
],
"type": "object",
"properties": {
"ItemMpIds": {
"description": "Gets or sets a collections of item mount position ids to search for.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"ConsumerId": {
"description": "Unique identifier for end user which receives the called data.",
"type": "string"
}
},
"example": {
"ItemMpIds": [
0
],
"ConsumerId": "string"
}
},
"InItemMpGenArt": {
"description": "Represents an item mount position along with a generic article for IN.",
"type": "object",
"properties": {
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"GenArtNo": {
"format": "int32",
"description": "Gets or sets the generic article number.",
"type": "integer"
},
"GenCritNo": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
},
"GenArtsForWorkIdsMsg": {
"description": "Class {GenArtsForWorkIdsMsg} contains the properties which are necessary to call the web service method\r\nGenArtsForWorkIds(GenArtsForWorkIdsMsg).",
"required": [
"WorkIds"
],
"type": "object",
"properties": {
"WorkIds": {
"description": "Gets or sets the work position ids to search for.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"WorkIds": [
0
],
"ConsumerId": "string"
}
},
"PartsForItemMpsMsg": {
"description": "Class {PartsForItemMpsMsg} contains the properties which are necessary to call the web service method\r\nPartsForItemMps(PartsForItemMpsMsg).",
"required": [
"SelectetItemMpIds",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectetItemMpIds": {
"description": "Gets or sets the selected item mount position ids for which the parts are to be queried.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier for labour times work positions id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectetItemMpIds": [
0
],
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"InPaintPartSetItemMp": {
"description": "Represents a item mount position of a part set for the invoice part.",
"type": "object",
"properties": {
"PartSetQualCols": {
"description": "Gets or sets the qualifier collections of the part set.",
"type": "array",
"items": {
"$ref": "#/definitions/InPaintPartSetQualCol"
}
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this part set item mount position is denied.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"PartSetQualCols": [
{
"SetPartId": 0,
"IsSet": false,
"IsNotToOrder": false,
"Parts": [
{
"KindOfPart": 0,
"IsCustomPartPrice": false,
"PartId": 0,
"PartNo": "string",
"PartPriceDate": "0001-01-01T00:00:00",
"PartPriceSupplier": "string",
"Amounts": [
{
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
],
"PartQualColId": 0,
"PartQualColText": "string",
"IsLocked": false,
"Currency": "string",
"IsNotToOrder": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"QualColId": 0,
"QualColText": "string"
}
],
"WorkId": 0,
"IsLocked": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"InPaintPartSetQualCol": {
"description": "Represents a part set qualifier collection for IN",
"type": "object",
"properties": {
"SetPartId": {
"format": "int32",
"description": "Gets or sets the set part id.",
"type": "integer"
},
"IsSet": {
"description": "Gets or sets a value indicating whether this part set qualifier collection is set.",
"type": "boolean"
},
"IsNotToOrder": {
"description": "Former parameter for indicating whether this part set qualifier collection is not to order. Parameter is moved to class InPartData. The value will always be false.",
"type": "boolean"
},
"Parts": {
"description": "Gets or sets a list with parts.",
"type": "array",
"items": {
"$ref": "#/definitions/InPaintPartData"
}
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"SetPartId": 0,
"IsSet": false,
"IsNotToOrder": false,
"Parts": [
{
"KindOfPart": 0,
"IsCustomPartPrice": false,
"PartId": 0,
"PartNo": "string",
"PartPriceDate": "0001-01-01T00:00:00",
"PartPriceSupplier": "string",
"Amounts": [
{
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
],
"PartQualColId": 0,
"PartQualColText": "string",
"IsLocked": false,
"Currency": "string",
"IsNotToOrder": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"QualColId": 0,
"QualColText": "string"
}
},
"InPaintPartData": {
"description": "Represents part data for IN.",
"type": "object",
"properties": {
"KindOfPart": {
"format": "int32",
"description": "Gets or sets the kind of part. Possible enumeration values: - `0` = SparePart
- `5` = PaintMaterial
",
"enum": [
0,
5
],
"type": "integer"
},
"IsCustomPartPrice": {
"description": "Gets or sets a value indicating whether the part price is user defined by material factor greater than 1.",
"type": "boolean"
},
"PartId": {
"format": "int32",
"description": "Gets or sets the part id.",
"type": "integer"
},
"PartNo": {
"description": "Gets or sets the part number.",
"type": "string"
},
"PartPrice": {
"format": "double",
"description": "Gets or sets the part price.",
"type": "number"
},
"PartPriceDate": {
"format": "date-time",
"description": "Gets or sets the part price date.",
"type": "string"
},
"PartPriceSupplier": {
"description": "Gets or sets the part price supplier.",
"type": "string"
},
"Amounts": {
"description": "Gets or sets a list of part amounts.",
"type": "array",
"items": {
"$ref": "#/definitions/InPartAmount"
}
},
"PartQualColId": {
"format": "int32",
"description": "Gets or sets the part qualifier collection id.",
"type": "integer"
},
"PartQualColText": {
"description": "Gets or sets the part qualifier collection text.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this part is denied.",
"type": "boolean"
},
"Currency": {
"description": "Gets or sets the currency.",
"type": "string"
},
"IsNotToOrder": {
"description": "Gets or sets a value indicating whether this part set qualifier collection is not to order.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"KindOfPart": 0,
"IsCustomPartPrice": false,
"PartId": 0,
"PartNo": "string",
"PartPriceDate": "0001-01-01T00:00:00",
"PartPriceSupplier": "string",
"Amounts": [
{
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
],
"PartQualColId": 0,
"PartQualColText": "string",
"IsLocked": false,
"Currency": "string",
"IsNotToOrder": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"PartsForItemMpsIncludingQualifiersMsg": {
"description": "Class {PartsForItemMpsIncludingQualifiersMsg} contains the properties which are necessary to call the web service method\r\nPartsForItemMpsIncludingQualifiers(PartsForItemMpsIncludingQualifiersMsg).",
"required": [
"SelectedItemMpIds",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"SelectedItemMpIds": {
"description": "Gets or sets the selected item mount position ids for which the parts are to be queried.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier for labour times work positions id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"SelectedItemMpIds": [
0
],
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"InPartSetItemMpWithQualifiers": {
"description": "Represents a item mount position of a part set for the invoice part.",
"type": "object",
"properties": {
"PartSetQualCols": {
"description": "Gets or sets the qualifier collections of the part set.",
"type": "array",
"items": {
"$ref": "#/definitions/InPartSetQualColWithQualifiers"
}
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this part set item mount position is denied.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"PartSetQualCols": [
{
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"SetPartId": 0,
"IsSet": false,
"IsNotToOrder": false,
"Parts": [
{
"PartId": 0,
"PartNo": "string",
"PartPriceDate": "0001-01-01T00:00:00",
"PartPriceSupplier": "string",
"Amounts": [
{
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
],
"PartQualColId": 0,
"PartQualColText": "string",
"IsLocked": false,
"Currency": "string",
"IsNotToOrder": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"QualColId": 0,
"QualColText": "string"
}
],
"WorkId": 0,
"IsLocked": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"InPartSetQualColWithQualifiers": {
"description": "Represents a part set qualifier collection for IN",
"type": "object",
"properties": {
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where the qualifier collection identifier is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"SetPartId": {
"format": "int32",
"description": "Gets or sets the set part id.",
"type": "integer"
},
"IsSet": {
"description": "Gets or sets a value indicating whether this part set qualifier collection is set.",
"type": "boolean"
},
"IsNotToOrder": {
"description": "Former parameter for indicating whether this part set qualifier collection is not to order. Parameter is moved to class InPartData. The value will always be false.",
"type": "boolean"
},
"Parts": {
"description": "Gets or sets a list with parts.",
"type": "array",
"items": {
"$ref": "#/definitions/InPartData"
}
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"SetPartId": 0,
"IsSet": false,
"IsNotToOrder": false,
"Parts": [
{
"PartId": 0,
"PartNo": "string",
"PartPriceDate": "0001-01-01T00:00:00",
"PartPriceSupplier": "string",
"Amounts": [
{
"Quantity": "string",
"ItemMpId": 0,
"IsOnlyForReference": false,
"QualColId": 0,
"QualColText": "string"
}
],
"PartQualColId": 0,
"PartQualColText": "string",
"IsLocked": false,
"Currency": "string",
"IsNotToOrder": false,
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"QualColId": 0,
"QualColText": "string"
}
},
"QualifierData": {
"description": "Class QualifierData represents a single qualifier. Any qualifier collection is build up\r\nfrom such single qualifiers.",
"type": "object",
"properties": {
"QualifierId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier.",
"type": "integer"
},
"QualifierText": {
"description": "Gets or sets the text of the qualifier.",
"type": "string"
},
"QualifierGroupId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier group.",
"type": "integer"
},
"QualifierGroupName": {
"description": "Gets or sets the name of the qualifier group.",
"type": "string"
}
},
"example": {
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
},
"PartsForWorksMsg": {
"description": "Class {PartsForWorksMsg} contains the properties which are necessary to call the web service method\r\nPartsForWorks(PartsForWorksMsg).",
"required": [
"SelectedWorkIds",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedWorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nwebservice methods MdWorkSteps(MdWorkStepsMsg) and LtWorkSteps(LtWorkStepsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedWorkIds": [
0
],
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"PartsForWorksIncludingQualifiersMsg": {
"description": "Class {PartsForWorksIncludingQualifiersMsg} contains the properties which are necessary to call the web service method\r\nPartsForWorksIncludingQualifiers(PartsForWorksIncludingQualifiersMsg).",
"required": [
"SelectedWorkIds",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"SelectedWorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nwebservice methods MdWorkSteps(MdWorkStepsMsg) and LtWorkSteps(LtWorkStepsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"SelectedWorkIds": [
0
],
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"PartsForWorksWithWorkPositionsMsg": {
"description": "Class {PartsForWorksWithWorkPositionsMsg} contains the properties which are necessary to call the web service method\r\nPartsForWorksWithWorkPositions(PartsForWorksWithWorkPositionsMsg).",
"required": [
"SelectedWorkPositions",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId",
"ShowPaint"
],
"type": "object",
"properties": {
"SelectedWorkPositions": {
"description": "Gets or sets a collection with selected work positions represented by ItemMpId, KorId, QualColId and only for maintenance. This values can be fetched by using the\r\nwebservice methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkPosition"
}
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
},
"ShowPaint": {
"description": "Gets or sets a value indicating whether to enable paint.",
"type": "boolean"
},
"PaintSettings": {
"description": "Gets or sets a collection of the settings class PaintSettings.",
"type": "array",
"items": {
"$ref": "#/definitions/PaintWorkPosSettings"
}
}
},
"example": {
"SelectedWorkPositions": [
{
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ShowPaint": false,
"PaintSettings": [
{
"ItemMpId": 0,
"ItemMpText": "string",
"KindOfAssembly": 0,
"IsTwoSided": false,
"AreaQualCol": {
"QualColId": 0,
"QualColText": "string"
},
"KindOfPaint": 0,
"KindOfMaterial": 0,
"KindOfInstallation": 0,
"KindOfAdditions": [],
"KindOfPaintStage": 0,
"PaintGroupId": 0
}
]
}
},
"PartsForWorksWithWorkPositionsIncludingQualifiersMsg": {
"description": "Class {PartsForWorksWithWorkPositionsIncludingQualifiersMsg} contains the properties which are necessary to call the web service method\r\nPartsForWorksWithWorkPositionsIncludingQualifiers(PartsForWorksWithWorkPositionsIncludingQualifiersMsg).",
"required": [
"SelectedWorkPositions",
"MdBodyQualColId",
"LtBodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"SelectedWorkPositions": {
"description": "Gets or sets a collection with selected work positions represented by ItemMpId, KorId, QualColId and only for maintenance. This values can be fetched by using the\r\nwebservice methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"$ref": "#/definitions/InWorkPosition"
}
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for maintenance work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"SelectedWorkPositions": [
{
"IsMdWorkPos": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"MdBodyQualColId": 0,
"LtBodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"WorkMetadataMsg": {
"description": "Class {WorkMetadataMsg} contains the properties which are necessary to call the web service methods\r\nWorkMetadata(WorkMetadataMsg).",
"required": [
"LanguageCode",
"WorkIds"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"WorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nweb service methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"example": {
"LanguageCode": "string",
"WorkIds": [
0
]
}
},
"WorkMetadata": {
"description": "A work metadata.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the identifier of the work.",
"type": "integer"
},
"NewFastenerNeeded": {
"description": "Gets or sets a value indicating whether the new fastener are needed.\r\nAs a text representation for this property the text from property {!:InfoText} can be used.",
"type": "boolean"
},
"InfoTexts": {
"description": "Gets or sets a list of additional texts.",
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"WorkId": 0,
"NewFastenerNeeded": false
}
},
"VehicleHasComfortWiringMsg": {
"description": "Class {VehicleHasComfortWiringMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"CwdManualListMsg": {
"description": "Class {CwdManualListMsg} is the base class for a few message classes and\r\ncontains the properties which are necessary to call web service methods\r\nManualList(CwdManualListMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"CwdMainGroup": {
"description": "Class WdMainGroup represents a main group for wiring data. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/CwdSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"CwdSubGroup": {
"description": "Class WdSubGroup represents a sub group for wiring data. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/CwdItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"CwdItemMp": {
"description": "Class WdItemMp represents an item mount position for wiring data. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/CwdManual"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"CwdManual": {
"description": "Class WdManual represents a manual for wiring data. A manual belongs to an item mount position.",
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
},
"CwdMaingroupHtmlMsg": {
"description": "Class {CwdMaingroupHtmlMsg} contains the properties which are necessary to call web service method\r\nMainGroupHtml(CwdMaingroupHtmlMsg).",
"required": [
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"CwdSubGroupHtmlMsg": {
"description": "Class {CwdSubGroupHtmlMsg} contains the properties which are necessary to call web service method\r\nSubGroupHtml(CwdSubGroupHtmlMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId",
"LinkUrl",
"MainGroupId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"MainGroupId": 0,
"ConsumerId": "string"
}
},
"CwdManualHtmlMsg": {
"description": "Class {CwdManualHtmlMsg} contains the properties which are necessary to call web service methods\r\nManualHtml(CwdManualHtmlMsg).",
"required": [
"PrintView",
"CountryCode",
"LanguageCode",
"TypeId",
"ManualId",
"LinkUrl"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"type": "boolean"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ManualId": 0,
"LinkUrl": "string",
"ConsumerId": "string"
}
},
"CwdLinkedComfortWiringDiagramsMsg": {
"description": "Class {CwdLinkedComfortWiringDiagramsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedComfortWiringDiagrams(CwdLinkedComfortWiringDiagramsMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"ImageNamesForComfortWiringManualMsg": {
"description": "Class {ImageNamesForComfortWiringManualMsg} contains the properties which are necessary to call web service methods\r\nImageNamesForComfortWiringManual(ImageNamesForComfortWiringManualMsg).",
"required": [
"ManualId"
],
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"ManualId": 0
}
},
"ApplicationTextsMsg": {
"description": "Class {ApplicationTextsMsg} contains the properties which are necessary to call the web service method\r\nApplicationTexts(ApplicationTextsMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"ApplicationText": {
"description": "Class ApplicationText represents an text which is used in the application.",
"type": "object",
"properties": {
"ApplicationTextId": {
"format": "int32",
"description": "Gets or sets the id of the application text.",
"type": "integer"
},
"Text": {
"description": "Gets or sets the application text.",
"type": "string"
}
},
"example": {
"ApplicationTextId": 0,
"Text": "string"
}
},
"ApplicationTextMsg": {
"description": "Class {ApplicationTextMsg} contains the properties which are necessary to call the web service method\r\nApplicationText(ApplicationTextMsg).",
"required": [
"LanguageCode",
"TextId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TextId": {
"format": "int32",
"description": "Gets or sets the identifier of the text.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"TextId": 0
}
},
"CountriesMsg": {
"description": "Class {CountriesMsg} contains the properties which are necessary to call the web service method\r\nCountries(CountriesMsg).",
"required": [
"LanguageCode",
"KindOfModule"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"KindOfModule": {
"format": "int32",
"description": "Gets or sets the kind of module after which the collection of supporting countries should be filtered. Possible enumeration values: - `0` = Default
- `1` = Coo
- `2` = CooNew
- `3` = AD
- `4` = BG
- `5` = LT
- `6` = MD
- `7` = DI
- `8` = SOS
- `9` = TD
- `10` = TM
- `11` = WD
- `12` = CO
- `13` = CooUser
- `14` = Ctrl
- `15` = IN
- `16` = VT
- `17` = Info
- `18` = Portal
- `19` = FR
- `20` = MP
- `21` = CWD
- `22` = Paint
",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22
],
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"KindOfModule": 0
}
},
"AdditionalCountryInfo": {
"description": "Class AdditionalCountryInfo represents a country in the AuDaLib with an additional locked parameter. It contains all important information like\r\nName, ISO CountryCode, Currency, etc.",
"type": "object",
"properties": {
"Locked": {
"description": "Gets or sets the locked value for the specific country.",
"type": "boolean"
},
"CountryId": {
"format": "int32",
"description": "Gets or sets the id of the country.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"CountryName": {
"description": "Gets or sets the name of the country.",
"type": "string"
},
"Currency": {
"description": "Gets or sets the currency of the country.",
"type": "string"
},
"ExchangeRate": {
"format": "double",
"description": "Gets or sets the exchange rate at which Euro is the reference currency.",
"type": "number"
}
},
"example": {
"Locked": false,
"CountryId": 0,
"CountryCode": "string",
"CountryName": "string",
"Currency": "string"
}
},
"LanguagesMsg": {
"description": "Class {LanguagesMsg} contains the properties which are necessary to call the web service method\r\nLanguages(LanguagesMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.\r\nBy passing null the result of the web service method Languages\r\nwill be a collection where each language name is in his own language (eg: en -> English (GB); de -> Deutsch; ru -> русский; etc.\r\nPassing a valid language code by this property all the language names will be in the given language.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"AdditionalLanguageInfo": {
"description": "Class AdditionalLanguageInfo represents a language in the AuDaLib and contains an additional locked parameter.",
"type": "object",
"properties": {
"Locked": {
"description": "Gets or sets the locked value for the specific language.",
"type": "boolean"
},
"LanguageId": {
"format": "int32",
"description": "Gets or sets the id of the language.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"LanguageName": {
"description": "Gets or sets the name of the language.",
"type": "string"
},
"IsCompleteFilled": {
"format": "int32",
"description": "Gets or sets a value determining whether all texts are available in this language.",
"type": "integer"
}
},
"example": {
"Locked": false,
"LanguageId": 0,
"LanguageCode": "string",
"LanguageName": "string",
"IsCompleteFilled": 0
}
},
"QualifierGroupListMsg": {
"description": "Class {QualifierGroupListMsg} contains the properties which are necessary to call the web service method\r\nQualifierGroupList(QualifierGroupListMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"QualifierGroup": {
"description": "Class QualifierGroup represents a qualifier group. A qualifier group divides the plenty of qualifiers\r\ninto logical groups like body, engine, air-conditioning system, etc.",
"type": "object",
"properties": {
"QualifierGroupId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier group.",
"type": "integer"
},
"QualifierGroupName": {
"description": "Gets or sets the name of the qualifier group.",
"type": "string"
}
},
"example": {
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
},
"LinkTypeData": {
"description": "Class {LinkTypeData} contains the information which character is assigned to an enumeration value of KindOfLinkTypes.",
"type": "object",
"properties": {
"KindOfLink": {
"format": "int32",
"description": "Gets or sets the kind of link. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
],
"type": "integer"
},
"LinkCharacter": {
"description": "Gets or sets the link character.",
"type": "string"
}
},
"example": {
"KindOfLink": 0,
"LinkCharacter": "\u0000"
}
},
"WorkPosOnlyForReferenceTextMsg": {
"description": "Class {WorkPosOnlyForReferenceTextMsg} contains the properties which are necessary to call the web service method\r\nWorkPostOnlyForReferenceText(WorkPostOnlyForReferenceTextMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"GetAdOnlyForReferenceTextMsg": {
"description": "Class {GetAdOnlyForReferenceTextMsg} contains the properties which are necessary to call the web service method\r\nGetInNotToOrderText(GetInNotToOrderTextMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"GetInNotToOrderTextMsg": {
"description": "Class {GetInNotToOrderTextMsg} contains the properties which are necessary to call the web service method\r\nGetInNotToOrderText(GetInNotToOrderTextMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"GetWorkPosTecRmiTimeTextMsg": {
"description": "Class {GetWorkPosTecRmiTimeTextMsg} contains the properties which are necessary to call the web service method\r\nGetWorkPosTecRmiTimeText(GetWorkPosTecRmiTimeTextMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"GetWorkPosCompositeTimeTextMsg": {
"description": "Class {GetWorkPosCompositeTimeTextMsg} contains the properties which are necessary to call the web service method\r\nGetWorkPosCompositeTimeText(GetWorkPosCompositeTimeTextMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"VersionInfo": {
"type": "object",
"properties": {
"BuildNumber": {
"type": "string"
},
"VersionNumber": {
"type": "string"
},
"DbVersionNumber": {
"type": "string"
}
},
"example": {
"BuildNumber": "string",
"VersionNumber": "string",
"DbVersionNumber": "string"
}
},
"AdditionalVehicleInformationForServiceBookMsg": {
"description": "Class {AdditionalVehicleInformationForServiceBookMsg} contains the properties which are necessary to call web service methods\r\nAdditionalVehicleInformationForServiceBook(AdditionalVehicleInformationForServiceBookMsg).",
"required": [
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"TypeId": 0
}
},
"AdditionalVehicleInformationForServiceBook": {
"description": "A class containing additional information about the vehicle for ServiceBook.",
"type": "object",
"properties": {
"VehicleHasGasPressureSprings": {
"description": "Gets or sets a value indicating whether the vehicle has gas pressure springs to check during a maintenance.",
"type": "boolean"
}
},
"example": {
"VehicleHasGasPressureSprings": false
}
},
"QualifierCollectionsMsg": {
"description": "Class {QualifierCollectionsMsg} contains the properties which are necessary to call the web service method\r\nQualifierCollections(QualifierCollectionsMsg).",
"required": [
"QualColIds",
"LanguageCode"
],
"type": "object",
"properties": {
"QualColIds": {
"description": "Gets or sets a collection of qualifier collection ids.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"QualColIds": [
0
],
"LanguageCode": "string"
}
},
"QualifierCollection": {
"description": "Class QualifierCollection represents a qualifier collection having a list of separate qualifiers from which the collection is build up.\r\nThe qualifier collection delivers a further differentiation for an item.",
"type": "object",
"properties": {
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where this qualifier collection is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"QualColId": 0,
"QualColText": "string"
}
},
"VehicleHasPpMsg": {
"description": "Class {VehicleHasPpMsg} contains the properties which are necessary to call the web service module check methods\r\nVehicleHasPp(VehicleHasPpMsg).",
"required": [
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"TypeId": 0
}
},
"PpListMsg": {
"description": "Class {PpListMsg} contains the properties which are necessary to call the web service module check methods\r\nPpListMsg(PpListMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"PpMainGroup": {
"description": "Represents a main group for mount position. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/PpSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"PpSubGroup": {
"description": "Represents a sub group for mount position manuals. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/PpItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"PpItemMp": {
"description": "Represents an item mount position for the mount position manual topic tree. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/PpManual"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"PpManual": {
"description": "Represents a mount position manual in the field of mount position. A manual belongs to an item mount position.",
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
},
"ManualHtmlMsg": {
"description": "Class {ManualHtmlMsg} contains the properties which are necessary to call web service methods\r\nManualHtml(ManualHtmlMsg).",
"required": [
"PrintView",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId",
"LinkUrl",
"ManualId"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets the time of the kind of work. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url. It is used where documents contains links\r\nto other and are shown in custom application.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"PrintView": false,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"ConsumerId": "string",
"ManualId": 0
}
},
"ImageNamesForComponentsMsg": {
"description": "Class {ImageNamesForComponentsMsg} contains the properties which are necessary to call the web service methods\r\nImageNamesForComponents(ImageNamesForComponentsMsg).",
"required": [
"CountryCode",
"TypeId",
"ManualId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"TypeId": 0,
"ManualId": 0
}
},
"PpLinkedTechnicalDataMsg": {
"description": "Class {PpLinkedTechnicalDataMsg} contains the properties which are necessary to call the web service methods\r\nLinkedTechnicalData(PpLinkedTechnicalDataMsg).",
"required": [
"ImageLinkId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"ImageLinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the image link.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ImageLinkId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"PpLinkedTechnicalManualsMsg": {
"description": "Class {PpLinkedTechnicalManualsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedTechnicalManuals(PpLinkedTechnicalManualsMsg).",
"required": [
"ImageLinkId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"ImageLinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the image link.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched\r\nby using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ImageLinkId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"TmItemMp": {
"description": "Represents an item mount position for the technical manual topic tree. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/TmManual"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"TmManual": {
"description": "Represents a technical manual in the field of technical manual. A manual belongs to an item mount position.",
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
},
"PpLinkedLabourTimesMsg": {
"description": "Class {PpLinkedLabourTimesMsg} contains the properties which are necessary to call web service methods\r\nLinkedLabourTimes(PpLinkedLabourTimesMsg).",
"required": [
"ImageLinkId",
"CountryCode",
"LanguageCode",
"TypeId",
"LtBodyQualColId"
],
"type": "object",
"properties": {
"ImageLinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the image link.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched\r\nby using the ServiceVt web service.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
}
},
"example": {
"ImageLinkId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"LtBodyQualColId": 0
}
},
"PpLinkedWiringDiagramMsg": {
"description": "Class {PpLinkedWiringDiagramMsg} contains the properties which are necessary to call the web service methods\r\nLinkedWiringDiagram(PpLinkedWiringDiagramMsg).",
"required": [
"ImageLinkId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"ImageLinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the image link.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched\r\nby using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ImageLinkId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"WdItemMp": {
"description": "Class WdItemMp represents an item mount position for wiring data. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/WdManual"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"WdManual": {
"description": "Class WdManual represents a manual for wiring data. A manual belongs to an item mount position.",
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
},
"PpLinkedDiagnosticsMsg": {
"description": "Class {PpLinkedDiagnosticsMsg} contains the properties which are necessary to call web service methods\r\nLinkedDiagnostics(PpLinkedDiagnosticsMsg).",
"required": [
"ImageLinkId",
"LanguageCode",
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"ImageLinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the image link.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
}
},
"example": {
"ImageLinkId": 0,
"LanguageCode": "string",
"TypeId": 0,
"CountryCode": "string",
"ComponentTypeId": 0
}
},
"DiItemMp": {
"description": "Represents an item mount position for the diagnose topic tree. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"SystemQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the system qualifier collection.",
"type": "integer"
},
"SystemQualColText": {
"description": "Gets or sets the text of the system qualifier collection.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/DiValue"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"SystemQualColId": 0,
"SystemQualColText": "string",
"ComponentTypeId": 0,
"Manuals": [
{
"QualColText": "string",
"QualColId": 0,
"SystemQualColText": "string",
"SystemQualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"DiValue": {
"description": "Represents a topic manual in the diagnose part of the AuDaLib. Manuals can be found in the modules Sos, technical manuals (Tm) and wiring diagram (Wd).\r\nThe purpose of the class DiValue is to provide a base for these modules. A manual belongs to an item mount position. SOS, TM and WD.\r\nA manual belongs to an item mount position.",
"type": "object",
"properties": {
"QualColText": {
"description": "Gets or sets the text the qualifier collection.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"SystemQualColText": {
"description": "Gets or sets the text of the system qualifier collection.",
"type": "string"
},
"SystemQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the system qualifier collection.",
"type": "integer"
}
},
"example": {
"QualColText": "string",
"QualColId": 0,
"SystemQualColText": "string",
"SystemQualColId": 0
}
},
"PpLinkedFuseRelaisMsg": {
"description": "Class {PpLinkedFuseRelaisMsg} contains the properties which are necessary to call web service methods\r\nLinkedFuseRelais(PpLinkedFuseRelaisMsg).",
"required": [
"ImageLinkId",
"CountryCode",
"LanguageCode",
"ComponentId",
"TypeId"
],
"type": "object",
"properties": {
"ImageLinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the image link.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ComponentId": {
"format": "int32",
"description": "Gets or sets the identifier of the component.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ImageLinkId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ComponentId": 0,
"TypeId": 0
}
},
"FrBoxItemMp": {
"description": "Represents configuration settings of a fuse and relays box.",
"type": "object",
"properties": {
"BoxConfigurations": {
"description": "Gets or sets a list of different fuse und relays box configurations.",
"type": "array",
"items": {
"$ref": "#/definitions/FrBoxConfiguration"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"BoxConfigurations": [
{
"BoxBuildPeriodQualCols": [
{
"QualColId": 0,
"QualColText": "string"
}
],
"BoxConfigurationId": 0,
"BuildPeriodQualColText": "string",
"BuildPeriodQualColId": 0,
"QualColId": 0,
"QualColText": "string"
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"FrBoxConfiguration": {
"description": "Represents a specific configuration of a fuse and relays box.",
"type": "object",
"properties": {
"BoxBuildPeriodQualCols": {
"description": "Gets or sets a list of qualifier collections which represents the possible years where this component has been build.",
"type": "array",
"items": {
"$ref": "#/definitions/QualCol"
}
},
"BoxConfigurationId": {
"format": "int32",
"description": "Gets or sets the identifier of the box configuration mapping.",
"type": "integer"
},
"BuildPeriodQualColText": {
"description": "Gets or sets the build period qual col text.",
"type": "string"
},
"BuildPeriodQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the build period qual col.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"BoxBuildPeriodQualCols": [
{
"QualColId": 0,
"QualColText": "string"
}
],
"BoxConfigurationId": 0,
"BuildPeriodQualColText": "string",
"BuildPeriodQualColId": 0,
"QualColId": 0,
"QualColText": "string"
}
},
"CoAddInfoKeysMsg": {
"description": "Class {CoAddInfoKeysMsg} contains the properties which are necessary to call web service method\r\nAddInfoKeys(GetVtAddInfoKeysMsg).",
"required": [
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ClassId": {
"format": "int32",
"description": "Gets or sets the class id.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ClassId": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"AddInfoKey": {
"description": "Class AddInfoKey represents an additional information key for example a weight, a fuel type, an engine and so on.",
"type": "object",
"properties": {
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the additional information key id. The id is negative if the additional information key represents a component.",
"type": "integer"
},
"AddInfoKeyName": {
"description": "Gets or sets the name of the additional information key.",
"type": "string"
},
"AddInfoKeyValueType": {
"description": "Gets or sets the type of the additional information key value.\r\nPossible types are int, float and string.",
"type": "string"
},
"AddInfoKeyValueTypeName": {
"description": "Gets the name of the type of the additional information key value.\r\nThe types are formatted as XML-Schema datatypes and possible types\r\nare xs:integer, xs:float and xs:string.",
"type": "string"
},
"IsAllowedMultiple": {
"description": "Gets or sets a value indicating whether a vehicle is allowed to have multiple additional information keys of the same id.",
"type": "boolean"
},
"IsAllowedForAllClasses": {
"description": "Gets or sets a value indicating whether this additional information key is allowed for all classes.",
"type": "boolean"
},
"CountrySpecific": {
"format": "int32",
"description": "Gets or sets a value indicating whether the additional information key is specific for a certain country.",
"type": "integer"
},
"FilterRange": {
"format": "double",
"description": "Gets or sets the filter range. When filtering vehicles by additional information keys of numeric types,\r\nnot only vehicles of the exact input value are returned but also vehicles for which the input value differs\r\nby the filter range distance.",
"type": "number"
}
},
"example": {
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValueTypeName": "string",
"IsAllowedMultiple": false,
"IsAllowedForAllClasses": false,
"CountrySpecific": 0
}
},
"CoAddInfoKeyIdValuesMsg": {
"description": "Class {CoAddInfoKeyIdValuesMsg} contains the properties which are necessary to call the web service methods\r\nAddInfoKeyIdValues(GetVtAddInfoKeyIdValuesMsg)\">GetVtAddInfoKeyIdValues(...).",
"required": [
"AddInfoKeyId",
"LanguageCode"
],
"type": "object",
"properties": {
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the id of the additional information key whose values should be returned from the method\r\nAddInfoKeyIdValues(GetVtAddInfoKeyIdValuesMsg).\r\nThe possible id can be fetched by a calling the web service method\r\nAddInfoKeys(GetVtAddInfoKeysMsg).",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"AddInfoKeyId": 0,
"LanguageCode": "string"
}
},
"CoTypeDetailMsg": {
"description": "Class {CoTypeDetailMsg} contains the properties which are necessary to call the web service methods\r\nTypeDetails(CoTypeDetailMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"CoTypeDetail": {
"description": "Represents a component type detail.\r\nAll levels of the component tree are present. Furthermore, a list of type details is available.",
"type": "object",
"properties": {
"ComponentClassId": {
"format": "int32",
"description": "Gets or sets the id of this component class.",
"type": "integer"
},
"ComponentClassName": {
"description": "Gets or sets the name of the component class.",
"type": "string"
},
"ComponentMakeId": {
"format": "int32",
"description": "Gets or sets the component manufacturer id.",
"type": "integer"
},
"ComponentMakeName": {
"description": "Gets or sets the name of the component manufacturer.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the type id of the component.",
"type": "integer"
},
"ComponentTypeName": {
"description": "Gets or sets the name of the component type.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this component type is denied.",
"type": "boolean"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of this component class.",
"type": "integer"
},
"TcdMakeId": {
"format": "int32",
"description": "Gets or sets the TecDoc make id of this component.",
"type": "integer"
},
"TcdRangeId": {
"format": "int32",
"description": "Gets or sets the TecDoc range id of this component.",
"type": "integer"
},
"TcdTypeId": {
"format": "int32",
"description": "Gets or sets the TecDoc type id of this component.",
"type": "integer"
},
"TypeDetails": {
"description": "Gets or sets a list of type details if this component.",
"type": "array",
"items": {
"$ref": "#/definitions/CoTypeAdditionalDetail"
}
}
},
"example": {
"ComponentClassId": 0,
"ComponentClassName": "string",
"ComponentMakeId": 0,
"ComponentMakeName": "string",
"ComponentTypeId": 0,
"ComponentTypeName": "string",
"IsLocked": false,
"ClassId": 0,
"TcdMakeId": 0,
"TcdRangeId": 0,
"TcdTypeId": 0,
"TypeDetails": [
{
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
]
}
},
"CoTypeAdditionalDetail": {
"description": "Represents an additional detail of a component type.",
"type": "object",
"properties": {
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the additional information key id.\r\nThe id is negative if the additional information key represents a component.",
"type": "integer"
},
"AddInfoKeyName": {
"description": "Gets or sets the name of the additional information key.",
"type": "string"
},
"AddInfoKeyValue": {
"description": "Gets or sets the value for this additional information key.",
"type": "string"
}
},
"example": {
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
},
"ClassesMsg": {
"description": "Class {ClassesMsg} contains the properties which are necessary to call the web service method\r\nClasses(ClassesMsg).",
"required": [
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ComponentMakeNameFilter": {
"description": "Gets or sets the filter for the component make names.\r\nPassing an empty string means no filtering after component\r\nmanufacturer names.",
"type": "string"
},
"ComponentTypeNameFilter": {
"description": "Gets or sets the filter for the component type names.\r\nPassing an empty string means no component type name filtering.",
"type": "string"
},
"AddInfoKeyFilter": {
"description": "Gets or sets the filter after additional information like manufacturer id, fuel typ, axle configuration etc.",
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKeyFilterParameter"
}
},
"TypeIdFilter": {
"format": "int32",
"description": "Gets or sets the filter after the TecRMI type id.\r\nPassing null means no type id filtering.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ComponentMakeNameFilter": "string",
"ComponentTypeNameFilter": "string",
"AddInfoKeyFilter": [
{
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
],
"TypeIdFilter": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"AddInfoKeyFilterParameter": {
"description": "Class AddInfoKeyFilterParameter represents an additional information key filter parameter.\r\nThis class is used in order to filter vehicles and components by additional information keys.",
"type": "object",
"properties": {
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the additional information key id. The id is negative if the additional information key represents a component.",
"type": "integer"
},
"AddInfoKeyFilterValue": {
"description": "Gets or sets the additional information key filter value.",
"type": "string"
}
},
"example": {
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
},
"CoClass": {
"description": "Represents a component class. In the component tree hierarchy, component classes are on the topmost level.",
"type": "object",
"properties": {
"ComponentClassId": {
"format": "int32",
"description": "Gets or sets the id of the component class.",
"type": "integer"
},
"ComponentClassName": {
"description": "Gets or sets the name of the component class.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this component class is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this component class.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"ComponentClassId": 0,
"ComponentClassName": "string",
"IsLocked": false,
"InfoDataExists": false
}
},
"MakesMsg": {
"description": "Class {MakesMsg} contains the properties which are necessary to call the web service method\r\nMakes(MakesMsg).",
"required": [
"ComponentClassId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ComponentClassId": {
"format": "int32",
"description": "Gets or sets the component class id. This id can be fetch by calling the web service\r\nmethod Classes(ClassesMsg)\".",
"type": "integer"
},
"ComponentMakeNameFilter": {
"description": "Gets or sets the filter for the component make names.\r\nPassing an empty string means no filtering after component\r\nmanufacturer names.",
"type": "string"
},
"ComponentTypeNameFilter": {
"description": "Gets or sets the filter for the component type names.\r\nPassing an empty string means no component type name filtering.",
"type": "string"
},
"AddInfoKeyFilter": {
"description": "Gets or sets the filter after additional information like manufacturer id, fuel typ, axle configuration etc.",
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKeyFilterParameter"
}
},
"TypeIdFilter": {
"format": "int32",
"description": "Gets or sets the filter after the TecRMI type id.\r\nPassing null means no type id filtering.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ComponentClassId": 0,
"ComponentMakeNameFilter": "string",
"ComponentTypeNameFilter": "string",
"AddInfoKeyFilter": [
{
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
],
"TypeIdFilter": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"CoMake": {
"description": "Represents a component make in the component topic tree. In the component tree hierarchy,\r\ncomponent makes are children of component classes. Each component make belongs to exactly one component class.",
"type": "object",
"properties": {
"ComponentMakeId": {
"format": "int32",
"description": "Gets or sets the component make id.",
"type": "integer"
},
"ComponentMakeName": {
"description": "Gets or sets the name of the component manufacturer.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this component manufacturer is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this component manufacturer.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"ComponentMakeId": 0,
"ComponentMakeName": "string",
"IsLocked": false,
"InfoDataExists": false
}
},
"TypesMsg": {
"description": "Class {TypesMsg} contains the properties which are necessary to call the web service method\r\nTypes(TypesMsg).",
"required": [
"ComponentMakeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ComponentMakeId": {
"format": "int32",
"description": "Gets or sets the component make id. This id can be fetch by calling the web service\r\nmethod Makes(MakesMsg).",
"type": "integer"
},
"ComponentTypeNameFilter": {
"description": "Gets or sets the filter for the component type names.\r\nPassing an empty string means no component type name filtering.",
"type": "string"
},
"AddInfoKeyFilter": {
"description": "Gets or sets the filter after additional information like manufacturer id, fuel typ, axle configuration etc.",
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKeyFilterParameter"
}
},
"TypeIdFilter": {
"format": "int32",
"description": "Gets or sets the filter after the TecRMI type id.\r\nPassing null means no type id filtering.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ComponentMakeId": 0,
"ComponentTypeNameFilter": "string",
"AddInfoKeyFilter": [
{
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
],
"TypeIdFilter": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"CoType": {
"description": "Represents a component type. In the component tree hierarchy, component types are children of component makes.\r\nEach component type belongs to exactly one component manufacturer.",
"type": "object",
"properties": {
"ComponentTypeDetails": {
"description": "Gets or sets a list of component type details.",
"type": "array",
"items": {
"$ref": "#/definitions/CoTypeAdditionalDetail"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this component type is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this component type.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the type id of this component.",
"type": "integer"
},
"ComponentTypeName": {
"description": "Gets or sets the name of the component type.",
"type": "string"
}
},
"example": {
"ComponentTypeDetails": [
{
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
],
"IsLocked": false,
"InfoDataExists": false,
"ComponentTypeId": 0,
"ComponentTypeName": "string"
}
},
"VehicleHasDiagnosticsMsg": {
"description": "Class {VehicleHasDiagnosticsMsg} contains the properties which are necessary to call the web service methods\r\nVehicleHasDiagnostics(VehicleHasDiagnosticsMsg).",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"DiComponentsForTypeMsg": {
"description": "Class {DiComponentsForTypeMsg} contains the properties which are necessary to call the web service methods\r\nComponentsForType(DiComponentsForTypeMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"DiComponentType": {
"description": "Represents a component type in the diagnose module.",
"type": "object",
"properties": {
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the type id of this component.",
"type": "integer"
},
"ComponentTypeName": {
"description": "Gets or sets the name of the component type.",
"type": "string"
}
},
"example": {
"ComponentTypeId": 0,
"ComponentTypeName": "string"
}
},
"ListMsg": {
"description": "Class {ListMsg} contains the properties which are necessary to call the web service methods List(ListMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets identifier of the component type.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ComponentTypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"DiMainGroup": {
"description": "Represents a main group for diagnose topic tree. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/DiSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"SystemQualColId": 0,
"SystemQualColText": "string",
"ComponentTypeId": 0,
"Manuals": [
{
"QualColText": "string",
"QualColId": 0,
"SystemQualColText": "string",
"SystemQualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"DiSubGroup": {
"description": "Represents a sub group of the diagnose topic tree. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/DiItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"SystemQualColId": 0,
"SystemQualColText": "string",
"ComponentTypeId": 0,
"Manuals": [
{
"QualColText": "string",
"QualColId": 0,
"SystemQualColText": "string",
"SystemQualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"DiMainGroupHtml": {
"description": "Class {DiMainGroupHtml} contains the properties which are necessary to call the web service methods\r\nMainGroupHtml(DiMainGroupHtml).",
"required": [
"TypeId",
"MainGroupId",
"PrintView",
"LanguageCode",
"CountryCode",
"LinkUrl"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the identifier of the main group.",
"type": "integer"
},
"PrintView": {
"description": "Determines whether a document for printing or the normal document should be created.",
"type": "boolean"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"ComponentTypeId": 0,
"MainGroupId": 0,
"PrintView": false,
"LanguageCode": "string",
"CountryCode": "string",
"LinkUrl": "string",
"ConsumerId": "string"
}
},
"DiSubGroupHtml": {
"description": "Class {DiSubGroupHtml} contains the properties which are necessary to call the web service methods\r\nSubGroupHtml(DiSubGroupHtml).",
"required": [
"TypeId",
"SubGroupId",
"PrintView",
"LanguageCode",
"CountryCode",
"LinkUrl"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the identifier of the sub group.",
"type": "integer"
},
"PrintView": {
"description": "Determines whether a document for printing or the normal document should be created.",
"type": "boolean"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"ComponentTypeId": 0,
"SubGroupId": 0,
"PrintView": false,
"LanguageCode": "string",
"CountryCode": "string",
"LinkUrl": "string",
"ConsumerId": "string"
}
},
"DiManualHtmlMsg": {
"description": "Class {DiManualHtmlMsg} contains the properties which are necessary to call the web service methods\r\nManualHtml(DiManualHtmlMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"QualColId",
"PrintView",
"LinkUrl",
"ItemMpId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"SystemQualColId": {
"format": "int32",
"description": "Gets or sets the id of the system qualifier collection.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection. The id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"PrintView": {
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"type": "boolean"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url. It is used where documents contains links\r\nto other and are shown in custom application.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"SystemQualColId": 0,
"QualColId": 0,
"PrintView": false,
"ComponentTypeId": 0,
"LinkUrl": "string",
"ItemMpId": 0,
"ConsumerId": "string"
}
},
"ConnectorConditionsMsg": {
"description": "Class {ConnectorConditionsMsg} contains the properties which are necessary to call the web service methods\r\nConnectorConditions(ConnectorConditionsMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"DiConnectorCondition": {
"description": "Represents a connector condition for diagnose part of the AuDaLib.",
"type": "object",
"properties": {
"ConnectorConditionId": {
"format": "int32",
"description": "Gets or sets the id of the connector condition.",
"type": "integer"
},
"ConnectorConditionText": {
"description": "Gets or sets the text of the connector condition.",
"type": "string"
}
},
"example": {
"ConnectorConditionId": 0,
"ConnectorConditionText": "string"
}
},
"ValueMsg": {
"description": "Class {ValueMsg} contains the properties which are necessary to call the web service methods\r\nValue(ValueMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"QualColId",
"IncludeCondition",
"ItemMpId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"SystemQualColId": {
"format": "int32",
"description": "Gets or sets the id of the system qualifier collection.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection. The id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"IncludeCondition": {
"description": "Determines whether the condition should be included.",
"type": "boolean"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the component type id.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"SystemQualColId": 0,
"QualColId": 0,
"IncludeCondition": false,
"ComponentTypeId": 0,
"ItemMpId": 0
}
},
"DiDiagnosticsValue": {
"description": "Represents a diagnostics value for diagnose module.",
"type": "object",
"properties": {
"MeasurementValue": {
"$ref": "#/definitions/DiMeasurementValue",
"description": "Gets or sets the measurement value."
},
"ConnectorConditionId": {
"format": "int32",
"description": "Gets or sets the id of the connector condition.",
"type": "integer"
},
"AdditionalText": {
"description": "Gets or sets the additional text.",
"type": "string"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"ImageName": {
"description": "Gets or sets the name of the image.",
"type": "string"
},
"MeasurementConditions": {
"description": "Gets or sets the measurement conditions.",
"type": "array",
"items": {
"$ref": "#/definitions/DiMeasurementCondition"
}
},
"MeasurementSourceText": {
"description": "Gets or sets the text of the measurement source.",
"type": "string"
},
"MeasurementDestinationText": {
"description": "Gets or sets the text of the measurement destination.",
"type": "string"
},
"AdditionalConditionQualColText": {
"description": "Gets or sets the text of the additional condition qualifier collection.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets the content id.",
"type": "integer"
},
"ValueId": {
"format": "int32",
"description": "Gets or sets the id of the value.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"MeasurementValue": {
"MeasurementValueClassId": 0,
"MeasuringUnitId": 0,
"MinLimitValue": 0.0,
"MinLimitBound": 0,
"MinWarnValue": 0.0,
"MinWarnBound": 0,
"MinIndicateValue": 0.0,
"MinIndicateBound": 0,
"TargetValue": 0.0,
"TargetBound": 0,
"MaxIndicateValue": 0.0,
"MaxIndicateBound": 0,
"MaxWarnValue": 0.0,
"MaxWarnBound": 0,
"MaxLimitValue": 0.0,
"MaxLimitBound": 0
},
"ConnectorConditionId": 0,
"AdditionalText": "string",
"ManualId": 0,
"ImageName": "string",
"MeasurementConditions": [
{
"MeasurementConditionId": 0,
"MeasurementValue": {
"MeasurementValueClassId": 0,
"MeasuringUnitId": 0,
"MinLimitValue": 0.0,
"MinLimitBound": 0,
"MinWarnValue": 0.0,
"MinWarnBound": 0,
"MinIndicateValue": 0.0,
"MinIndicateBound": 0,
"TargetValue": 0.0,
"TargetBound": 0,
"MaxIndicateValue": 0.0,
"MaxIndicateBound": 0,
"MaxWarnValue": 0.0,
"MaxWarnBound": 0,
"MaxLimitValue": 0.0,
"MaxLimitBound": 0
},
"ItemMpId": 0,
"QualColId": 0,
"ItemMpText": "string",
"QualColText": "string"
}
],
"MeasurementSourceText": "string",
"MeasurementDestinationText": "string",
"AdditionalConditionQualColText": "string",
"ContentId": 0,
"ValueId": 0,
"ItemMpId": 0,
"ItemMpText": "string",
"QualColId": 0,
"QualColText": "string"
}
},
"DiMeasurementValue": {
"description": "Represents a measurement value in the diagnose module.",
"type": "object",
"properties": {
"MeasurementValueClassId": {
"format": "int32",
"description": "Gets or sets the id of the measurement value class.",
"type": "integer"
},
"MeasuringUnitId": {
"format": "int32",
"description": "Gets or sets the measuring unit id.",
"type": "integer"
},
"MinLimitValue": {
"format": "double",
"description": "Gets or sets the minimum limit value.",
"type": "number"
},
"MinLimitBound": {
"format": "int32",
"description": "Gets or sets the minimum limit bound.",
"type": "integer"
},
"MinWarnValue": {
"format": "double",
"description": "Gets or sets the minimum warn value.",
"type": "number"
},
"MinWarnBound": {
"format": "int32",
"description": "Gets or sets the minimum warn bound.",
"type": "integer"
},
"MinIndicateValue": {
"format": "double",
"description": "Gets or sets the minimum indicate value.",
"type": "number"
},
"MinIndicateBound": {
"format": "int32",
"description": "Gets or sets the minimum indicate bound.",
"type": "integer"
},
"TargetValue": {
"format": "double",
"description": "Gets or sets the target value.",
"type": "number"
},
"TargetBound": {
"format": "int32",
"description": "Gets or sets the target bound.",
"type": "integer"
},
"MaxIndicateValue": {
"format": "double",
"description": "Gets or sets the maximum indicate value.",
"type": "number"
},
"MaxIndicateBound": {
"format": "int32",
"description": "Gets or sets the maximum indicate bound.",
"type": "integer"
},
"MaxWarnValue": {
"format": "double",
"description": "Gets or sets the maximum warn value.",
"type": "number"
},
"MaxWarnBound": {
"format": "int32",
"description": "Gets or sets the maximum warn bound.",
"type": "integer"
},
"MaxLimitValue": {
"format": "double",
"description": "Gets or sets the maximum limit value.",
"type": "number"
},
"MaxLimitBound": {
"format": "int32",
"description": "Gets or sets the maximum limit bound.",
"type": "integer"
}
},
"example": {
"MeasurementValueClassId": 0,
"MeasuringUnitId": 0,
"MinLimitValue": 0.0,
"MinLimitBound": 0,
"MinWarnValue": 0.0,
"MinWarnBound": 0,
"MinIndicateValue": 0.0,
"MinIndicateBound": 0,
"TargetValue": 0.0,
"TargetBound": 0,
"MaxIndicateValue": 0.0,
"MaxIndicateBound": 0,
"MaxWarnValue": 0.0,
"MaxWarnBound": 0,
"MaxLimitValue": 0.0,
"MaxLimitBound": 0
}
},
"DiMeasurementCondition": {
"description": "Represents a measurement condition for the diagnose module.",
"type": "object",
"properties": {
"MeasurementConditionId": {
"format": "int32",
"description": "Gets or sets the measurement condition id.",
"type": "integer"
},
"MeasurementValue": {
"$ref": "#/definitions/DiMeasurementValue",
"description": "Gets or sets the measurement value."
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the qualifier collection id.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the item mount position text.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
}
},
"example": {
"MeasurementConditionId": 0,
"MeasurementValue": {
"MeasurementValueClassId": 0,
"MeasuringUnitId": 0,
"MinLimitValue": 0.0,
"MinLimitBound": 0,
"MinWarnValue": 0.0,
"MinWarnBound": 0,
"MinIndicateValue": 0.0,
"MinIndicateBound": 0,
"TargetValue": 0.0,
"TargetBound": 0,
"MaxIndicateValue": 0.0,
"MaxIndicateBound": 0,
"MaxWarnValue": 0.0,
"MaxWarnBound": 0,
"MaxLimitValue": 0.0,
"MaxLimitBound": 0
},
"ItemMpId": 0,
"QualColId": 0,
"ItemMpText": "string",
"QualColText": "string"
}
},
"ImageNamesForDiagnosticsMsg": {
"description": "Class {ImageNamesForDiagnosticsMsg} contains the properties which are necessary to call the web service methods\r\nImageNamesForDiagnostics(ImageNamesForDiagnosticsMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"QualColId",
"ItemMpId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"SystemQualColId": {
"format": "int32",
"description": "Gets or sets the id of the system qualifier collection.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection. The id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the component type id.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"SystemQualColId": 0,
"QualColId": 0,
"ComponentTypeId": 0,
"ItemMpId": 0
}
},
"DiLinkedTechnicalDataMsg": {
"description": "Class {DiLinkedTechnicalDataMsg} contains the properties which are necessary to call the web service methods\r\nLinkedTechnicalData(DiLinkedTechnicalDataMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ContentId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets identifier of the content.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ContentId": 0
}
},
"DiLinkedTechnicalManualsMsg": {
"description": "Class {DiLinkedTechnicalManualsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedTechnicalManuals(DiLinkedTechnicalManualsMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ContentId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets the identifier of the content.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ContentId": 0
}
},
"DiLinkedLabourTimesMsg": {
"description": "Class {DiLinkedLabourTimesMsg} contains the properties which are necessary to call the web service methods\r\nLinkedLabourTimes(DiLinkedLabourTimesMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ContentId",
"LtBodyQualColId",
"KindOfWorkTime"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets the identifier of the content.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction. The id can be fetched by using the\r\nequivalent methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets the kind of work time. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ContentId": 0,
"LtBodyQualColId": 0,
"KindOfWorkTime": 0
}
},
"DiLinkedWiringDiagramsMsg": {
"description": "Class {DiLinkedWiringDiagramsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedWiringDiagrams(DiLinkedWiringDiagramsMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ContentId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets identifier of the content.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ContentId": 0
}
},
"DiLinkedRelaysFusesMsg": {
"description": "Class {DiLinkedRelaysFusesMsg} contains the properties which are necessary to call the web service methods\r\nLinkedRelaysFuses(DiLinkedRelaysFusesMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ContentId",
"ComponentTypeId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets the identifier of the content.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ContentId": 0,
"ComponentTypeId": 0
}
},
"DiLinkedPartPositionMsg": {
"description": "Class {DiLinkedPartPositionMsg} contains the properties which arenecessary to call the web service methods\r\nLinkedPartPosition(DiLinkedPartPositionMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ContentId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ContentId": {
"format": "int32",
"description": "Gets or sets identifier of the content.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ContentId": 0
}
},
"MeasuringUnitsMsg": {
"description": "Class {MeasuringUnitsMsg} contains the properties which are necessary to call the web service methods MeasuringUnits(MeasuringUnitsMsg).",
"required": [
"LanguageCode"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"LanguageCode": "string"
}
},
"DiMeasuringUnit": {
"description": "Represents a measuring unit in the diagnose part of the AuDaLib.",
"type": "object",
"properties": {
"MeasuringUnitId": {
"format": "int32",
"description": "Gets or sets the id of the measuring unit.",
"type": "integer"
},
"UnitToken": {
"description": "Gets or sets the unit token.",
"type": "string"
},
"MeasuringUnitText": {
"description": "Gets or sets the text of the measuring unit.",
"type": "string"
}
},
"example": {
"MeasuringUnitId": 0,
"UnitToken": "string",
"MeasuringUnitText": "string"
}
},
"ErrorCodeMsg": {
"description": "An error code message.",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ErrorCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ErrorCode": {
"description": "Gets or sets the OEBD error code. Value must start with P followed by 4 digits long error code. Use leading 0 for error codes with less then 4 digits. Example P0001.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets identifier of the component type.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ErrorCode": "string",
"ComponentTypeId": 0
}
},
"DiItemMpDetailed": {
"description": "Represents an item mount position for the diagnose topic tree. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.\r\nClass contains detailed information for item and mount position from ItemMp.",
"type": "object",
"properties": {
"ItemId": {
"format": "int32",
"description": "Gets or sets the identifier of the item.",
"type": "integer"
},
"ItemText": {
"description": "Gets or sets the item text.",
"type": "string"
},
"MountPosId": {
"format": "int32",
"description": "Gets or sets the identifier of the mount position.",
"type": "integer"
},
"MountPosText": {
"description": "Gets or sets the mount position text.",
"type": "string"
},
"SystemQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the system qualifier collection.",
"type": "integer"
},
"SystemQualColText": {
"description": "Gets or sets the text of the system qualifier collection.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/DiValue"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"ItemId": 0,
"ItemText": "string",
"MountPosId": 0,
"MountPosText": "string",
"SystemQualColId": 0,
"SystemQualColText": "string",
"ComponentTypeId": 0,
"Manuals": [
{
"QualColText": "string",
"QualColId": 0,
"SystemQualColText": "string",
"SystemQualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"ItemListMsg": {
"description": "An error code message.",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"ItemID"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ItemID": {
"format": "int32",
"description": "Gets or sets the identifier of the diagnostics item.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ItemID": 0,
"ComponentTypeId": 0
}
},
"VehicleHasGraphicsMsg": {
"description": "Class {VehicleHasGraphicsMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"BodiesForGraphicsMsg": {
"description": "Class {BodiesForGraphicsMsg} contains the properties which are necessary to call web service methods\r\nBodiesForGraphics(BodiesForGraphicsMsg),",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"BgQualCol": {
"description": "Represents a qualifier collection for body graphic. In general, the qualifier collection delivers a further differentiation for an item (in this case a vehicle type).\r\nVehicle types may have different bodies (e.g. 3-door, 5-door) that can be referenced by the qualifier collection.",
"type": "object",
"properties": {
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this qualifier collection is denied.",
"type": "boolean"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"IsLocked": false,
"QualColId": 0,
"QualColText": "string"
}
},
"BgManualListMsg": {
"description": "Class {BgManualListMsg} contains the properties which are necessary to call the web service methods\r\nManualList(BgManualListMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string"
}
},
"BgMainGroup": {
"description": "Represents a main group for the body graphic topic tree. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/BgSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupQualColId": 0,
"SubGroupQualifier": "string",
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"BgSubGroup": {
"description": "Represents a sub group of the body graphic topic tree. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupQualColId": {
"format": "int32",
"description": "Gets or sets the id of the sub group qualifier collection.",
"type": "integer"
},
"SubGroupQualifier": {
"description": "Gets or sets the sub group qualifier.",
"type": "string"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMp"
}
}
},
"example": {
"SubGroupQualColId": 0,
"SubGroupQualifier": "string",
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"BgItemMp": {
"description": "Represents an item mount position for the body graphics topic tree. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"VehicleHtmlMsg": {
"description": "Class {VehicleHtmlMsg} contains the properties which are necessary to call the web service methods\r\nVehicleHtml(VehicleHtmlMsg).",
"required": [
"BodyQualColId",
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"BgMaingroupHtmlMsg": {
"description": "Class {BgMaingroupHtmlMsg} contains the properties which are necessary to call the web service methods\r\nMaingroupHtml(BgMaingroupHtmlMsg).",
"required": [
"BodyQualColId",
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId",
"MainGroupId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"MainGroupId": 0,
"ConsumerId": "string"
}
},
"SubGroupQualsMsg": {
"description": "Class {SubGroupQualsMsg} contains the properties which are necessary to call the web service methods\r\nSubGroupQuals(SubGroupQualsMsg).",
"required": [
"BodyQualColId",
"SubGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"BgSubGroupHtmlMsg": {
"description": "Class {BgSubGroupHtmlMsg} contains the properties which are necessary to call the web service methods\r\nSubgroupHtml(BgSubGroupHtmlMsg).",
"required": [
"SubGroupQualCol",
"BodyQualColId",
"LinkUrl",
"SubGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"SubGroupQualCol": {
"format": "int32",
"description": "Gets or sets the sub group qualifier collection.",
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"SubGroupQualCol": 0,
"BodyQualColId": 0,
"LinkUrl": "string",
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"BgLinkedTechnicalManualsMsg": {
"description": "Class {BgLinkedTechnicalManualsMsg} contains the properties which are necessary to call web service methods\r\nLinkedTechnicalManuals(BgLinkedTechnicalManualsMsg).",
"required": [
"ItemGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"ItemGroupId": {
"format": "int32",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ItemGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"BgLinkedAdjustmentDataMsg": {
"description": "Class {BgLinkedAdjustmentDataMsg} contains the properties which are necessary to call the web service methods\r\nLinkedAdjustmentData(BgLinkedAdjustmentDataMsg).",
"required": [
"BodyQualColId",
"ItemGroupId",
"TypeId",
"LanguageCode",
"CountryCode"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"ItemGroupId": {
"format": "int32",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"ItemGroupId": 0,
"TypeId": 0,
"LanguageCode": "string",
"CountryCode": "string",
"ConsumerId": "string"
}
},
"BgLinkedWorkPositionsMsg": {
"description": "Class {BgLinkedWorkPositionsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedWorkPositions(BgLinkedWorkPositionsMsg).",
"required": [
"KindOfWorkTime",
"BodyQualColId",
"ItemGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"ItemGroupId": {
"format": "int32",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"KindOfWorkTime": 0,
"BodyQualColId": 0,
"ItemGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"BgPaintItemMpKor": {
"description": "Represents an item mount position along with a kind of repair of the body graphics topic tree.",
"type": "object",
"properties": {
"IsPaintAllowed": {
"description": "Determines if this item mount position along with a kind of repair for labour times can be passed to paint.",
"type": "boolean"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"IsPaintAllowed": false,
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"BgLinkedSparePartsMsg": {
"description": "Class {BgLinkedSparePartsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedSpareParts(BgLinkedSparePartsMsg).",
"required": [
"BodyQualColId",
"ItemGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"ItemGroupId": {
"format": "int32",
"description": "Gets or sets the id of one part shown on the sub group picture.\r\nIt is used to fetch further information about this part like\r\nlinked technical manuals or work positions.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"ItemGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"PreselectedDataMsg": {
"description": "Class {PreselectedDataMsg} contains the properties which are necessary to call the web service method\r\nPreselectedData(PreselectedDataMsg).",
"required": [
"SelectedWorkIds",
"TypeId"
],
"type": "object",
"properties": {
"SelectedPartData": {
"description": "Gets or sets a collection with information about the parts which are actual selected.",
"type": "array",
"items": {
"$ref": "#/definitions/InSelectedPartValue"
}
},
"SelectedWorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nwebservice methods MdWorkSteps(MdWorkStepsMsg) and LtWorkSteps(LtWorkStepsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"SelectedPartData": [
{
"ItemMpId": 0,
"PartNo": "string",
"PartPrice": 0.0,
"PartAmount": 0.0,
"PartQualColId": 0,
"PartAmountQualColId": 0,
"KindOfPart": 0
}
],
"SelectedWorkIds": [
0
],
"TypeId": 0
}
},
"VehicleImageMsg": {
"description": "Class {VehicleHtmlMsg} contains the properties which are necessary to call the web service methods\r\nVehicleImage(VehicleImageMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"MaingroupImageMsg": {
"description": "Class {MaingroupImageMsg} contains the properties which are necessary to call the web service methods\r\nMaingroupImage(MaingroupImageMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"TypeId",
"MainGroupId",
"LanguageCode"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"CountryCode": "string",
"TypeId": 0,
"MainGroupId": 0,
"ConsumerId": "string",
"LanguageCode": "string"
}
},
"SubgroupImageMsg": {
"description": "Class {SubgroupImageMsg} contains the properties which are necessary to call the web service methods\r\nSubgroupImage(SubgroupImageMsg).",
"required": [
"SubGroupQualCol",
"BodyQualColId",
"CountryCode",
"TypeId",
"SubGroupId",
"LanguageCode"
],
"type": "object",
"properties": {
"SubGroupQualCol": {
"format": "int32",
"description": "Gets or sets the sub group qualifier which identified the variant of the sub group image.\r\nThis id can be fetched by using SubGroupQuals(SubGroupQualsMsg)\" webservice method.",
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"SubGroupQualCol": 0,
"BodyQualColId": 0,
"CountryCode": "string",
"TypeId": 0,
"SubGroupId": 0,
"ConsumerId": "string",
"LanguageCode": "string"
}
},
"JavaScriptCodeMsg": {
"description": "Class {JavaScriptCodeMsg} contains the properties which are necessary to call the web service methods\r\nJavaScriptCode(JavaScriptCodeMsg).",
"required": [
"LinkUrl"
],
"type": "object",
"properties": {
"LinkUrl": {
"description": "Gets or sets the link URL.\r\nThe actual link information is going to be added at the end of this url.",
"type": "string"
}
},
"example": {
"LinkUrl": "string"
}
},
"VehicleHasGraphicsGenArtMsg": {
"description": "Class {VehicleHasGraphicsGenArtMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"BodiesForGraphicsGenArtMsg": {
"description": "Class {BodiesForGraphicsGenArtMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"LanguageCode",
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"TecDocBodyId": {
"format": "int32",
"description": "Gets or sets the identifier of the tec document body.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"TecDocBodyId": 0,
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0
}
},
"GenArtManualListMsg": {
"description": "Class {GenArtManualListMsg} contains the properties which are necessary to call the web service methods\r\nGenArtManualList(GenArtManualListMsg).",
"required": [
"GenericArticles",
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"BgItemMpGenArt": {
"description": "Represents an item mount position along with a generic article for TecDoc body graphics.",
"type": "object",
"properties": {
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the item mount position id.",
"type": "integer"
},
"GenArtNo": {
"format": "int32",
"description": "Gets or sets the generic article number.",
"type": "integer"
},
"GenCritNo": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
},
"BgMainGroupTecDoc": {
"description": "A BgMainGroup for TecDoc generic article numbers.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/BgSubGroupTecDoc"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupQualColId": 0,
"SubGroupQualifier": "string",
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"GenArts": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"BgSubGroupTecDoc": {
"description": "A BgSubGroup for TecDoc generic article numbers.",
"type": "object",
"properties": {
"SubGroupQualColId": {
"format": "int32",
"description": "Gets or sets the id of the sub group qualifier collection.",
"type": "integer"
},
"SubGroupQualifier": {
"description": "Gets or sets the sub group qualifier.",
"type": "string"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpTecDoc"
}
}
},
"example": {
"SubGroupQualColId": 0,
"SubGroupQualifier": "string",
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"GenArts": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"BgItemMpTecDoc": {
"description": "A BgItemMp for TecDoc generic article numbers.",
"type": "object",
"properties": {
"GenArts": {
"description": "Gets or sets the list of TecDoc generic article numbers.",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"GenArts": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"GenArtVehicleHtmlMsg": {
"description": "Class {GenArtVehicleHtmlMsg} contains the properties which are necessary to call the web service methods\r\nGenArtVehicleHtml(GenArtVehicleHtmlMsg).",
"required": [
"GenericArticles",
"BodyQualColId",
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"BodyQualColId": 0,
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"GenArtVehicleImageMsg": {
"description": "Class {GenArtVehicleImageMsg} contains the properties which are necessary to call the web service methods\r\nGenArtVehicleImage(GenArtVehicleImageMsg).",
"required": [
"GenericArticles",
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"GenArtMaingroupHtmlMsg": {
"description": "Class {GenArtMaingroupHtmlMsg} contains the properties which are necessary to call the web service methods\r\nGenArtMaingroupHtml(GenArtMaingroupHtmlMsg).",
"required": [
"GenericArticles",
"BodyQualColId",
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId",
"MainGroupId"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"BodyQualColId": 0,
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"MainGroupId": 0,
"ConsumerId": "string"
}
},
"GenArtMaingroupImageMsg": {
"description": "Class {GenArtMaingroupImageMsg} contains the properties which are necessary to call the web service methods\r\nGenArtMaingroupImage(GenArtMaingroupImageMsg).",
"required": [
"GenericArticles",
"BodyQualColId",
"CountryCode",
"TypeId",
"MainGroupId",
"LanguageCode"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"BodyQualColId": 0,
"CountryCode": "string",
"TypeId": 0,
"MainGroupId": 0,
"ConsumerId": "string",
"LanguageCode": "string"
}
},
"GenArtSubGroupQualsMsg": {
"description": "Class {GenArtSubGroupQualsMsg} contains the properties which are necessary to call the web service methods\r\nGenArtSubGroupQuals(GenArtSubGroupQualsMsg).",
"required": [
"GenericArticles",
"BodyQualColId",
"SubGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"BodyQualColId": 0,
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"GenArtSubgroupHtmlMsg": {
"description": "Class {GenArtSubgroupHtmlMsg} contains the properties which are necessary to call the web service methods\r\nGenArtSubgroupHtml(GenArtSubgroupHtmlMsg).",
"required": [
"GenericArticles",
"SubGroupQualCol",
"BodyQualColId",
"LinkUrl",
"SubGroupId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"SubGroupQualCol": {
"format": "int32",
"description": "Gets or sets the sub group qualifier collection.",
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"SubGroupQualCol": 0,
"BodyQualColId": 0,
"LinkUrl": "string",
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"GenArtSubgroupImageMsg": {
"description": "Class {GenArtSubgroupImageMsg} contains the properties which are necessary to call the web service methods\r\nGenArtSubgroupImage(GenArtSubgroupImageMsg).",
"required": [
"GenericArticles",
"SubGroupQualCol",
"BodyQualColId",
"CountryCode",
"TypeId",
"SubGroupId",
"LanguageCode"
],
"type": "object",
"properties": {
"GenericArticles": {
"description": "Gets or sets the list of TecDoc generic article numbers",
"type": "array",
"items": {
"$ref": "#/definitions/BgItemMpGenArt"
}
},
"SubGroupQualCol": {
"format": "int32",
"description": "Gets or sets the sub group qualifier which identified the variant of the sub group image.\r\nThis id can be fetched by using SubGroupQuals(SubGroupQualsMsg)\" webservice method.",
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"GenericArticles": [
{
"ItemMpId": 0,
"GenArtNo": 0,
"GenCritNo": 0,
"GenCritValue": "string"
}
],
"SubGroupQualCol": 0,
"BodyQualColId": 0,
"CountryCode": "string",
"TypeId": 0,
"SubGroupId": 0,
"ConsumerId": "string",
"LanguageCode": "string"
}
},
"BgLinkedGenArtMsg": {
"description": "Class {BgLinkedGenArtMsg} contains the properties which are necessary to call the web service methods\r\nLinkedGenArt(BgLinkedGenArtMsg).",
"required": [
"ItemGroupId",
"TypeId"
],
"type": "object",
"properties": {
"ItemGroupId": {
"format": "int32",
"description": "Gets or sets a list of identifiers of the part item mps.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"ItemGroupId": 0,
"TypeId": 0
}
},
"VehicleHasMaintenanceMsg": {
"description": "Class {VehicleHasMaintenanceMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"MdBodiesForMdMsg": {
"description": "Class {MdBodiesForMdMsg} contains the properties which are necessary to call web service methods\r\nBodiesForMaintenance(MdBodiesForMdMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"MdBodyQualCol": {
"description": "Represents a body qualifier collection for maintenance data. In general, the qualifier collection delivers a further differentiation for an item\r\n(in this case a vehicle type). Vehicle types may have different bodies (e.g. 3-door, 5-door) that can be referenced by the qualifier collection.",
"type": "object",
"properties": {
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"QualColId": 0,
"QualColText": "string"
}
},
"MakeInfoManualsMsg": {
"description": "Class {MakeInfoManualsMsg} contains the properties which are necessary to call web service methods\r\nMakeInfoManuals(MakeInfoManualsMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"MdTmLinkedManual": {
"description": "Represents a technical manual which is linked from the maintenance part of the AuDaLib.",
"type": "object",
"properties": {
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this linked manual is denied.",
"type": "boolean"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"IsLocked": false,
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
},
"SubGroupsMsg": {
"description": "Class {SubGroupsMsg} contains the properties which are necessary to call web service methods\r\nSubGroups(SubGroupsMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"MdWorkStepsMsg": {
"description": "Class {MdWorkStepsMsg} contains the properties which are necessary to call the web service methods\r\nWorkSteps(MdWorkStepsMsg).",
"required": [
"BodyQualColId",
"KorId",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the topic tree id.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"KorId": 0,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0,
"ConsumerId": "string"
}
},
"MdWorkPosWithComplexityReference": {
"description": "Represents a work position for maintenance data part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the enum value representing the complexity reference. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdWorkPosSuggestion": {
"description": "Represents a work position for maintenance data part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.\r\nContains additionally suggested work positions related to a work position.",
"type": "object",
"properties": {
"SuggestedWorkPositions": {
"description": "Gets or sets the suggested work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/WorkPosData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"SuggestedWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"WorkPosData": {
"description": "Represents work position data. This class forms a common base for the more specific work position data classes.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdWorkPosSuggestionWithComplexityReference": {
"description": "Represents a work position for maintenance data part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.\r\nContains additionally suggested work positions related to a work position.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the enum value representing the complexity reference. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"SuggestedWorkPositions": {
"description": "Gets or sets the suggested work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/WorkPosData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"SuggestedWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdWorkStepsIncludingQualifiersMsg": {
"description": "Class {MdWorkStepsIncludingQualifiersMsg} contains the properties which are necessary to call the web service methods\r\nWorkStepsIncludingQualifiers(MdWorkStepsIncludingQualifiersMsg).",
"required": [
"BodyQualColId",
"KorId",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"KorId": 0,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0,
"ConsumerId": "string"
}
},
"MdWorkPosWithQualifiers": {
"description": "Represents a work position for maintenance data part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.",
"type": "object",
"properties": {
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where the qualifier collection identifier is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdWorkPosWithQualifiersComplexityReference": {
"description": "Represents a work position for maintenance data part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the enum value representing the complexity reference. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where the qualifier collection identifier is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"MdWorksMsg": {
"description": "Class {MdWorksMsg} contains the properties which are necessary to call web service methods\r\nWorks(MdWorksMsg).",
"required": [
"BodyQualColId",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"MdSubGroupWorks": {
"description": "Represents a sub group for maintenance data including info about work positions.",
"type": "object",
"properties": {
"Services": {
"description": "Gets or sets the service list.",
"type": "array",
"items": {
"$ref": "#/definitions/MdItemMpKorWorks"
}
},
"AdditionalWorks": {
"description": "Gets or sets a collection of additional maintenance work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdAddItemMpKorWorks"
}
},
"IsMultipleServicesAllowed": {
"description": "Gets or sets a value indicating whether multiple service work positions can be selected or not.",
"type": "boolean"
},
"IsOnlyAdditionServiceAllowed": {
"description": "Gets or sets a value indicating whether it is allowed to select additional service work positions without having selected a service main work position or not.",
"type": "boolean"
}
},
"example": {
"Services": [
{
"WorkSteps": [
{
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"AdditionalWorks": [
{
"AddText": "string",
"WorkSteps": [
{
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"IsMultipleServicesAllowed": false,
"IsOnlyAdditionServiceAllowed": false
}
},
"MdItemMpKorWorks": {
"description": "Represents an item mount position along with a kind of repair for maintenance data and a list of related work positions.",
"type": "object",
"properties": {
"WorkSteps": {
"description": "Gets or sets the work steps.",
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPos"
}
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"WorkSteps": [
{
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MdAddItemMpKorWorks": {
"description": "Represents an item mount position along with a kind of repair and additional text for the maintenance data part of the AuDaLib and a list of related work positions.",
"type": "object",
"properties": {
"AddText": {
"description": "Gets or sets the additional text.",
"type": "string"
},
"WorkSteps": {
"description": "Gets or sets the work steps.",
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPos"
}
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"AddText": "string",
"WorkSteps": [
{
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MdSubGroupWorksWithComplexityReference": {
"description": "Represents a sub group for maintenance data including info about work positions including a reference indicating their complexity.",
"type": "object",
"properties": {
"Services": {
"description": "Gets or sets the service list including a reference indicating their complexity.",
"type": "array",
"items": {
"$ref": "#/definitions/MdItemMpKorWorksWithComplexityReference"
}
},
"AdditionalWorks": {
"description": "Gets or sets a collection of additional maintenance work positions including a reference indicating their complexity.",
"type": "array",
"items": {
"$ref": "#/definitions/MdAddItemMpKorWorksWithComplexityReference"
}
},
"IsMultipleServicesAllowed": {
"description": "Gets or sets a value indicating whether multiple service work positions can be selected or not.",
"type": "boolean"
},
"IsOnlyAdditionServiceAllowed": {
"description": "Gets or sets a value indicating whether it is allowed to select additional service work positions without having selected a service main work position or not.",
"type": "boolean"
}
},
"example": {
"Services": [
{
"WorkSteps": [
{
"Complexity": 1,
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"AdditionalWorks": [
{
"AddText": "string",
"WorkSteps": [
{
"Complexity": 1,
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"IsMultipleServicesAllowed": false,
"IsOnlyAdditionServiceAllowed": false
}
},
"MdItemMpKorWorksWithComplexityReference": {
"description": "Represents an item mount position along with a kind of repair for maintenance data and a list of related work positions\r\nincluding a reference about their complexity.",
"type": "object",
"properties": {
"WorkSteps": {
"description": "Gets or sets the work steps.",
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosWithComplexityReference"
}
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"WorkSteps": [
{
"Complexity": 1,
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MdAddItemMpKorWorksWithComplexityReference": {
"description": "Represents an item mount position along with a kind of repair and additional text for the maintenance data part of the AuDaLib and a list of related work positions.",
"type": "object",
"properties": {
"AddText": {
"description": "Gets or sets the additional text.",
"type": "string"
},
"WorkSteps": {
"description": "Gets or sets the work steps.",
"type": "array",
"items": {
"$ref": "#/definitions/MdWorkPosWithComplexityReference"
}
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"AddText": "string",
"WorkSteps": [
{
"Complexity": 1,
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"MdVehicleBodyImageNameMsg": {
"description": "Class {MdVehicleBodyImageNameMsg} contains the properties which are necessary to call web service method\r\nVehicleBodyImageName(MdVehicleBodyImageNameMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"MdVehicleBodyImage": {
"description": "A maintenance data vehicle body image.",
"type": "object",
"properties": {
"VehicleBodyImageName": {
"description": "Gets or sets the file name of the vehicle body image.",
"type": "string"
},
"VehicleBodyImageUrl": {
"description": "Gets or sets URL of the vehicle body image. Created using the AuDaLib settings.",
"type": "string"
}
},
"example": {
"VehicleBodyImageName": "string",
"VehicleBodyImageUrl": "string"
}
},
"MaintenancePlanDataMsg": {
"description": "Class {MaintenancePlanDataMsg} contains the properties which are necessary to call web service methods\r\nMaintenancePlanData(MaintenancePlanDataMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"ServiceWorkIds": {
"description": "Gets or sets a collection of service main work ids. The ids can be fetched by calling the\r\nwebservice method SubGroups(SubGroupsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"AdditionalWorkIds": {
"description": "Gets or sets a collection of additional work ids. The ids can be fetched by calling the\r\nwebservice method SubGroups(SubGroupsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"ServiceWorkIds": [
0
],
"AdditionalWorkIds": [
0
],
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"MdServicePlan": {
"description": "Represents a service plan for maintenance data.",
"type": "object",
"properties": {
"ServiceWorkPositions": {
"description": "Gets or sets a collection of service work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServicePlanWork"
}
},
"AdditionalWorkPositions": {
"description": "Gets or sets a collection of additional work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServicePlanWork"
}
},
"MdDataSource": {
"format": "int32",
"description": "indicates whether the received data is from OE data or from a TecAlliance certified Service Possible enumeration values: ",
"enum": [
0,
1
],
"type": "integer"
}
},
"example": {
"ServiceWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"SortNr": 0,
"ServicePlanPositions": [
{
"PositionText": "string",
"PositionLinkType": 0,
"PositionLinkValue": 0,
"Amount": "string",
"AmountLinkType": 0,
"AmountLinkValue": 0,
"SortNo": 0
}
]
}
],
"AdditionalWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"SortNr": 0,
"ServicePlanPositions": [
{
"PositionText": "string",
"PositionLinkType": 0,
"PositionLinkValue": 0,
"Amount": "string",
"AmountLinkType": 0,
"AmountLinkValue": 0,
"SortNo": 0
}
]
}
],
"MdDataSource": 0
}
},
"MdServicePlanWork": {
"description": "Specifies the raw data of a maintenance plan.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"SortNr": {
"format": "int32",
"description": "Gets or sets the sort number.",
"type": "integer"
},
"ServicePlanPositions": {
"description": "Gets or sets a collection of service plan positions.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServicePlanPosition"
}
}
},
"example": {
"WorkId": 0,
"WorkText": "string",
"SortNr": 0,
"ServicePlanPositions": [
{
"PositionText": "string",
"PositionLinkType": 0,
"PositionLinkValue": 0,
"Amount": "string",
"AmountLinkType": 0,
"AmountLinkValue": 0,
"SortNo": 0
}
]
}
},
"MdServicePlanPosition": {
"description": "Represents a position of a service plan for maintenance data.",
"type": "object",
"properties": {
"PositionText": {
"description": "Gets or sets the text of the position.",
"type": "string"
},
"PositionLinkType": {
"format": "int32",
"description": "Gets or sets the link type of the position. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
],
"type": "integer"
},
"PositionLinkValue": {
"format": "int32",
"description": "Gets or sets the link value of the position.",
"type": "integer"
},
"Amount": {
"description": "Gets or sets the amount.",
"type": "string"
},
"AmountLinkType": {
"format": "int32",
"description": "Gets or sets the link type of the amount. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
],
"type": "integer"
},
"AmountLinkValue": {
"format": "int32",
"description": "Gets or sets the the amount of the link value.",
"type": "integer"
},
"SortNo": {
"format": "int32",
"description": "Gets or sets the sort number.",
"type": "integer"
}
},
"example": {
"PositionText": "string",
"PositionLinkType": 0,
"PositionLinkValue": 0,
"Amount": "string",
"AmountLinkType": 0,
"AmountLinkValue": 0,
"SortNo": 0
}
},
"MaintenancePlanHtmlMsg": {
"description": "Class {MaintenancePlanHtmlMsg} contains the properties which are necessary to call web service methods\r\nMaintenancePlanHtml(MaintenancePlanHtmlMsg).",
"required": [
"BodyQualColId",
"PrintView",
"ShowTyreTable",
"CountryCode",
"LanguageCode",
"TypeId",
"LinkUrl"
],
"type": "object",
"properties": {
"ServiceWorkIds": {
"description": "Gets or sets a collection of service main work ids. The ids can be fetched by calling the\r\nwebservice method SubGroups(SubGroupsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"AdditionalWorkIds": {
"description": "Gets or sets a collection of additional work ids. The ids can be fetched by calling the\r\nwebservice method SubGroups(SubGroupsMsg).",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"OptionalHeaderValues": {
"description": "Gets or sets a collection of optional header values. By passing values it is possible to display additional\r\ninformation on the html document like telephone number, date, job number, etc.",
"type": "array",
"items": {
"$ref": "#/definitions/OptHeaderValue"
}
},
"PrintView": {
"description": "Gets or sets a value indicating whether the document should be optimized for printing.",
"type": "boolean"
},
"ShowTyreTable": {
"description": "Gets or sets a value indicating whether the document should contains a table\r\nwhere information about the tyres (eg. pressure or tread depth) can be listed or not.",
"type": "boolean"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"PrintViewEditingValues": {
"description": "Gets or sets a collection of print editing values. By transferring values,\r\nit is possible to select whether the entire maintenance plan should be displayed\r\nor only individual elements such as adjustment data, technical manuals or the work steps.",
"type": "array",
"items": {
"$ref": "#/definitions/PrintViewEditingMsg"
}
},
"OptionalValues": {
"description": "Gets or sets a collection of optional values. By passing values it is possible to display additional\r\ninformation on the html document like the values for mileage for the next service, date the order carried out, remarks from the mechanics etc.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptionalValues"
}
},
"OptionalWorkItemSelection": {
"description": "Gets or sets a collection of optional work item selection to tick the checkboxes for 'ok', 'not ok' and 'fixed'. Passing WorkId, ManualId and OrderId as the key to identify the work.\r\nThe possible values of the property Checked for the array are member of the CheckboxChecked.\r\nenum.\r\nGets or sets the optional work item selection.",
"type": "array",
"items": {
"$ref": "#/definitions/MdOptionalWorkItemSelection"
}
}
},
"example": {
"ServiceWorkIds": [
0
],
"AdditionalWorkIds": [
0
],
"BodyQualColId": 0,
"OptionalHeaderValues": [
{
"KindOfHeaderValue": 0,
"HeaderValue": "string"
}
],
"PrintView": false,
"ShowTyreTable": false,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"ConsumerId": "string",
"PrintViewEditingValues": [
{
"KindOfPrintViewEditingKey": 0,
"EditingValue": false
}
],
"OptionalValues": [
{
"KindOfValue": 0,
"Value": {}
}
],
"OptionalWorkItemSelection": [
{
"WorkId": 0,
"ManualId": 0,
"OrderId": 0
}
]
}
},
"PrintViewEditingMsg": {
"description": "contains two values to edit the print view of the MaintenancePlan.",
"type": "object",
"properties": {
"KindOfPrintViewEditingKey": {
"format": "int32",
"description": "wich part of the print view should be edited Possible enumeration values: - `0` = ExcludeAD
- `1` = ExcludeTM
- `2` = ExcludeServicePlan
",
"enum": [
0,
1,
2
],
"type": "integer"
},
"EditingValue": {
"description": "should the part be excluded or not",
"type": "boolean"
}
},
"example": {
"KindOfPrintViewEditingKey": 0,
"EditingValue": false
}
},
"MdOptionalValues": {
"description": "Represents all optional input fields of the service plan html.",
"type": "object",
"properties": {
"KindOfValue": {
"format": "int32",
"description": "Gets or sets the kind of value. Possible enumeration values: - `1` = ServiceBookDigital
- `2` = ServiceBookPaper
- `3` = ServiceBookNone
- `4` = OpenRecallsYes
- `5` = OpenRecallsNo
- `6` = OpenRecallsDone
- `7` = NextInspectionDate
- `8` = PressureFrontLeft
- `9` = PressureFrontRight
- `10` = PressureRearLeft
- `11` = PressureRearRight
- `12` = PressureSpareWheel
- `13` = ProfileFrontLeft
- `14` = ProfileFrontRight
- `15` = ProfileRearLeft
- `16` = ProfileRearRight
- `17` = ProfileSpareWheel
- `18` = ServiceToIntervalDisplay
- `19` = MileageForNextService
- `20` = DateForNextService
- `21` = Remark
- `22` = DateOrderCarriedOut
- `23` = OrderCarriedOutBy
",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23
],
"type": "integer"
},
"Value": {
"description": "Gets or sets the value.",
"type": "object",
"example": {}
}
},
"example": {
"KindOfValue": 0,
"Value": {}
}
},
"MdOptionalWorkItemSelection": {
"description": "A md optional work item selection.",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the kind of value.",
"type": "integer"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the identifier of the content.",
"type": "integer"
},
"OrderId": {
"format": "int32",
"description": "Gets or sets the identifier of the order.",
"type": "integer"
},
"Checked": {
"description": "Gets or sets the value.",
"type": "array",
"items": {
"format": "int32",
"enum": [
0,
1,
2,
3
],
"type": "integer"
}
}
},
"example": {
"WorkId": 0,
"ManualId": 0,
"OrderId": 0
}
},
"VehicleHasMdServiceProposalMsg": {
"description": "Class {VehicleHasMdServiceProposalMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"PossibleGearboxCodesMsg": {
"description": "A maintenance possible gearbox codes message.",
"required": [
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"KindOfVehicleTreeId": {
"format": "int32",
"description": "Gets the kind of vehicle tree id. Possible enumeration values: - `0` = ClassId
- `1` = MakeId
- `2` = RangeId
- `3` = TypeId
",
"enum": [
0,
1,
2,
3
],
"type": "integer",
"readOnly": true
}
},
"example": {
"CountryCode": "string",
"TypeId": 0,
"KindOfVehicleTreeId": 3
}
},
"PossibleCooGroupFilterParametersMsg": {
"description": "A maintenance possible coo group filter parameters message.",
"required": [
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"KindOfVehicleTreeId": {
"format": "int32",
"description": "Gets or sets the kind of vehicle tree id. Possible enumeration values: - `0` = ClassId
- `1` = MakeId
- `2` = RangeId
- `3` = TypeId
",
"enum": [
0,
1,
2,
3
],
"type": "integer",
"readOnly": true
}
},
"example": {
"CountryCode": "string",
"TypeId": 0,
"KindOfVehicleTreeId": 3
}
},
"CooPossibleFilterParameters": {
"description": "Contains information about the possible coo group filter parameters for a selected vehicle.",
"type": "object",
"properties": {
"IsFilterByRegistrationDatePossible": {
"description": "Gets or sets a value indicating whether this object is filter by registration date possible.",
"type": "boolean"
},
"IsFilterByGearBoxCodePossible": {
"description": "Gets or sets a value indicating whether this object is filter by gear box code possible.",
"type": "boolean"
},
"IsFilterByVinNumberPossible": {
"description": "Gets or sets a value indicating whether this object is filter by vin number possible.",
"type": "boolean"
},
"IsFilterByEuroExhaustNormPossible": {
"description": "Gets or sets a value indicating whether this object is filter by euro exhaust normalise possible.",
"type": "boolean"
},
"PossibleEquipmentFilter": {
"description": "Gets or sets the possible equipment filter.",
"type": "array",
"items": {
"format": "int32",
"enum": [
1001,
1002,
1003,
1004,
1005,
1006,
1007,
1008
],
"type": "integer"
}
}
},
"example": {
"IsFilterByRegistrationDatePossible": false,
"IsFilterByGearBoxCodePossible": false,
"IsFilterByVinNumberPossible": false,
"IsFilterByEuroExhaustNormPossible": false,
"PossibleEquipmentFilter": []
}
},
"ServiceProposalCooGroupsMsg": {
"description": "A maintenance service proposal coo groups message.",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"InitialRegistrationDate": {
"format": "date-time",
"description": "Gets or sets the initial registration date.",
"type": "string"
},
"KindOfGearBox": {
"format": "int32",
"description": "Gets or sets the kind of gear box. Possible enumeration values: - `65` = AutomaticGearBox
- `77` = ManualGearBox
- `81` = AutomatedGearBox
",
"enum": [
65,
77,
81
],
"type": "integer"
},
"EuropeanExhaustEmissionStandard": {
"format": "int32",
"description": "Gets or sets the european exhaust emission standard.",
"type": "integer"
},
"EquipmentFilter": {
"description": "Gets or sets the equipment filter.",
"type": "array",
"items": {
"$ref": "#/definitions/CooGroupDefaultFilter"
}
},
"Vin": {
"description": "Gets or sets the vin.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"KindOfGearBox": 65,
"EuropeanExhaustEmissionStandard": 0,
"EquipmentFilter": [
{
"FilterValue": false,
"KindOfFilter": 0
}
],
"Vin": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"CooGroupDefaultFilter": {
"description": "Class object for coo group filter by vehicle equipment parameters.",
"type": "object",
"properties": {
"FilterValue": {
"description": "Gets or sets a value indicating whether the filter value.",
"type": "boolean"
},
"KindOfFilter": {
"format": "int32",
"description": "Gets or sets the kind of filter. Possible enumeration values: - `1001` = Longlife
- `1002` = ParticleFilter
- `1003` = StartStopSystem
- `1004` = Aircondition
- `1005` = TowCoupling
- `1006` = FuelAdditive_AddBlue
- `1007` = SunRoof
- `1008` = XenonHeadlamps
",
"enum": [
1001,
1002,
1003,
1004,
1005,
1006,
1007,
1008
],
"type": "integer"
}
},
"example": {
"FilterValue": false,
"KindOfFilter": 0
}
},
"CooGroupQualCol": {
"description": "Class CooGroupQualCol represents a qualifier collection.\r\nThe qualifier collection delivers a further differentiation for an item.",
"type": "object",
"properties": {
"CooId": {
"format": "int32",
"description": "Gets or sets the id of the cost of ownership group.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"CooId": 0,
"QualColId": 0,
"QualColText": "string"
}
},
"ServiceProposalCooGroupsIncludingQualifiersMsg": {
"description": " Class {ServiceProposalCooGroupsIncludingQualifiersMsg} contains the properties which are necessary to call web service method\r\nServiceProposalCooGroupsIncludingQualifiers(ServiceProposalCooGroupsIncludingQualifiersMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"InitialRegistrationDate": {
"format": "date-time",
"description": "Gets or sets the initial registration date.",
"type": "string"
},
"KindOfGearBox": {
"format": "int32",
"description": "Gets or sets the kind of gear box. Possible enumeration values: - `65` = AutomaticGearBox
- `77` = ManualGearBox
- `81` = AutomatedGearBox
",
"enum": [
65,
77,
81
],
"type": "integer"
},
"EuropeanExhaustEmissionStandard": {
"format": "int32",
"description": "Gets or sets the european exhaust emission standard.",
"type": "integer"
},
"EquipmentFilter": {
"description": "Gets or sets the equipment filter.",
"type": "array",
"items": {
"$ref": "#/definitions/CooGroupDefaultFilter"
}
},
"Vin": {
"description": "Gets or sets the vin.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"KindOfGearBox": 65,
"EuropeanExhaustEmissionStandard": 0,
"EquipmentFilter": [
{
"FilterValue": false,
"KindOfFilter": 0
}
],
"Vin": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"CooGroupQualColWithQualifiers": {
"description": "Class CooGroupQualColWithQualifiers represents a qualifier collection including a list where the qualifier collection is split into its parts.\r\nThe qualifier collection delivers a further differentiation for an item.",
"type": "object",
"properties": {
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where the qualifier collection identifier is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"CooId": {
"format": "int32",
"description": "Gets or sets the id of the cost of ownership group.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"CooId": 0,
"QualColId": 0,
"QualColText": "string"
}
},
"ServiceProposalMsg": {
"description": "Maintenance service proposal message (kilometres).",
"required": [
"CountryCode",
"LanguageCode",
"CooGroupId",
"MdBodyQualColId",
"CurrentMileage",
"InitalRegistrationDate",
"TypeId"
],
"type": "object",
"properties": {
"KindOfVehicleTreeId": {
"format": "int32",
"description": "Gets the identifier of the kind of vehicle tree. Possible enumeration values: - `0` = ClassId
- `1` = MakeId
- `2` = RangeId
- `3` = TypeId
",
"enum": [
0,
1,
2,
3
],
"type": "integer",
"readOnly": true
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Gets or sets the unique identifier for end user which receive the called data.",
"type": "string"
},
"CooGroupId": {
"format": "int32",
"description": "Gets or sets the identifier of the coo group.",
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the md body qual col.",
"type": "integer"
},
"CurrentMileage": {
"format": "int32",
"description": "Gets or sets the current mileage (in kilometres).",
"type": "integer"
},
"InitalRegistrationDate": {
"format": "date-time",
"description": "Gets or sets the initial registration date.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"KindOfVehicleTreeId": 3,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string",
"CooGroupId": 0,
"MdBodyQualColId": 0,
"CurrentMileage": 0,
"InitalRegistrationDate": "0001-01-01T00:00:00",
"TypeId": 0
}
},
"MdServiceProposal": {
"description": "Maintenance Service Proposal (Kilometres).",
"type": "object",
"properties": {
"LastKm": {
"format": "int32",
"description": "Gets or sets the last kilometres.",
"type": "integer"
},
"LastMonth": {
"format": "int32",
"description": "Gets or sets the last month.",
"type": "integer"
},
"LastServiceBeforKmMonth": {
"description": "Gets or sets the last service befor kilometres month.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServiceProposalWorkPos"
}
},
"NextServiceAfterKmMonth": {
"description": "Gets or sets the next service after kilometres month.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServiceProposalWorkPos"
}
},
"NextKm": {
"format": "int32",
"description": "Gets or sets the next kilometres.",
"type": "integer"
},
"NextMonth": {
"format": "int32",
"description": "Gets or sets the next month.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"LastKm": 0,
"LastMonth": 0,
"LastServiceBeforKmMonth": [
{
"IsLocked": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkId": 0,
"ItemMpText": "string",
"KorText": "string",
"QualColText": "string"
}
],
"NextServiceAfterKmMonth": [
{
"IsLocked": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkId": 0,
"ItemMpText": "string",
"KorText": "string",
"QualColText": "string"
}
],
"NextKm": 0,
"NextMonth": 0,
"QualColId": 0,
"QualColText": "string"
}
},
"MdServiceProposalWorkPos": {
"description": "A md service proposal work position.",
"type": "object",
"properties": {
"IsLocked": {
"description": "Gets or sets a value indicating whether this object is locked.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the identifier of the item mp.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the identifier of the kor.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the qual col.",
"type": "integer"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the identifier of the work.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the item mp text.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the kor text.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the qual col text.",
"type": "string"
}
},
"example": {
"IsLocked": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkId": 0,
"ItemMpText": "string",
"KorText": "string",
"QualColText": "string"
}
},
"ServiceProposalMilesMsg": {
"description": "Maintenance service proposal message (miles).",
"required": [
"CountryCode",
"LanguageCode",
"CooGroupId",
"MdBodyQualColId",
"CurrentMileage",
"InitalRegistrationDate",
"TypeId"
],
"type": "object",
"properties": {
"KindOfVehicleTreeId": {
"format": "int32",
"description": "Gets the identifier of the kind of vehicle tree. Possible enumeration values: - `0` = ClassId
- `1` = MakeId
- `2` = RangeId
- `3` = TypeId
",
"enum": [
0,
1,
2,
3
],
"type": "integer",
"readOnly": true
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Gets or sets the unique identifier for end user which receive the called data.",
"type": "string"
},
"CooGroupId": {
"format": "int32",
"description": "Gets or sets the identifier of the coo group.",
"type": "integer"
},
"MdBodyQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the md body qual col.",
"type": "integer"
},
"CurrentMileage": {
"format": "int32",
"description": "Gets or sets the current mileage (in miles).",
"type": "integer"
},
"InitalRegistrationDate": {
"format": "date-time",
"description": "Gets or sets the initial registration date.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"KindOfVehicleTreeId": 3,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string",
"CooGroupId": 0,
"MdBodyQualColId": 0,
"CurrentMileage": 0,
"InitalRegistrationDate": "0001-01-01T00:00:00",
"TypeId": 0
}
},
"MdServiceProposalMiles": {
"description": "Maintenance Service Proposal (Miles).",
"type": "object",
"properties": {
"LastMiles": {
"format": "int32",
"description": "Gets or sets the last miles.",
"type": "integer"
},
"LastMonth": {
"format": "int32",
"description": "Gets or sets the last month.",
"type": "integer"
},
"LastServiceBeforeMilesMonth": {
"description": "Gets or sets the last service before miles/month.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServiceProposalWorkPos"
}
},
"NextServiceAfterMilesMonth": {
"description": "Gets or sets the next service after miles/month.",
"type": "array",
"items": {
"$ref": "#/definitions/MdServiceProposalWorkPos"
}
},
"NextMiles": {
"format": "int32",
"description": "Gets or sets the next miles.",
"type": "integer"
},
"NextMonth": {
"format": "int32",
"description": "Gets or sets the next month.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"LastMiles": 0,
"LastMonth": 0,
"LastServiceBeforeMilesMonth": [
{
"IsLocked": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkId": 0,
"ItemMpText": "string",
"KorText": "string",
"QualColText": "string"
}
],
"NextServiceAfterMilesMonth": [
{
"IsLocked": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0,
"WorkId": 0,
"ItemMpText": "string",
"KorText": "string",
"QualColText": "string"
}
],
"NextMiles": 0,
"NextMonth": 0,
"QualColId": 0,
"QualColText": "string"
}
},
"VehicleHasManualsMsg": {
"description": "Class {VehicleHasManualsMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"TmManualListMsg": {
"description": "Class {TmManualListMsg} contains the properties which are necessary to call web service methods\r\nManualList(TmManualListMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"TmMainGroup": {
"description": "Represents a main group for technical manuals. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/TmSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"TmSubGroup": {
"description": "Represents a sub group for technical manuals. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/TmItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"TmLinkedTechnicalManualsMsg": {
"description": "Class {TmLinkedTechnicalManualsMsg} contains the properties which are necessary to call web service methods\r\nLinkedTechnicalManuals(TmLinkedTechnicalManualsMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"LinkedTechnicalManualsForWorkMsg": {
"description": "Class {LinkedTechnicalManualsForWorkMsg} contains the properties which are necessary to call web service method\r\nLinkedTechnicalManualsForWork(LinkedTechnicalManualsForWorkMsg).",
"required": [
"LanguageCode",
"CountryCode",
"WorkId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the TecRMI work id which identifies a work position unique.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"WorkId": 0
}
},
"TmManualHtmlMsg": {
"description": "Class {TmManualHtmlMsg} contains the properties which are necessary to call web service methods\r\nManualHtml(TmManualHtmlMsg).",
"required": [
"PrintView",
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId",
"ManualId"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ShowOeNoAsLink": {
"description": "Gets or sets a value indicating whether the part numbers of the original equipment manufacturer should be displayed as a link or not.\r\nFor this property to take effect the property PrintView has to be set to False.",
"type": "boolean"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"KindOfWorkTime": 0,
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ManualId": 0,
"ShowOeNoAsLink": false,
"ConsumerId": "string"
}
},
"ErrorCodeSearchHtmlMsg": {
"description": "Class {ErrorCodeSearchHtmlMsg} contains the properties which are necessary to call web service method\r\nErrorCodeSearchHtml(ErrorCodeSearchHtmlMsg).",
"required": [
"ErrorCode",
"CountryCode",
"LanguageCode",
"TypeId",
"LinkUrl"
],
"type": "object",
"properties": {
"ErrorCode": {
"description": "Gets or sets the error code to search for.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"ErrorCode": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"ConsumerId": "string"
}
},
"ImageNamesForManualsMsg": {
"description": "Class {ImageNamesForManualsMsg} contains the properties which are necessary to call web service methods\r\nImageNamesForManual(ImageNamesForManualsMsg).",
"required": [
"ManualId"
],
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"ManualId": 0
}
},
"ForMakeMsg": {
"description": "Class {ForMakeMsg} contains the properties which are necessary to call the web service method\r\nForMake(ForMakeMsg).",
"required": [
"MakeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"MakeId": {
"format": "int32",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"MakeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"InfoData": {
"description": "Represents info data. In order to retrieve info data the portal database must be available.",
"type": "object",
"properties": {
"Headline": {
"description": "Gets or sets the headline of the info.",
"type": "string"
},
"Text": {
"description": "Gets or sets the text of the info.",
"type": "string"
},
"Classification": {
"format": "int32",
"description": "Gets or sets the classification of the info. Possible enumeration values: - `607` = RecallCampaign
- `608` = ModifiedValues
",
"enum": [
607,
608
],
"type": "integer"
},
"ValidFrom": {
"format": "date-time",
"description": "Gets or sets the date the info data is valid from.",
"type": "string"
},
"ValidTo": {
"format": "date-time",
"description": "Gets or sets the date until the info data is valid.",
"type": "string"
},
"InfoId": {
"format": "int64",
"description": "Gets or sets the id of the info.",
"type": "integer"
}
},
"example": {
"Headline": "string",
"Text": "string",
"Classification": 607,
"ValidFrom": "0001-01-01T00:00:00",
"ValidTo": "0001-01-01T00:00:00",
"InfoId": 0
}
},
"ForRangeMsg": {
"description": "Class {ForRangeMsg} contains the properties which are necessary to call the web service method\r\nForRange(ForRangeMsg).",
"required": [
"RangeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"RangeId": {
"format": "int32",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"RangeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"ForTypeMsg": {
"description": "Class {ForTypeMsg} contains the properties which are necessary to call the web service method\r\nForType(ForTypeMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"AllInfosForTypeMsg": {
"description": "Class {AllInfosForTypeMsg} contains the properties which are necessary to call the web service method\r\nAllInfosForType(AllInfosForTypeMsg).",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"IncludeOutededInfos"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"IncludeOutededInfos": {
"description": "Gets or sets a value indicating whether outdated information should be included in the result.",
"type": "boolean"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string",
"IncludeOutededInfos": false
}
},
"InfoDataExtended": {
"description": "Represents info data. In order to retrieve info data the portal database must be available.",
"type": "object",
"properties": {
"VehicleTreeId": {
"format": "int32",
"description": "Gets or sets the vehicle tree id where the info data is linked to.",
"type": "integer"
},
"KindOfVehicleTreeId": {
"format": "int32",
"description": "Gets or sets the kind of vehicle tree id. Possible enumeration values: - `0` = ClassId
- `1` = MakeId
- `2` = RangeId
- `3` = TypeId
",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"KindOfModule": {
"format": "int32",
"description": "Gets or sets the kind of module where the info data is linked to. Possible enumeration values: - `0` = Default
- `1` = Coo
- `2` = CooNew
- `3` = AD
- `4` = BG
- `5` = LT
- `6` = MD
- `7` = DI
- `8` = SOS
- `9` = TD
- `10` = TM
- `11` = WD
- `12` = CO
- `13` = CooUser
- `14` = Ctrl
- `15` = IN
- `16` = VT
- `17` = Info
- `18` = Portal
- `19` = FR
- `20` = MP
- `21` = CWD
- `22` = Paint
",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22
],
"type": "integer"
},
"TopicTreeId": {
"format": "int32",
"description": "Gets or sets the topic tree id where the info data is linked to .",
"type": "integer"
},
"KindOfTopicTreeId": {
"format": "int32",
"description": "Gets or sets the kind of topic tree id where the info data is linked to. Possible enumeration values: - `1` = MainGroupId
- `2` = SubGroupId
- `3` = ItemMpId
",
"enum": [
1,
2,
3
],
"type": "integer"
},
"Headline": {
"description": "Gets or sets the headline of the info.",
"type": "string"
},
"Text": {
"description": "Gets or sets the text of the info.",
"type": "string"
},
"Classification": {
"format": "int32",
"description": "Gets or sets the classification of the info. Possible enumeration values: - `607` = RecallCampaign
- `608` = ModifiedValues
",
"enum": [
607,
608
],
"type": "integer"
},
"ValidFrom": {
"format": "date-time",
"description": "Gets or sets the date the info data is valid from.",
"type": "string"
},
"ValidTo": {
"format": "date-time",
"description": "Gets or sets the date until the info data is valid.",
"type": "string"
},
"InfoId": {
"format": "int64",
"description": "Gets or sets the id of the info.",
"type": "integer"
}
},
"example": {
"VehicleTreeId": 0,
"KindOfVehicleTreeId": 0,
"KindOfModule": 0,
"TopicTreeId": 0,
"KindOfTopicTreeId": 1,
"Headline": "string",
"Text": "string",
"Classification": 607,
"ValidFrom": "0001-01-01T00:00:00",
"ValidTo": "0001-01-01T00:00:00",
"InfoId": 0
}
},
"ForMainGroupMsg": {
"description": "Class {ForMainGroupMsg} contains the properties which are necessary to call the web service method\r\nForMainGroup(ForMainGroupMsg).",
"required": [
"TypeId",
"MainGroupId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"MainGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"ForSubGroupMsg": {
"description": "Class {ForSubGroupMsg} contains the properties which are necessary to call the web service method\r\nSubGroup(ForSubGroupMsg).",
"required": [
"TypeId",
"SubGroupId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"SubGroupId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"ForItemMpMsg": {
"description": "Class {ForItemMpMsg} contains the properties which are necessary to call the web service method\r\nForItemMp(ForItemMpMsg).",
"required": [
"TypeId",
"ItemMpId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"ItemMpId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"VehicleHasRelaysFusesMsg": {
"description": "Class {VehicleHasRelaysFusesMsg} contains the properties which are necessary to call the web service methods\r\nVehicleHasRelaysFuses(VehicleHasRelaysFusesMsg).",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"FrComponentsForTypeMsg": {
"description": "Class {FrComponentsForTypeMsg} contains the properties which are necessary to call the web service methods\r\nComponentsForType(FrComponentsForTypeMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0
}
},
"FrComponentType": {
"description": "Represents a component type in the fuse and relays module.",
"type": "object",
"properties": {
"TypeOverviewImage": {
"description": "Gets or sets the overview image of the type where the position of the fuse and relays boxes are marked.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the type id of this component.",
"type": "integer"
},
"ComponentTypeName": {
"description": "Gets or sets the name of the component type.",
"type": "string"
}
},
"example": {
"TypeOverviewImage": "string",
"ComponentTypeId": 0,
"ComponentTypeName": "string"
}
},
"BoxDetailListMsg": {
"description": "Class {BoxDetailListMsg} contains the properties which are necessary to call the web service methods\r\nBoxDetailList(BoxDetailListMsg).",
"required": [
"ComponentTypeId",
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"ComponentTypeId": 0,
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"BoxOverviewHtmlMsg": {
"description": "Class {BoxOverviewHtmlMsg} contains the properties which are necessary to call the web service methods\r\nBoxOverviewHtml(BoxOverviewHtmlMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"LinkUrl",
"ComponentTypeId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of\r\nthis url.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the id of the component type.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"ComponentTypeId": 0,
"ConsumerId": "string"
}
},
"BoxDetailHtmlMsg": {
"description": "Class {BoxDetailHtmlMsg} contains the properties which are necessary to call the web service methods\r\nBoxDetailHtml(BoxDetailHtmlMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"LinkUrl",
"ComponentTypeId",
"PrintView",
"BoxConfigurationMappingId",
"BuildPeriodQualColId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of\r\nthis url.",
"type": "string"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the component type id.",
"type": "integer"
},
"PrintView": {
"description": "Gets or sets a value indicating whether the HTML file should be prepared for printing.",
"type": "boolean"
},
"BoxConfigurationMappingId": {
"format": "int32",
"description": "Gets or sets the identifier of the box configuration mapping.",
"type": "integer"
},
"BuildPeriodQualColId": {
"format": "int32",
"description": "Gets or sets the identifier of the build period qualifier collection.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"ComponentTypeId": 0,
"PrintView": false,
"BoxConfigurationMappingId": 0,
"BuildPeriodQualColId": 0,
"ConsumerId": "string"
}
},
"BoxOverviewImageNameMsg": {
"description": "Class {BoxOverviewImageNameMsg} contains the properties which are necessary to call the web service methods\r\nBoxOverviewImageName(BoxOverviewImageNameMsg).",
"required": [
"CountryCode",
"TypeId",
"ComponentTypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the id of the component type.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"TypeId": 0,
"ComponentTypeId": 0
}
},
"FrLinkedTechnicalDataMsg": {
"description": "Class {FrLinkedTechnicalDataMsg} contains the properties which are necessary to call the web service methods\r\nLinkedTechnicalData(FrLinkedTechnicalDataMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the identifier of the item mount position.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"FrLinkedTechnicalManualsMsg": {
"description": "Class {FrLinkedTechnicalManualsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedTechnicalManuals(FrLinkedTechnicalManualsMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the identifier of the item mount position.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"FrLinkedLabourTimesMsg": {
"description": "Class {FrLinkedLabourTimesMsg} contains the properties which are necessary to call the web service methods\r\nLinkedLabourTimes(FrLinkedLabourTimesMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId",
"LtBodyQualColId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"LtBodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id for labour times work positions which defines the vehicle construction. The id can be fetched by using the\r\nequivalent methods from the respective modules.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"ItemMpId": 0,
"LtBodyQualColId": 0
}
},
"FrLinkedWiringDiagramsMsg": {
"description": "Class {FrLinkedWiringDiagramsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedWiringDiagrams(FrLinkedWiringDiagramsMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the identifier of the item mp.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"FrLinkedDiagnosticsMsg": {
"description": "Class {FrLinkedDiagnosticsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedDiagnostics(FrLinkedDiagnosticsMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"DiComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the diagnose component type.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"DiComponentTypeId": 0,
"ItemMpId": 0
}
},
"FrLinkedPartPositionMsg": {
"description": "Class {FrLinkedPartPositionMsg} contains the properties which are necessary to call the web service methods\r\nLinkedPartPosition(FrLinkedPartPositionMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the identifier of the item mount position.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"BoxConfigurationsMsg": {
"description": "Class {BoxConfigurationsMsg} contains the properties which are necessary to call the web service methods\r\nBoxConfigurations(BoxConfigurationsMsg).",
"required": [
"ComponentTypeId",
"TypeId",
"LanguageCode",
"CountryCode"
],
"type": "object",
"properties": {
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the component type.",
"type": "integer"
},
"SearchText": {
"description": "Gets or sets the filter string.\r\nA search will only be performed if this search text is set to a value unequal NULL.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"ComponentTypeId": 0,
"SearchText": "string",
"TypeId": 0,
"LanguageCode": "string",
"CountryCode": "string"
}
},
"FrMainGroup": {
"description": "Represents a main group for fuse and relays. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/FrSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"BoxConfigurations": [
{
"BoxBuildPeriodQualCols": [
{
"QualColId": 0,
"QualColText": "string"
}
],
"BoxConfigurationId": 0,
"BuildPeriodQualColText": "string",
"BuildPeriodQualColId": 0,
"QualColId": 0,
"QualColText": "string"
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"FrSubGroup": {
"description": "Represents a sub group for fuse and relays. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/FrBoxItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"BoxConfigurations": [
{
"BoxBuildPeriodQualCols": [
{
"QualColId": 0,
"QualColText": "string"
}
],
"BoxConfigurationId": 0,
"BuildPeriodQualColText": "string",
"BuildPeriodQualColId": 0,
"QualColId": 0,
"QualColText": "string"
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"LoginCredentials": {
"description": "A login credentials.",
"type": "object",
"properties": {
"Company": {
"description": "Gets or sets the company.",
"type": "string"
},
"Account": {
"description": "Gets or sets the account.",
"type": "string"
},
"Password": {
"description": "Gets or sets the password.",
"type": "string"
}
},
"example": {
"Company": "string",
"Account": "string",
"Password": "string"
}
},
"VehicleHasBulletinsMsg": {
"description": "Class {VehicleHasBulletinsMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"FilterValuesMsg": {
"description": "Class {FilterValuesMsg} contains the properties which are necessary to call web service methods\r\nFilterValues(FilterValuesMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"SosFilterValue": {
"description": "Represents a filter value for Sos. Filtering in the Sos domain allows reducing the size of the Sos topic tree\r\nand to find the result quicker.",
"type": "object",
"properties": {
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"QualColId": 0,
"QualColText": "string"
}
},
"SosManualListMsg": {
"description": "Class {SosManualListMsg} contains the properties which are necessary to call web service method\r\nManualList(SosManualListMsg).",
"required": [
"ShowAllMaingroups",
"ShowAllSubgroups",
"TypeId",
"LanguageCode",
"CountryCode"
],
"type": "object",
"properties": {
"ShowAllMaingroups": {
"description": "Gets or sets a value indicating whether all main groups should be shown in the result.",
"type": "boolean"
},
"ShowAllSubgroups": {
"description": "Gets or sets a value indicating whether all sub groups should be shown in the result.",
"type": "boolean"
},
"QualifierFilter": {
"format": "int32",
"description": "Gets or sets the qualifier id after which the result should be filtered.\r\nPassing null means no filtering.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"ShowAllMaingroups": false,
"ShowAllSubgroups": false,
"QualifierFilter": 0,
"TypeId": 0,
"LanguageCode": "string",
"CountryCode": "string",
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"SosMainGroup": {
"description": "Represents a main group for Sos. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/SosSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"SosSubGroup": {
"description": "Represents a sub group for SOS. In the topic tree hierarchy, sub groups are children of main groups. The same sub group might also be a child of several different main groups making\r\nthe topic tree rather a directed acyclic graph than a tree. Each sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/SosItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"SosItemMp": {
"description": "Represents an item mount position for SOS. In the topic tree hierarchy, item mount positions are children of sub groups. The same item mount position might also be a child\r\nof several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"Manuals": {
"description": "Gets or sets a collection of manuals which belongs to the topic item mount position.",
"type": "array",
"items": {
"$ref": "#/definitions/SosManual"
}
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"SosManual": {
"description": "Represents a manual for Sos. A manual belongs to an item mount position.",
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the id of the manual.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the qualifier collection text.",
"type": "string"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
},
"SosLinkedSosManualsMsg": {
"description": "Class {SosLinkedSosManualsMsg} contains the properties which are necessary to call web service methods\r\nLinkedSosManuals(SosLinkedSosManualsMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"SosManualHtmlMsg": {
"description": "Class {SosManualHtmlMsg} contains the properties which are necessary to call web service methods\r\nManualHtml(SosManualHtmlMsg).",
"required": [
"PrintView",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId",
"ManualId",
"LinkUrl"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ManualId": 0,
"LinkUrl": "string",
"ConsumerId": "string"
}
},
"ImageNamesForSosManualMsg": {
"description": "Class {ImageNamesForSosManualMsg} contains the properties which are necessary to call web service methods\r\nImageNamesForSosManual(ImageNamesForSosManualMsg).",
"required": [
"ManualId"
],
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"ManualId": 0
}
},
"RedirectResult": {
"type": "object",
"properties": {
"Location": {
"type": "string",
"readOnly": true
},
"Request": {
"type": "object",
"readOnly": true
}
}
},
"VehicleHasTimesMsg": {
"description": "Class {VehicleHasTimesMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"LtBodiesForLtMsg": {
"description": "Class {LtBodiesForLtMsg} contains the properties which are necessary to call web service methods\r\nBodiesForTimes(LtBodiesForLtMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"LtBodyQualCol": {
"description": "Represents a body qualifier collection for labour times. In general, the qualifier collection delivers a further differentiation for an item (in this case a vehicle type).\r\nVehicle types may have different bodies (e.g. 3-door, 5-door) which can be referenced by the body qualifier collection.",
"type": "object",
"properties": {
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
}
},
"example": {
"QualColId": 0,
"QualColText": "string"
}
},
"LtWorkListMsg": {
"description": "Class {LtWorkListMsg} contains the properties which are necessary to call web service methods\r\ntWorkList(LtWorkListMsg).",
"required": [
"BodyQualColId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"SearchText": {
"description": "Filters the the labour times work list by the given search text value. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and SearchText is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"SearchText": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"LtPaintMainGroup": {
"description": "Represents a main group for labour times. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/LtPaintSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"IsPaintAllowed": false,
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"LtPaintSubGroup": {
"description": "Represents a sub group for labour times. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/LtPaintItemMpKor"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"IsPaintAllowed": false,
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"LtPaintItemMpKor": {
"description": "Represents an item mount position along with a kind of repair for labour times. In the topic tree hierarchy, item mount positions are children of sub groups.\r\nThe same item mount position might also be a child of several different sub groups making the topic tree rather a directed acyclic graph than a tree.",
"type": "object",
"properties": {
"IsPaintAllowed": {
"description": "Determines if this item mount position along with a kind of repair for labour times can be passed to paint.",
"type": "boolean"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImageName": {
"description": "Gets or sets the image name of the kind of repair.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this topic item mount position. A collection\r\nof topic item mount position will be sorted against this number.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this item mount position is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this item mount position.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMpImageName": {
"description": "Gets or sets the name of the item mount position image.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"IsPaintAllowed": false,
"KorId": 0,
"KorText": "string",
"KorImageName": "string",
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"LtWorkStepsMsg": {
"description": "Class {LtWorkStepsMsg} contains the properties which are necessary to call the web service methods\r\nWorkSteps(LtWorkStepsMsg).",
"required": [
"BodyQualColId",
"KorId",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"KorId": 0,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0,
"ConsumerId": "string"
}
},
"LtWorkPosWithComplexityReference": {
"description": "Represents a work position for labour times part of the AuDaLib which contains all necessary information for selecting a work position for\r\ncalculation including the information about the assigned complexity level.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the enum value representing the complexity of a work position. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/LtExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/LtOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtWorkPosSuggestion": {
"description": "Represents a work position for labour times part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.\r\nContains additionally suggested work positions related to a work position.",
"type": "object",
"properties": {
"SuggestedWorkPositions": {
"description": "Gets or sets the suggested work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/WorkPosData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/LtExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/LtOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"SuggestedWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtWorkPosSuggestionWithComplexityReference": {
"description": "Represents a work position for labour times part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.\r\nContains additionally suggested work positions related to a work position and a complexity reference.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the enum value representing the complexity. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"SuggestedWorkPositions": {
"description": "Gets or sets the suggested work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/WorkPosData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/LtExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/LtOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"SuggestedWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtWorkStepsIncludingQualifiersMsg": {
"description": "Class {LtWorkStepsIncludingQualifiersMsg} contains the properties which are necessary to call the web service methods\r\nWorkStepsIncludingQualifiers(LtWorkStepsIncludingQualifiersMsg).",
"required": [
"BodyQualColId",
"KorId",
"KindOfWorkTime",
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"BodyQualColId": 0,
"KorId": 0,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0,
"ConsumerId": "string"
}
},
"LtWorkPosWithQualifiers": {
"description": "Represents a work position for labour times part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.\r\nIncluding a list where the Qualifier Collection identifier is split into its parts.",
"type": "object",
"properties": {
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where the qualifier collection identifier is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/LtExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/LtOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtWorkPosWithQualifiersComplexityReference": {
"description": "Represents a work position for labour times part of the AuDaLib\r\nwhich contains all necessary information for selecting a work position for calculation.\r\nIncluding a list where the Qualifier Collection identifier is split into its components and a reference to the complexity of this work.",
"type": "object",
"properties": {
"Complexity": {
"format": "int32",
"description": "Gets or sets the enum value representing the complexity of a work position. Possible enumeration values: - `1` = T1
- `2` = T2
- `3` = T3
- `4` = T4
",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"Qualifiers": {
"description": "Gets or sets the collection qualifiers where the qualifier collection identifier is build up.",
"type": "array",
"items": {
"$ref": "#/definitions/QualifierData"
}
},
"WorkPosNo": {
"description": "Gets or sets the number of the work position.",
"type": "string"
},
"ExclusiveWorkPositions": {
"description": "Gets or sets a collection of exclusive work positions.",
"type": "array",
"items": {
"$ref": "#/definitions/LtExclWorkPos"
}
},
"OptionalExclusivePositions": {
"description": "Gets or sets a collection of optional exclusive work positions. These are optional additional labour times work positions\r\nwhich can only be selected in combination with its main labour times work position.",
"type": "array",
"items": {
"$ref": "#/definitions/LtOptExclWorkPos"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this generic work position is denied.",
"type": "boolean"
},
"WorkId": {
"format": "int32",
"description": "Gets or sets the id of the work position.",
"type": "integer"
},
"WorkText": {
"description": "Gets or sets the text of the work position.",
"type": "string"
},
"QualColText": {
"description": "Gets or sets the text of the qualifier collection.",
"type": "string"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"KorImage": {
"description": "Gets or sets the image of the kind of repair.",
"type": "string"
},
"WorkTime": {
"format": "double",
"description": "Gets or sets the work time.",
"type": "number"
},
"KindOfWorkTimeData": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"IsOnlyForReference": {
"description": "Gets or sets a value indicating whether the work time of this instance is only for reference.",
"type": "boolean"
},
"IsTecRmiTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is defined by TecRMI.",
"type": "boolean"
},
"IsCompositeTime": {
"description": "Gets or sets a value indicating whether the work time of this instance is a net work time.",
"type": "boolean"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"QualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection.",
"type": "integer"
}
},
"example": {
"Complexity": 1,
"Qualifiers": [
{
"QualifierId": 0,
"QualifierText": "string",
"QualifierGroupId": 0,
"QualifierGroupName": "string"
}
],
"WorkPosNo": "string",
"ExclusiveWorkPositions": [
{
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"OptionalExclusivePositions": [
{
"WorkPositionNo": "string",
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
],
"IsLocked": false,
"WorkId": 0,
"WorkText": "string",
"QualColText": "string",
"ItemMpText": "string",
"KorText": "string",
"KorImage": "string",
"WorkTime": 0.0,
"KindOfWorkTimeData": 0,
"IsOnlyForReference": false,
"IsTecRmiTime": false,
"IsCompositeTime": false,
"ItemMpId": 0,
"KorId": 0,
"QualColId": 0
}
},
"LtWorkStepsForSubgroupMsg": {
"description": "Class {LtWorkStepsForSubgroupMsg} contains the properties which are necessary to call the web service methods\r\nWorkStepsForSubgroup(LtWorkStepsForSubgroupMsg).",
"required": [
"BodyQualCodId",
"CountryCode",
"LanguageCode",
"TypeId",
"KindOfWorkTime",
"SubGroupId"
],
"type": "object",
"properties": {
"BodyQualCodId": {
"format": "int32",
"description": "Gets or sets the body qualifier id which defines the vehicle construction.\r\nThe id can be fetched by using the equivalent methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic sub group id. The id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"BodyQualCodId": 0,
"ConsumerId": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"KindOfWorkTime": 0,
"SubGroupId": 0
}
},
"RawToolsMsg": {
"description": "Class {RawToolsMsg} contains the properties which are necessary to call the web service methods\r\nRawTools(RawToolsMsg).",
"required": [
"KorId",
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the TecRMI kind of repair id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"KorId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string",
"ItemMpId": 0
}
},
"LtItemMpKorRawTools": {
"description": "Data model for a raw tool",
"type": "object",
"properties": {
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"RawTools": {
"description": "Gets or sets a collection of LtTmRawTools which contains the available raw tools with various qualifiers for a manual.",
"type": "array",
"items": {
"$ref": "#/definitions/LtTmRawTools"
}
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"KorId": 0,
"KorText": "string",
"RawTools": [
{
"TmQualColId": 0,
"TmQualColText": "string",
"RawTools": [
{
"RawToolId": 0,
"RawToolName": "string",
"RawToolNumber": "string",
"ImageName": "string"
}
],
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"LtTmRawTools": {
"description": "Contains raw tools of a specific manual",
"type": "object",
"properties": {
"TmQualColId": {
"format": "int32",
"description": "Gets or sets the id of the qualifier collection from the technical manual part.",
"type": "integer"
},
"TmQualColText": {
"description": "Gets or sets the text of the qualifier collection from the technical manual part.",
"type": "string"
},
"RawTools": {
"description": "Gets or sets a collection containing all available raw tools in the current manual context.",
"type": "array",
"items": {
"$ref": "#/definitions/LtTmRawTool"
}
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"TmQualColId": 0,
"TmQualColText": "string",
"RawTools": [
{
"RawToolId": 0,
"RawToolName": "string",
"RawToolNumber": "string",
"ImageName": "string"
}
],
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"LtTmRawTool": {
"description": "Class LtTmRawTool contains detailed informations of a raw tool.",
"type": "object",
"properties": {
"RawToolId": {
"format": "int32",
"description": "Gets or sets the id of the raw tool.",
"type": "integer"
},
"RawToolName": {
"description": "Gets or sets the name of the raw tool.",
"type": "string"
},
"RawToolNumber": {
"description": "Gets or sets the number of the raw tool.",
"type": "string"
},
"ImageName": {
"description": "Gets or sets the name of the image.",
"type": "string"
}
},
"example": {
"RawToolId": 0,
"RawToolName": "string",
"RawToolNumber": "string",
"ImageName": "string"
}
},
"RawToolsForWorkIdsMsg": {
"description": "Class {RawToolsForWorkIdsMsg} contains the properties which are necessary to call the web service methods\r\nRawToolsForWorks(RawToolsForWorksMsg).",
"required": [
"CountryCode",
"LanguageCode",
"WorkIds"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
},
"WorkIds": {
"description": "Gets or sets a collection with the ids of the selected work positions. This ids can be fetched by using the\r\nweb service methods ServiceMd.GetMdWorkSteps(...) and\r\nServiceLt.GetLtWorkSteps(...)",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string",
"WorkIds": [
0
]
}
},
"LtItemMpKorRawToolsForWorks": {
"description": "Data model for a raw tool",
"type": "object",
"properties": {
"WorkId": {
"format": "int32",
"description": "Gets or sets the identifier of the work.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the vehicle tree methods of this library.",
"type": "integer"
},
"BodyQualColId": {
"format": "int32",
"description": "Gets or sets the body qualifier collection Id.",
"type": "integer"
},
"KorId": {
"format": "int32",
"description": "Gets or sets the id of the kind of repair.",
"type": "integer"
},
"KorText": {
"description": "Gets or sets the text of the kind of repair.",
"type": "string"
},
"RawTools": {
"description": "Gets or sets a collection of LtTmRawTools which contains the available raw tools with various qualifiers for a manual.",
"type": "array",
"items": {
"$ref": "#/definitions/LtTmRawTools"
}
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the id of the item mount position.",
"type": "integer"
},
"ItemMpText": {
"description": "Gets or sets the text of the item mount position.",
"type": "string"
}
},
"example": {
"WorkId": 0,
"TypeId": 0,
"BodyQualColId": 0,
"KorId": 0,
"KorText": "string",
"RawTools": [
{
"TmQualColId": 0,
"TmQualColText": "string",
"RawTools": [
{
"RawToolId": 0,
"RawToolName": "string",
"RawToolNumber": "string",
"ImageName": "string"
}
],
"ItemMpId": 0,
"ItemMpText": "string"
}
],
"ItemMpId": 0,
"ItemMpText": "string"
}
},
"VehicleHasTyresMsg": {
"description": "Class {VehicleHasTyresMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"CountryCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"TypeId": 0
}
},
"AllTyresForTypeMsg": {
"description": "Class {AllTyresForTypeMsg} contains the properties which are necessary to call web service methods\r\nAllTyresForType(AllTyresForTypeMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"TdTyre": {
"description": "Represents a tyre for the tyre data part of the AuDaLib.",
"type": "object",
"properties": {
"FrontRimSize": {
"description": "Gets or sets the size of the front rim.",
"type": "string"
},
"FrontTyreSize": {
"description": "Gets or sets the size of the front tyre.",
"type": "string"
},
"RearRimSize": {
"description": "Gets or sets the size of the rear rim.",
"type": "string"
},
"RearTyreSize": {
"description": "Gets or sets the size of the rear tyre.",
"type": "string"
},
"ApplicationText": {
"description": "Gets or sets the application text.",
"type": "string"
},
"InfoText": {
"description": "Gets or sets the info text.",
"type": "string"
},
"HsnTsnVsnSelectionRequired": {
"description": "Gets or sets a value indicating whether the user has to select a HSN/TSN/VSN combination.",
"type": "boolean"
}
},
"example": {
"FrontRimSize": "string",
"FrontTyreSize": "string",
"RearRimSize": "string",
"RearTyreSize": "string",
"ApplicationText": "string",
"InfoText": "string",
"HsnTsnVsnSelectionRequired": false
}
},
"TyreTypesMsg": {
"description": "Class {TyreTypesMsg} contains the properties which are necessary to call web service methods\r\nTyreTypes(TyreTypesMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"TdTyreType": {
"description": "Represents a tyre type for TD.",
"type": "object",
"properties": {
"TypeTypeId": {
"format": "int32",
"description": "Gets or sets the tyre type id.",
"type": "integer"
},
"Abe": {
"description": "Gets or sets the general operating permit (german: Allgemeine Betriebserlaubnis).",
"type": "string"
},
"HsnTsn": {
"description": "Gets or sets the HSN (manufacturer key number [german: Herstellerschlüsselnummer]) / TSN (type key number [german: Typschlüsselnummer]).",
"type": "string"
},
"Vsn": {
"description": "Gets or sets the VSN (version key number [german: Variantenschlüsselnummer]).",
"type": "string"
}
},
"example": {
"TypeTypeId": 0,
"Abe": "string",
"HsnTsn": "string",
"Vsn": "string"
}
},
"TyresMsg": {
"description": "Class {TyresMsg} contains the properties which are necessary to call web service methods\r\nTyres(TyresMsg).",
"required": [
"TyreTypeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"TyreTypeId": {
"format": "int32",
"description": "Gets or sets the id of the tyre whose data should be called. This id can be fetched by calling the\r\nweb service method TyreTypes(TyreTypesMsg)",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TyreTypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"ConsumerId": "string"
}
},
"AllTyresForTypeHtmlMsg": {
"description": "Class {AllTyresForTypeHtmlMsg} contains the properties which are necessary to call web service methods\r\nAllTyresForTypeHtml(AllTyresForTypeHtmlMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"TyreTypesHtmlMsg": {
"description": "Class {TyreTypesHtmlMsg} contains the properties which are necessary to call web service methods\r\nTyreTypesHtml(TyreTypesHtmlMsg)",
"required": [
"TyreTypeId",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"TyreTypeId": {
"format": "int32",
"description": "Gets or sets the id of the tyre whose data should be called. This id can be fetched by calling the\r\nweb service method TyreTypes(GetTdTyreTypesMsg).",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TyreTypeId": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"AvailableModulesMsg": {
"description": "Class {AvailableModulesMsg} contains the properties which are necessary to call web service methods\r\nAvailableModules(AvailableModulesMsg).",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"VtTypeModul": {
"description": "Class VtTypeModul represents the availability of module data for a given type.",
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the id of the type.",
"type": "integer"
},
"AdAvailable": {
"description": "Gets or sets a value indicating whether data for adjustment data (Ad) is available.",
"type": "boolean"
},
"CooAvailable": {
"description": "Gets or sets a value indicating whether data for cost of ownership (Coo) is available.",
"type": "boolean"
},
"DiAvailable": {
"description": "Gets or sets a value indicating whether data for diagnose (Di) is available.",
"type": "boolean"
},
"LtAvailable": {
"description": "Gets or sets a value indicating whether data for labour times (Lt) is available.",
"type": "boolean"
},
"MdAvailable": {
"description": "Gets or sets a value indicating whether data for maintenance data (Md) is available.",
"type": "boolean"
},
"SosAvailable": {
"description": "Gets or sets a value indicating whether data for Sos is available.",
"type": "boolean"
},
"TmAvailable": {
"description": "Gets or sets a value indicating whether data for technical manuals (Tm) is available.",
"type": "boolean"
},
"TdAvailable": {
"description": "Gets or sets a value indicating whether data for tyre data (Td) is available.",
"type": "boolean"
},
"WdAvailable": {
"description": "Gets or sets a value indicating whether data for wiring data (Wd) is available.",
"type": "boolean"
},
"BgAvailable": {
"description": "Gets or sets a value indicating whether data for body graphics (Bg) is available.",
"type": "boolean"
},
"MpAvailable": {
"description": "Gets or sets a value indicating whether data for mount position (Mp) is available.",
"type": "boolean"
},
"FrAvailable": {
"description": "Gets or sets a value indicating whether data for fuse and relays (Fr) is available.",
"type": "boolean"
},
"CWDAvailable": {
"description": "Gets or sets a value indicating whether data for comfort wiring diagrams (CWD) is available.",
"type": "boolean"
},
"PaintAvailable": {
"description": "Gets or sets a value indicating whether data for paint (Paint) is available.",
"type": "boolean"
}
},
"example": {
"TypeId": 0,
"AdAvailable": false,
"CooAvailable": false,
"DiAvailable": false,
"LtAvailable": false,
"MdAvailable": false,
"SosAvailable": false,
"TmAvailable": false,
"TdAvailable": false,
"WdAvailable": false,
"BgAvailable": false,
"MpAvailable": false,
"FrAvailable": false,
"CWDAvailable": false,
"PaintAvailable": false
}
},
"TypeDetailByNatVehicleNoMsg": {
"description": "Class {TypeDetailByNatVehicleNoMsg} contains the properties which are necessary to call the web service methods\r\nTypeDetailByNatVehicleNo(GetVtTypeDetailByNatVehicleNoMsg).",
"required": [
"NatVehicleNo",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"NatVehicleNo": {
"description": "Gets or sets the national vehicle identifier like swiss type no or the identifier\r\nform the german federal motor transport authority (KBANr) to search for.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"NatVehicleNo": "string",
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtTypeDetail": {
"description": "Represents a type detail for the vehicle tree. All levels of the vehicle tree are present.\r\nFurthermore, a list of additional type details is available.",
"type": "object",
"properties": {
"MakeName": {
"description": "Gets or sets the name of the manufacturer.",
"type": "string"
},
"TcdMakeId": {
"format": "int32",
"description": "Gets or sets the TecDoc make id.",
"type": "integer"
},
"RangeName": {
"description": "Gets or sets the name of the range.",
"type": "string"
},
"TcdRangeId": {
"format": "int32",
"description": "Gets or sets the TecDoc range id.",
"type": "integer"
},
"TypeName": {
"description": "Gets or sets the name of the type.",
"type": "string"
},
"TcdTypeId": {
"format": "int32",
"description": "Gets or sets the TecDoc type id.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this type is denied.",
"type": "boolean"
},
"TypeDetails": {
"description": "Gets or sets a collection of additional type details for this vehicle.",
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeAdditionalDetail"
}
},
"ShowAsCar": {
"description": "Gets or sets a value indicating whether this type is a car.",
"type": "boolean"
},
"ShowAsTruck": {
"description": "Gets or sets a value indicating whether this type is a truck.",
"type": "boolean"
},
"ShowAsBike": {
"description": "Gets or sets a value indicating whether this type is a bike.",
"type": "boolean"
},
"MakeId": {
"format": "int32",
"description": "Gets or sets the id of the manufacturer.",
"type": "integer"
},
"RangeId": {
"format": "int32",
"description": "Gets or sets the id of the range.",
"type": "integer"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of the class.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the id of the type.",
"type": "integer"
}
},
"example": {
"MakeName": "string",
"TcdMakeId": 0,
"RangeName": "string",
"TcdRangeId": 0,
"TypeName": "string",
"TcdTypeId": 0,
"IsLocked": false,
"TypeDetails": [
{
"KindOfAdditionalDetail": 0,
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
],
"ShowAsCar": false,
"ShowAsTruck": false,
"ShowAsBike": false,
"MakeId": 0,
"RangeId": 0,
"ClassId": 0,
"TypeId": 0
}
},
"VtTypeAdditionalDetail": {
"description": "Class VtTypeAdditionalDetail represents an additional detail for a vehicle type.",
"type": "object",
"properties": {
"KindOfAdditionalDetail": {
"format": "int32",
"description": "Gets or sets the kind of additional detail. Possible enumeration values: - `1` = AddInfoKey
- `2` = Component
- `3` = AdValue
",
"enum": [
1,
2,
3
],
"type": "integer"
},
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the additional information key id.\r\nThe id is negative if the additional information key represents a component.",
"type": "integer"
},
"AddInfoKeyName": {
"description": "Gets or sets the name of the additional information key.",
"type": "string"
},
"AddInfoKeyValue": {
"description": "Gets or sets the value for this additional information key.",
"type": "string"
}
},
"example": {
"KindOfAdditionalDetail": 0,
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
},
"MakeIdForRangeIdMsg": {
"description": "Class {MakeIdForRangeIdMsg} contains the properties which are necessary to call web service methods\r\nMakeIdForRangeId(MakeIdForRangeIdMsg).",
"required": [
"RangeId"
],
"type": "object",
"properties": {
"RangeId": {
"format": "int32",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"RangeId": 0
}
},
"MakeIdForTypeIdMsg": {
"description": "Class {MakeIdForTypeIdMsg} contains the properties which are necessary to call web service methods\r\nMakeIdForTypeId(MakeIdForTypeIdMsg).",
"required": [
"TypeId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"TypeId": 0
}
},
"RangeIdForTypeIdMsg": {
"description": "Class {RangeIdForTypeIdMsg} contains the properties which are necessary to call web service methods\r\nRangeIdForTypeId(RangeIdForTypeIdMsg).",
"required": [
"TypeId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"TypeId": 0
}
},
"VtAddInfoKeysMsg": {
"description": "Class {VtAddInfoKeysMsg} contains the properties which are necessary to call web service method\r\nAddInfoKeys(GetVtAddInfoKeysMsg).",
"required": [
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ClassId": {
"format": "int32",
"description": "Gets or sets the class id.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ClassId": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtAddInfoKeyIdValuesMsg": {
"description": "Class {VtAddInfoKeyIdValuesMsg} contains the properties which are necessary to call the web service methods\r\nAddInfoKeyIdValues(GetVtAddInfoKeyIdValuesMsg)\">GetVtAddInfoKeyIdValues(...).",
"required": [
"AddInfoKeyId",
"LanguageCode"
],
"type": "object",
"properties": {
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the id of the additional information key whose values should be returned from the method\r\nAddInfoKeyIdValues(GetVtAddInfoKeyIdValuesMsg).\r\nThe possible id can be fetched by a calling the web service method\r\nAddInfoKeys(GetVtAddInfoKeysMsg).",
"type": "integer"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"AddInfoKeyId": 0,
"LanguageCode": "string"
}
},
"SecondaryCriteriaAddInfoKeysMsg": {
"description": "Class {SecondaryCriteriaAddInfoKeysMsg} contains the properties which are necessary to call web service method\r\nSecondaryCriteriaAddInfoKeys(GetVtSecondaryCriteriaAddInfoKeysMsg).",
"required": [
"MakeId",
"ClassId",
"Vin",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"MakeId": {
"format": "int32",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the TecDoc class id.",
"type": "integer"
},
"Vin": {
"description": "The vehicle identification number",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"MakeId": 0,
"ClassId": 0,
"Vin": "string",
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtAddInfoSecondaryCriteria": {
"description": "Specifies the secondary filter criteria for track VIN filter",
"type": "object",
"properties": {
"MakeId": {
"format": "int32",
"description": "Gets or sets the id of the manufacturer.",
"type": "integer"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of the class.",
"type": "integer"
},
"AddInfoKeyId": {
"format": "int32",
"description": "Gets or sets the id of the additional information key.",
"type": "integer"
},
"AddInfoKeys": {
"description": "Gets or sets a collection of the additional information keys.",
"type": "array",
"items": {
"type": "string"
}
},
"AddInfoName": {
"description": "Gets or sets the name of the additional information.",
"type": "string"
}
},
"example": {
"MakeId": 0,
"ClassId": 0,
"AddInfoKeyId": 0,
"AddInfoKeys": [
"string"
],
"AddInfoName": "string"
}
},
"AdcMakeIdByTcdMakeIdMsg": {
"description": "Class {AdcMakeIdByTcdMakeIdMsg} contains the properties which are necessary to call web service methods\r\nAdcMakeIdByTcdMakeId(AdcMakeIdByTcdMakeIdMsg).",
"required": [
"TcdMakeId"
],
"type": "object",
"properties": {
"TcdMakeId": {
"format": "int32",
"description": "Gets or sets the make id from TecDoc.",
"type": "integer"
}
},
"example": {
"TcdMakeId": 0
}
},
"AdcRangeIdByTcdRangeIdMsg": {
"description": "Class {AdcRangeIdByTcdRangeIdMsg} contains the properties which are necessary to call web service methods\r\nAdcRangeIdByTcdRangeId(AdcRangeIdByTcdRangeIdMsg).",
"required": [
"TcdRangeId"
],
"type": "object",
"properties": {
"TcdRangeId": {
"format": "int32",
"description": "Gets or sets the range id from TecDoc.",
"type": "integer"
}
},
"example": {
"TcdRangeId": 0
}
},
"AdcTypeIdByTcdTypeAndClassMsg": {
"description": "Class {AdcTypeIdByTcdTypeAndClassMsg} contains the properties which are necessary to call web service methods\r\nAdcTypeIdByTcdTypeAndClass(AdcTypeIdByTcdTypeAndClassMsg).",
"required": [
"TcdTypeId",
"ClassId"
],
"type": "object",
"properties": {
"TcdTypeId": {
"format": "int32",
"description": "Gets or sets the TecDoc type id.",
"type": "integer"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the ClassID mentioned in the documentation.",
"type": "integer"
}
},
"example": {
"TcdTypeId": 0,
"ClassId": 0
}
},
"TcdMakeIdByAdcMakeIdMsg": {
"description": "Class {TcdMakeIdByAdcMakeIdMsg} contains the properties which are necessary to call web service methods\r\nTcdMakeIdByAdcMakeId(TcdMakeIdByAdcMakeIdMsg.",
"required": [
"MakeId"
],
"type": "object",
"properties": {
"MakeId": {
"format": "int32",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"MakeId": 0
}
},
"TcdRangeIdByAdcRangeIdMsg": {
"description": "Class {TcdRangeIdByAdcRangeIdMsg} contains the properties which are necessary to call web service methods\r\nTcdRangeIdByAdcRangeId(TcdRangeIdByAdcRangeIdMsg).",
"required": [
"RangeId"
],
"type": "object",
"properties": {
"RangeId": {
"format": "int32",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"RangeId": 0
}
},
"TcdTypeAndClassByAdcTypeIdMsg": {
"description": "Class {TcdTypeAndClassByAdcTypeIdMsg} contains the properties which are necessary to call web service methods\r\nTcdTypeAndClassByAdcTypeId(TcdTypeAndClassByAdcTypeIdMsg).",
"required": [
"TypeId"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"TypeId": 0
}
},
"VtTcdTypeClass": {
"description": "Represents a TecDoc type and a TecDoc class for the vehicle tree.",
"type": "object",
"properties": {
"TcdTypeId": {
"format": "int32",
"description": "Gets or sets the TecDoc type id.",
"type": "integer"
},
"TcdClassId": {
"format": "int32",
"description": "Gets or sets the ClassID mentioned in the documentation.",
"type": "integer"
}
},
"example": {
"TcdTypeId": 0,
"TcdClassId": 0
}
},
"VtVinFilterIsPossibleMsg": {
"description": "(Serializable)a vt vin filter is possible message.",
"required": [
"Vin",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"Vin": {
"description": "Gets or sets the vin.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"Vin": "string",
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtTcdKritNumberValueByVinFilterMsg": {
"description": "A vt tcd krit number value by vin filter message.",
"required": [
"TypeId",
"CountryCode",
"LanguageCode",
"Vin"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the vehicle tree.",
"type": "integer"
},
"KindOfVehicleTreeId": {
"format": "int32",
"description": "Gets the kind of vehicle tree id. Possible enumeration values: - `0` = ClassId
- `1` = MakeId
- `2` = RangeId
- `3` = TypeId
",
"enum": [
0,
1,
2,
3
],
"type": "integer",
"readOnly": true
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"Vin": {
"description": "The vehicle identification number.",
"type": "string"
},
"secondaryCritera": {
"description": "Gets or sets the secondary vehicle search parameter.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"KindOfVehicleTreeId": 3,
"CountryCode": "string",
"LanguageCode": "string",
"Vin": "string",
"secondaryCritera": "string"
}
},
"TcdKritNumberValue": {
"description": "Class represent a TecDoc criteria number and value.",
"type": "object",
"properties": {
"KritNo": {
"format": "int32",
"description": "Gets or sets the TecDoc criteria number.",
"type": "integer"
},
"KritValue": {
"description": "Gets or sets the TecDoc kriteria value.",
"type": "string"
}
},
"example": {
"KritNo": 0,
"KritValue": "string"
}
},
"JatoIdsByAdcTypeIdMsg": {
"description": "Class {JatoIdsByAdcTypeIdMsg} contains the properties which are necessary to call the web service methods\r\nJatoIdsByAdcTypeId(JatoIdsByAdcTypeIdMsg).",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"ConsumerId": {
"description": "Gets or sets an unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string",
"ConsumerId": "string"
}
},
"JatoIdsByVehicleResponseMsg": {
"type": "object",
"properties": {
"HasVehicles": {
"type": "boolean"
},
"Vehicles": {
"type": "array",
"items": {
"$ref": "#/definitions/JatoVehicles"
}
}
},
"example": {
"HasVehicles": false,
"Vehicles": [
{
"JatoId": 0,
"JatoVersionId": 0,
"JatoVehicleId": 0
}
]
}
},
"JatoVehicles": {
"type": "object",
"properties": {
"JatoId": {
"format": "int64",
"type": "integer"
},
"JatoVersionId": {
"format": "int64",
"type": "integer"
},
"JatoVehicleId": {
"format": "int64",
"type": "integer"
}
},
"example": {
"JatoId": 0,
"JatoVersionId": 0,
"JatoVehicleId": 0
}
},
"VehicleIdsByNationalVehicleNoMsg": {
"description": "Class {VehicleIdsByNationalVehicleNoMsg} contains the properties which are necessary to call web service methods\r\nVehicleIdsByNationalVehicleNo(VehicleIdsByNationalVehicleNoMsg).",
"required": [
"KindOfNationalVehicleNo",
"NationalVehicleNo"
],
"type": "object",
"properties": {
"KindOfNationalVehicleNo": {
"format": "int32",
"description": "Gets the kind of the national vehicle number passed as parameter nationalVehicleNo. Possible enumeration values: - `12` = GermanKBaNr
- `24` = SwissTypeNo
- `124` = SwissNumberPlate
- `224` = SwissRegistrationNo
",
"enum": [
12,
24,
124,
224
],
"type": "integer"
},
"NationalVehicleNo": {
"description": "Gets the national vehicle number to look for.\r\nThe used country depends on this parameter.",
"type": "string"
}
},
"example": {
"KindOfNationalVehicleNo": 0,
"NationalVehicleNo": "string"
}
},
"VtTypeTreeIds": {
"description": "Class VtTypeTreeIds contains all identifiers which are used in the TecRMI vehicle tree.",
"type": "object",
"properties": {
"TcdMakeId": {
"format": "int32",
"description": "Gets or sets the TecDoc manufacturer id.",
"type": "integer"
},
"TcdRangeId": {
"format": "int32",
"description": "Gets or sets the TecDoc range id.",
"type": "integer"
},
"TcdTypeId": {
"format": "int32",
"description": "Gets or sets the TecDoc type id.",
"type": "integer"
},
"ShowAsCar": {
"description": "Gets or sets a value indicating whether this type is a car.",
"type": "boolean"
},
"ShowAsTruck": {
"description": "Gets or sets a value indicating whether this type is a truck.",
"type": "boolean"
},
"ShowAsBike": {
"description": "Gets or sets a value indicating whether this type is a bike.",
"type": "boolean"
},
"MakeId": {
"format": "int32",
"description": "Gets or sets the id of the manufacturer.",
"type": "integer"
},
"RangeId": {
"format": "int32",
"description": "Gets or sets the id of the range.",
"type": "integer"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of the class.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the id of the type.",
"type": "integer"
}
},
"example": {
"TcdMakeId": 0,
"TcdRangeId": 0,
"TcdTypeId": 0,
"ShowAsCar": false,
"ShowAsTruck": false,
"ShowAsBike": false,
"MakeId": 0,
"RangeId": 0,
"ClassId": 0,
"TypeId": 0
}
},
"VehicleIdsByNationalVehicleNoSearchMsg": {
"description": "Class {VehicleIdsByNationalVehicleNoSearchMsg} contains the property which is necessary to call web service methods\r\nVehicleIdsByNationalVehicleNoSearch(VehicleIdsByNationalVehicleNoSearchMsg).",
"required": [
"SearchString"
],
"type": "object",
"properties": {
"SearchString": {
"description": "Gets or sets the the national vehicle number to search for.\r\nBased of the format of this parameter the type of search is determined as well as the country to use.",
"type": "string"
}
},
"example": {
"SearchString": "string"
}
},
"MakeListMsg": {
"description": "Class {MakeListMsg} contains the properties which are necessary to call web service methods MakeList(MakeListMsg).",
"required": [
"ShowCar",
"ShowTruck",
"ShowBike",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ModuleFilter": {
"format": "int32",
"description": "Gets or sets the module filter. Possible enumeration values: - `0` = None
- `1` = Ad
- `2` = Coo
- `3` = CooNew
- `4` = Ctrl
- `5` = Di
- `6` = Lt
- `7` = Md
- `8` = Sos
- `9` = Tm
- `10` = Td
- `11` = Wd
- `12` = Notes
- `13` = Cwd
- `14` = Fr
- `15` = Pp
- `16` = Bg
- `17` = VIN
- `18` = Paint
- `-1` = All
",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
-1
],
"type": "integer"
},
"RangeNameFilter": {
"description": "Gets or sets the filter for the vehicle range names. An empty string means no range filtering.",
"type": "string"
},
"TypeNameFilter": {
"description": "Gets or sets the filter for the vehicle type names. An empty string means no type filtering.",
"type": "string"
},
"AddInfoKeyFilter": {
"description": "Gets or sets the filter after additional information like fuel typ, national vehicle number etc.",
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKeyFilterParameter"
}
},
"ComponentTypeIdFilter": {
"format": "int32",
"description": "Gets or sets the component type id filter. Passing null means no component type id filtering.",
"type": "integer"
},
"ShowCar": {
"description": "Gets or sets a value indicating whether cars are included in the result.",
"type": "boolean"
},
"ShowTruck": {
"description": "Gets or sets a value indicating whether trucks and light commercial vehicles are included in the result.",
"type": "boolean"
},
"ShowBike": {
"description": "Gets or sets a value indicating whether motorbikes are included in the result.",
"type": "boolean"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ModuleFilter": 0,
"RangeNameFilter": "string",
"TypeNameFilter": "string",
"AddInfoKeyFilter": [
{
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
],
"ComponentTypeIdFilter": 0,
"ShowCar": false,
"ShowTruck": false,
"ShowBike": false,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtMake": {
"description": "Class VtMake represents a vehicle manufacturer (make). In the vehicle tree hierarchy, makes are on the topmost level.",
"type": "object",
"properties": {
"MakeId": {
"format": "int32",
"description": "Gets or sets the id of the vehicle manufacturer.",
"type": "integer"
},
"MakeName": {
"description": "Gets or sets the name of the vehicle manufacturer.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this vehicle manufacturer is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this vehicle manufacturer. The portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"MakeId": 0,
"MakeName": "string",
"IsLocked": false,
"InfoDataExists": false
}
},
"VtMakeTcd": {
"description": "Class VtMakeTcd represents a vehicle manufacturer (make). In the vehicle tree hierarchy, makes are on the topmost level.",
"type": "object",
"properties": {
"TcdMakeId": {
"format": "int32",
"description": "Gets or sets the TecDoc id of the vehicle manufacturer.",
"type": "integer"
},
"MakeId": {
"format": "int32",
"description": "Gets or sets the id of the vehicle manufacturer.",
"type": "integer"
},
"MakeName": {
"description": "Gets or sets the name of the vehicle manufacturer.",
"type": "string"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this vehicle manufacturer is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this vehicle manufacturer. The portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"TcdMakeId": 0,
"MakeId": 0,
"MakeName": "string",
"IsLocked": false,
"InfoDataExists": false
}
},
"RangeListMsg": {
"description": "Class {RangeListMsg} contains the properties which are necessary to call web service methods\r\nRangeList(RangeListMsg).",
"required": [
"ShowCar",
"ShowTruck",
"ShowBike",
"MakeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ModuleFilter": {
"format": "int32",
"description": "Gets or sets the module filter. Possible enumeration values: - `0` = None
- `1` = Ad
- `2` = Coo
- `3` = CooNew
- `4` = Ctrl
- `5` = Di
- `6` = Lt
- `7` = Md
- `8` = Sos
- `9` = Tm
- `10` = Td
- `11` = Wd
- `12` = Notes
- `13` = Cwd
- `14` = Fr
- `15` = Pp
- `16` = Bg
- `17` = VIN
- `18` = Paint
- `-1` = All
",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
-1
],
"type": "integer"
},
"RangeNameFilter": {
"description": "Gets or sets the filter for the vehicle range names. An empty string means no range filtering.",
"type": "string"
},
"TypeNameFilter": {
"description": "Gets or sets the filter for the vehicle type names. An empty string means no type filtering.",
"type": "string"
},
"AddInfoKeyFilter": {
"description": "Gets or sets the filter after additional information like manufacturer id, fuel typ, axle configuration etc.",
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKeyFilterParameter"
}
},
"ComponentTypeIdFilter": {
"format": "int32",
"description": "Gets or sets the component type id filter. Passing null means no component type id filtering.",
"type": "integer"
},
"ShowCar": {
"description": "Gets or sets a value indicating whether cars are included in the result.",
"type": "boolean"
},
"ShowTruck": {
"description": "Gets or sets a value indicating whether trucks and light commercial vehicles are included in the result.",
"type": "boolean"
},
"ShowBike": {
"description": "Gets or sets a value indicating whether motorbikes are included in the result.",
"type": "boolean"
},
"MakeId": {
"format": "int32",
"description": "Gets or sets the TecRMI make id which identifies a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ModuleFilter": 0,
"RangeNameFilter": "string",
"TypeNameFilter": "string",
"AddInfoKeyFilter": [
{
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
],
"ComponentTypeIdFilter": 0,
"ShowCar": false,
"ShowTruck": false,
"ShowBike": false,
"MakeId": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtRange": {
"description": "Represents a vehicle range. In the vehicle tree hierarchy, ranges are children of makes. Each range belongs to exactly one make.",
"type": "object",
"properties": {
"RangeId": {
"format": "int32",
"description": "Gets or sets the id of the vehicle model range.",
"type": "integer"
},
"RangeName": {
"description": "Gets or sets the name of the range.",
"type": "string"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of the class.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this vehicle range is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this vehicle range.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"RangeId": 0,
"RangeName": "string",
"ClassId": 0,
"IsLocked": false,
"InfoDataExists": false
}
},
"VtRangeTcd": {
"description": "Represents a vehicle range. In the vehicle tree hierarchy, ranges are children of makes. Each range belongs to exactly one make.",
"type": "object",
"properties": {
"TcdRangeId": {
"format": "int32",
"description": "Gets or sets the TecDoc id of the vehicle model range.",
"type": "integer"
},
"RangeId": {
"format": "int32",
"description": "Gets or sets the id of the vehicle model range.",
"type": "integer"
},
"RangeName": {
"description": "Gets or sets the name of the range.",
"type": "string"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of the class.",
"type": "integer"
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this vehicle range is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this vehicle range.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"TcdRangeId": 0,
"RangeId": 0,
"RangeName": "string",
"ClassId": 0,
"IsLocked": false,
"InfoDataExists": false
}
},
"TypeListMsg": {
"description": "Class {TypeListMsg} contains the properties which are necessary to call web service methods\r\nTypeList(TypeListMsg).",
"required": [
"ShowCar",
"ShowTruck",
"ShowBike",
"RangeId",
"CountryCode",
"LanguageCode"
],
"type": "object",
"properties": {
"ModuleFilter": {
"format": "int32",
"description": "Gets or sets the filter for modules. Possible enumeration values: - `0` = None
- `1` = Ad
- `2` = Coo
- `3` = CooNew
- `4` = Ctrl
- `5` = Di
- `6` = Lt
- `7` = Md
- `8` = Sos
- `9` = Tm
- `10` = Td
- `11` = Wd
- `12` = Notes
- `13` = Cwd
- `14` = Fr
- `15` = Pp
- `16` = Bg
- `17` = VIN
- `18` = Paint
- `-1` = All
",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
-1
],
"type": "integer"
},
"TypeNameFilter": {
"description": "Gets or sets the filter for the vehicle type names. An empty string means no type filtering.",
"type": "string"
},
"AddInfoKeyFilter": {
"description": "Gets or sets the filter after additional information like manufacturer id, fuel typ, axle configuration etc.",
"type": "array",
"items": {
"$ref": "#/definitions/AddInfoKeyFilterParameter"
}
},
"ComponentTypeIdFilter": {
"format": "int32",
"description": "Gets or sets the component type id filter. Passing null means no component type id filtering.",
"type": "integer"
},
"ShowCar": {
"description": "Gets or sets a value indicating whether cars are included in the result.",
"type": "boolean"
},
"ShowTruck": {
"description": "Gets or sets a value indicating whether trucks and light commercial vehicles are included in the result.",
"type": "boolean"
},
"ShowBike": {
"description": "Gets or sets a value indicating whether motorbikes are included in the result.",
"type": "boolean"
},
"RangeId": {
"format": "int32",
"description": "Gets or sets the TecRMI range id which identifies a model range of a car manufacturer.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
}
},
"example": {
"ModuleFilter": 0,
"TypeNameFilter": "string",
"AddInfoKeyFilter": [
{
"AddInfoKeyId": 0,
"AddInfoKeyFilterValue": "string"
}
],
"ComponentTypeIdFilter": 0,
"ShowCar": false,
"ShowTruck": false,
"ShowBike": false,
"RangeId": 0,
"CountryCode": "string",
"LanguageCode": "string"
}
},
"VtType": {
"description": "Class VtType represents a vehicle type. In the vehicle tree hierarchy, types are children of ranges.\r\nEach type belongs to exactly one range.",
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the id of the vehicle type.",
"type": "integer"
},
"TypeName": {
"description": "Gets or sets the name of the type.",
"type": "string"
},
"TypeDetails": {
"description": "Gets or sets a collection of additional details for this type.",
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeAdditionalDetail"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this type is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this vehicle type.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"TypeId": 0,
"TypeName": "string",
"TypeDetails": [
{
"KindOfAdditionalDetail": 0,
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
],
"IsLocked": false,
"InfoDataExists": false
}
},
"VtTypeTcd": {
"description": "Class VtType represents a vehicle type. In the vehicle tree hierarchy, types are children of ranges.\r\nEach type belongs to exactly one range.",
"type": "object",
"properties": {
"TcdTypeId": {
"format": "int32",
"description": "Gets or sets the TecDoc id of the vehicle type.",
"type": "integer"
},
"ClassId": {
"format": "int32",
"description": "Gets or sets the id of the class.",
"type": "integer"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the id of the vehicle type.",
"type": "integer"
},
"TypeName": {
"description": "Gets or sets the name of the type.",
"type": "string"
},
"TypeDetails": {
"description": "Gets or sets a collection of additional details for this type.",
"type": "array",
"items": {
"$ref": "#/definitions/VtTypeAdditionalDetail"
}
},
"IsLocked": {
"description": "Gets or sets a value indicating whether access to this type is denied.",
"type": "boolean"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this vehicle type.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
}
},
"example": {
"TcdTypeId": 0,
"ClassId": 0,
"TypeId": 0,
"TypeName": "string",
"TypeDetails": [
{
"KindOfAdditionalDetail": 0,
"AddInfoKeyId": 0,
"AddInfoKeyName": "string",
"AddInfoKeyValue": "string"
}
],
"IsLocked": false,
"InfoDataExists": false
}
},
"TypeTextMsg": {
"description": "Class {TypeTextMsg} contains the properties which are necessary to call the web service methods\r\nTypeText(TypeTextMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"AddInfoKeyForTypeText": {
"description": "Gets or sets a collection of ids of the additional information keys which values should be display\r\nin the result type text. Passing null will add the value for kW to the type text.\r\nThe ids can be fetched by calling the web method AddInfoKeys(AddInfoKeysMsg)",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"AddInfoKeyForTypeText": [
0
],
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"VtTypeDetailMsg": {
"description": "Class {VtTypeDetailMsg} contains the properties which are necessary to call the web service methods\r\nTypeDetails(VtTypeDetailMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"AdItemMpIdsAsAddInfoKey": {
"description": "Gets or sets a static collection of item mount positions from adjustment data (Ad) whose\r\nvalues will be returned in the list of additional information for the given vehicle too.",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
}
},
"example": {
"AdItemMpIdsAsAddInfoKey": [
0
],
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0
}
},
"VehicleHasWiringMsg": {
"description": "Class {VehicleHasWiringMsg} contains the properties which are necessary to call the web service module check methods.",
"required": [
"TypeId",
"CountryCode"
],
"type": "object",
"properties": {
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
}
},
"example": {
"TypeId": 0,
"CountryCode": "string"
}
},
"WdManualListMsg": {
"description": "Class {WdManualListMsg} is the base class for a few message classes and\r\ncontains the properties which are necessary to call web service methods\r\nManualList(WdManualListMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"TextSearch": {
"description": "Gets or sets the text search. If this isn't NULL or empty a search after this value will be performed.",
"type": "string"
},
"GenArtNumber": {
"format": "int32",
"description": "Gets or sets the generic article number.\r\nOnly if this contains a value and TextSearch is NULL or empty a search after the passed generic article is performed.",
"type": "integer"
},
"GenCritNumber": {
"format": "int32",
"description": "Gets or sets the generic criterion number.",
"type": "integer"
},
"GenCritValue": {
"description": "Gets or sets the generic criterion value.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"TextSearch": "string",
"GenArtNumber": 0,
"GenCritNumber": 0,
"GenCritValue": "string"
}
},
"WdMainGroup": {
"description": "Class WdMainGroup represents a main group for wiring data. In the topic tree hierarchy, main groups are on the topmost level.\r\nEach main group may have several sub groups as children.",
"type": "object",
"properties": {
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the id of the main group.",
"type": "integer"
},
"MainGroupName": {
"description": "Gets or sets the name of the main group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this main group. A collection\r\nof main groups will be sorted against this number.",
"type": "integer"
},
"MainGroupImage": {
"description": "Gets or sets the image of the main group.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this main group.\r\nThe portal database must be available to provide information data.",
"type": "boolean"
},
"SubGroups": {
"description": "Gets or sets a collection of sub groups which belongs to this main group.",
"type": "array",
"items": {
"$ref": "#/definitions/WdSubGroup"
}
}
},
"example": {
"MainGroupId": 0,
"MainGroupName": "string",
"SortOrder": 0,
"MainGroupImage": "string",
"InfoDataExists": false,
"SubGroups": [
{
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
]
}
},
"WdSubGroup": {
"description": "Class WdSubGroup represents a sub group for wiring data. In the topic tree hierarchy, sub groups are children of main groups.\r\nThe same sub group might also be a child of several different main groups making the topic tree rather a directed acyclic graph than a tree.\r\nEach sub group may have several item mount positions as children.",
"type": "object",
"properties": {
"SubGroupId": {
"format": "int32",
"description": "Gets or sets the id of the sub group.",
"type": "integer"
},
"SubGroupName": {
"description": "Gets or sets the name of the sub group.",
"type": "string"
},
"SortOrder": {
"format": "int32",
"description": "Gets or sets the order number of this sub group. A collection\r\nof sub groups will be sorted against this number.",
"type": "integer"
},
"SubGroupImage": {
"description": "Gets or sets the sub group image.",
"type": "string"
},
"InfoDataExists": {
"description": "Gets or sets a value indicating whether there are information data existing for this sub group. The portal database must be available to provide information data.",
"type": "boolean"
},
"ItemMps": {
"description": "Gets or sets a collection of item mount positions which belongs to this sub group.",
"type": "array",
"items": {
"$ref": "#/definitions/WdItemMp"
}
}
},
"example": {
"SubGroupId": 0,
"SubGroupName": "string",
"SortOrder": 0,
"SubGroupImage": "string",
"InfoDataExists": false,
"ItemMps": [
{
"Manuals": [
{
"ManualId": 0,
"QualColText": "string",
"QualColId": 0
}
],
"SortOrder": 0,
"IsLocked": false,
"InfoDataExists": false,
"ItemMpImageName": "string",
"ItemMpId": 0,
"ItemMpText": "string"
}
]
}
},
"MainGroupHtmlMsg": {
"description": "Class {MainGroupHtmlMsg} contains the properties which are necessary to call web service method\r\nMainGroupHtml(MainGroupHtmlMsg).",
"required": [
"LinkUrl",
"CountryCode",
"LanguageCode",
"TypeId"
],
"type": "object",
"properties": {
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"LinkUrl": "string",
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ConsumerId": "string"
}
},
"SubGroupHtmlMsg": {
"description": "Class {SubGroupHtmlMsg} contains the properties which are necessary to call web service method\r\nSubGroupHtml(SubGroupHtmlMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId",
"LinkUrl",
"MainGroupId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"MainGroupId": {
"format": "int32",
"description": "Gets or sets the TecRMI topic main group id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"LinkUrl": "string",
"MainGroupId": 0,
"ConsumerId": "string"
}
},
"WdManualHtmlMsg": {
"description": "Class {WdManualHtmlMsg} contains the properties which are necessary to call web service methods\r\nManualHtml(WdManualHtmlMsg).",
"required": [
"PrintView",
"CountryCode",
"LanguageCode",
"TypeId",
"ManualId",
"LinkUrl"
],
"type": "object",
"properties": {
"PrintView": {
"description": "Gets or sets a value indicating whether the generated document should be optimised for printing.",
"type": "boolean"
},
"KindOfWorkTime": {
"format": "int32",
"description": "Gets or sets an enum value indicates which unit the work time in the result should have. Possible enumeration values: - `0` = DecimalWorkHours
- `1` = ManufacturerWorkPositions
",
"enum": [
0,
1
],
"type": "integer"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
},
"LinkUrl": {
"description": "Gets or sets the link url. The actual link information is going to be added at the end of this url.\r\nIt is used where documents contains links to other and are shown in custom application.",
"type": "string"
},
"ConsumerId": {
"description": "Unique identifier for end user which receive the called data.",
"type": "string"
}
},
"example": {
"PrintView": false,
"KindOfWorkTime": 0,
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ManualId": 0,
"LinkUrl": "string",
"ConsumerId": "string"
}
},
"ImageNamesForWiringManualMsg": {
"description": "Class {ImageNamesForWiringManualMsg} contains the properties which are necessary to call web service methods\r\nImageNamesForWiringManual(ImageNamesForWiringManualMsg).",
"required": [
"ManualId"
],
"type": "object",
"properties": {
"ManualId": {
"format": "int32",
"description": "Gets or sets the TecRMI manual id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"ManualId": 0
}
},
"LinkedWiringDiagramsMsg": {
"description": "Class {LinkedWiringDiagramsMsg} contains the properties which are necessary to call the web service methods\r\nLinkedWiringDiagrams(LinkedWiringDiagramsMsg).",
"required": [
"CountryCode",
"LanguageCode",
"TypeId",
"ItemMpId"
],
"type": "object",
"properties": {
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique.\r\nThe id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"ItemMpId": {
"format": "int32",
"description": "Gets or sets the TecRMI item mount position id.\r\nThe id can be fetched by using the topic tree methods from the respective modules.",
"type": "integer"
}
},
"example": {
"CountryCode": "string",
"LanguageCode": "string",
"TypeId": 0,
"ItemMpId": 0
}
},
"LinkedFuseRelaisMsg": {
"description": "Class {LinkedFuseRelaisMsg} contains the properties which are necessary to call web service method\r\nLinkedFuseRelais(LinkedFuseRelaisMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"LinkId",
"ComponentTypeId",
"LinkType"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkId": {
"format": "int32",
"description": "Gets or sets the identifier of the link.",
"type": "integer"
},
"ComponentTypeId": {
"format": "int32",
"description": "Gets or sets the component type id.",
"type": "integer"
},
"LinkType": {
"format": "int32",
"description": "Gets or sets the type of the link. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
],
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"LinkId": 0,
"ComponentTypeId": 0,
"LinkType": 0
}
},
"LinkedPartPositionMsg": {
"description": "Class {LinkedPartPositionMsg} contains the properties which are necessary to call web service method\r\nLinkedPartPosition(LinkedPartPositionMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"LinkedId",
"LinkType"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"LinkedId": {
"format": "int32",
"description": "Gets or sets the identifier of the link.",
"type": "integer"
},
"LinkType": {
"format": "int32",
"description": "Gets or sets the type of the link. Possible enumeration values: - `32` = None
- `97` = AdItemMpId
- `98` = FusesBoxItemMpId
- `99` = BgItemGroup
- `100` = DiagnosisItemId
- `101` = ErrorcodeManualId
- `102` = Fuses
- `103` = HotSpotGenArt
- `104` = BgMainGroupId
- `105` = TmItemMpId
- `106` = DiagnosticContentId
- `107` = Unused_K
- `108` = LockedItem
- `109` = TmManualId
- `110` = OeSparePartNo
- `111` = WdMainGroupId
- `112` = Image
- `113` = Unused_Q
- `114` = Unused_R
- `115` = BgSubGroupId
- `116` = VehicleTreeTypeId
- `117` = Unused_U
- `118` = Unused_V
- `119` = WdItemMpId
- `120` = Unused_X
- `121` = ImageLinkId
- `122` = Unused_Z
",
"enum": [
32,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122
],
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"LinkedId": 0,
"LinkType": 0
}
},
"LinkedDiagnosticsMsg": {
"description": "Class {LinkedDiagnosticsMsg} contains the properties which are necessary to call web service method\r\nLinkedDiagnostics(LinkedDiagnosticsMsg).",
"required": [
"LanguageCode",
"CountryCode",
"TypeId",
"DiItemId"
],
"type": "object",
"properties": {
"LanguageCode": {
"description": "Gets or sets the 2-letter international language code as defined by ISO 639-1.",
"type": "string"
},
"CountryCode": {
"description": "Gets or sets the 2-letter international country code as defined by ISO 3166-1.",
"type": "string"
},
"TypeId": {
"format": "int32",
"description": "Gets or sets the TecRMI type id which identifies a vehicle unique. The id can be fetched by using the ServiceVt web service.",
"type": "integer"
},
"DiComponentTypeId": {
"format": "int32",
"description": "Gets or sets the identifier of the diagnostic component type.",
"type": "integer"
},
"DiItemId": {
"format": "int32",
"description": "Gets or sets the identifier of the diagnostic item.",
"type": "integer"
}
},
"example": {
"LanguageCode": "string",
"CountryCode": "string",
"TypeId": 0,
"DiComponentTypeId": 0,
"DiItemId": 0
}
}
}
}