TecRMI Service Index REST
Adjust
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contain properties for the data which are necessary for calling the web service method. To calling a method create an instance
of their message class, set the necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language. Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1. All application data will be
returned as it is available for this country. Only county codes returned by
Countries(...)
in the TecRMI common REST service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI web service by the customers
application has to be passed. The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Adjust - Interface description:
ServiceAd_REST.pdf
First of all, you should check whether there is adjustment data available for the currently selected vehicle.
To perform this check, you simply call
VehicleHasAdjust(...)
which returns a boolean value indicating
whether there is adjustment data (true
) or not (false
)
To build a working menu for selecting adjustment data for a specific vehicle you should invoke the method
List(...)
.
From this method, you will get a list containing further lists which hold all the information on the adjustment data sub groups and items of the vehicle.
To get an adjustment data manual in html format, you have to call
MainGroupHtml(...)
where you
pass the type id of your chosen vehicle and one of the main group ids which you got from List(...)
.
Wenn you set the property "PrintView
" to true the html document will be optimized for printing.
You can also create adjustment data manuals which only contain information for a special subgroup or item instead of a whole main group.
To get such a manual for a special sub group you simply call
SubGroupHtml(...)
where you pass the subgroup id
which you probably already got from List(...)
and, as usual, the type id of the selected vehicle. To do this for a special item use
ItemHtml(...)
and passing the item mount position id from List(...)
.
Audit
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common REST service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI web service by the customers application has to be passed.
The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Audit - Interface description:
ServiceAudit_REST.pdf
Audit is for the inverse search for the labour times and the maintenance data.
To retrieve a list of the spare parts for the selected type Id and the spare part number call the method
PartsByOe(...)
.
The Method
MaintenanceWorkStepsForApos
gets a list to generate the maintenance work position for the selected type id with the selected maintenance data body id.
To generate a labour times topic tree for the given type call the method TimestWorkListForOeNo
.
Basket
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common REST service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI web service by the customers application has to be passed.
The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Basket - Interface description:
ServiceBasket_REST.pdf
Some of the html documents could contain graphics in the .SVG format.
To use the invoice option, you first have to call
PartsForWorks(...)
passing body ids from
ServiceLt and ServiceMd and the array of work ids which you also can select in these two services.
To complete the invoicing process, call
CalcResultHtml(...)
which returns a string containing a HTML document.
ComfortWiring
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common REST service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI web service by the customers application has to be passed.
The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/ComfortWiring - Interface description:
ServiceCWD_REST.pdf
First, check if there are any comfort wiring diagrams (cwd) available for your vehicle. To do so, call
VehicleHasComfortWiring(...)
passing your type id. To get all the cwd information for one vehicle call ManualList(...)
, which will provide a
list with your requested information. To get a single manual in html format, call ManualHtml(...)
.
If a grafical selection based on HTML is planed to implement first call the method MainGroupHtml(...)
to fetch
the HTML document for the main group graphics. The HTML document for the subgroups can be retrieved by calling the web service method
SubGroupHtml(...)
.
Common
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common REST service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI web service by the customers application has to be passed.
The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Common - Interface description:
ServiceCommon_REST.pdf
The service contains methods wich do not belong to a special module like methods for fetching the supported country and languages. Further this web service
contains methods to fetch application texts as a textual description what the flag 'TecRMI time' means.
ComponentLocations
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common REST service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI web service by the customers application has to be passed.
The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/ComponentLocations - Interface description:
ServicePp_REST.pdf
First, check if there are any part position data available for your car. To do so, call the method
VehicleHasComponents(...)
passing your type id. To get all the information of the part position for one vehicle call by calling List(...)
,
which will provide a list with your requested information. To get a single manual in HTML format, call ManualHtml(...)
.
ComponentTree
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/ComponentTree - Interface description:
ServiceCo_REST.pdf
To build the component tree you first have to call the
ComponentClasses(...)
method,
which returns a list of component classes. After selecting a component class you can pass its id to ComponentMakes(...)
,
so you will get a list of component makes in return.
To retrieve the types belonging to a make, call ComponentTypes(...)
passing it the make id.
DiagnosticValues
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/DiagnosticValues - Interface description:
ServiceDi_REST.pdf
First, check whether there is diagnosis data available for the selected vehicle. To do so, call VehicleHasDiagnostics(...)
passing your type id. (
true
) which returns a boolean value indicating whether there is diagnostic data (true
) or not (false
)
By calling the
ComponentsForType(...)
method you get the components of the given
vehicle which have diagnostic data. The diagnostic tree is fetched by invoking the method List(...)
with the chosen component type id. Finally you call the method ManualHtml(...)
the get a HTML document with the detailed data for the selected item from the diagnostic tree.
Fuses and Relays
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/RelaysFuses - Interface description:
ServiceFr_REST.pdf
First of all, you should check whether there is fuse and relays data available for the currently selected vehicle.
To perform this check, you simply call
VehicleHasRelaysFuses(...)
which returns a boolean value indicating
whether there is adjustment data (true
) or not (false
).
Subsequent you call
ComponentsForType(...)
to
determine a list of components which has fuses and relays data for the given vehicle. For the chosen component you call the method
BoxOverviewHtml(...)
to get a HTML overview
document over the possible location of the fuse and relays boxes. The fuse and relays tree for one of this boxed is returned by the
BoxDetailList(...)
method. Finally you call the method
BoxDetailHtml(...)
to get the detail view in HTML.
Graphics
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Graphics - Interface description:
ServiceBg_REST.pdf
First of all, you should check whether there are any body graphics available for the selected vehicle.
To perform this check, you simply call the method
VehicleHasGraphics(...)
.
To get the topic tree of the module body graphics, call the method
ManualList(...)
which will provide a list with the requested information. The required body parameter can be obtained by calling
the BodiesForGraphics(...)
method.
To build an HTML based navigation, call the appropriate methods
VehicleHtml(...)
,
MaingroupHtml(...)
and SubgroupHtml(...)
.
LabourTimes
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Times - Interface description:
ServiceLt_REST.pdf
First of all, you should check whether there are labour times data for your vehicle available. You can do this using the method
VehicleHasTimes(...)
which returns a boolean value indicating whether
there is labour times data (true
) or not (false
). Next you should select a matching body for your vehicle from the result
of the method call BodiesForTimes(...)
. To get a list with all works for
your vehicle, you can call WorkList(...)
passing the vehicle id and body id of your vehicle.
If you want to get the work steps for an item call
WorkSteps(...)
.
The result contains the work position it self and two properties. While the property ExclusiveWorkPositions
is only for your information
and contains the values from which the main labour times work position is composed, the property OptionalExclusivePositions
contains optional
additional labour times work positions which can only be selected in combination with its main labour times work position.
Maintenance
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Maintenance - Interface description:
ServiceMd_REST.pdf
First of all, you should check whether there is maintenance data available for the currently selected vehicle.
To perform this check, you simply call
VehicleHasMaintenance(...)
which returns a boolean value indicating whether there is maintenance data (true
) or not (false
).
Then you should choose the matching body of your vehicle from the return value of the method
BodiesForMaintenance(...)
.
Next step is to call
SubGroups(...)
to get a list of service main works and addition works for your vehicle.
If you want to get the work steps for an item call the method
WorkSteps(...)
.
To get a maintenance plan you can either call
MaintenancePlanData(...)
or
MaintenancePlanHtml(...)
for the HTML version of the manual.
To get the manufacturers information your vehicle pass its type id to
MakeInfoManuals(...)
.
From this method you will get a list of manual ids in return, which you can use to call
ManualHtml(...)
.
Servicefinder
First check if the service finder is available for the selected vehicle.
To perform this check, you simply call
VehicleServiceProposal(...)
which returns a boolean value indicating whether there is a service proposal available (true
) or not (false
).
Then you should choose the matching body of your vehicle from the return value of the method GetBodiesForMaintenance
(...).
The next step is to call
PossibleGearboxCodes(...)
that delivers a list of gearbox codes which one of them can be passed to the method ServiceProposalCooGroups(...)
.
This returns a list of maintenance variants for the selected vehicle. Additionally you can add filter parameters if a vehicle results many COOGroups.
To get a list of work positions which should have been done in the last service and which should be done in the next service for the selected vehicle,
current mileage and initial registration date, you call the the method
ServiceProposal(...)
.
Notes
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Notes - Interface description:
ServiceInfo_REST.pdf
If you want to fetch additional information to your vehicle tree, you should call
ForMake(...)
,
which provides additional info for vehicle manufacturers (makes).
To provide this kind of information for your model ranges and/or types you should call
ForRange(...)
and ForType(...)
.
All these methods return only the information in their realm. To fetch all information for a given type use the method
AllInfosForType(...)
ServiceAuthentication
Before calling a method of one of the TecRMI web services an authentication has to be performed. Therefore the
Login
method has to be called via POST.
For this call the following request headers have to be set:
- User-Agent
- Origin
- Host
-
Accept; possible Values are:
- application/json
- application/jsonp
- application/xml
-
Content-Type; possible Values are:
- application/json
- application/xml
- application/x-www-form-urlencoded
The authentication generates a token which is returned as response header
The value of the
X-AuthToken
. To authenticate further web service calls
the string TecRMI
, a space character and this token has to be combined and set as the value of the request header Authorization
.
Also the request headers shown above have to be set for all further requests. The values of the User-Agent and Origin headers must not change during one authentication session.
If authentication fails all methods will return the HTTP error code 401.
Example
The X-AuthToken is:123456
The value of the
Authorization
header is: TecRMI 123456
SOS
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Sos - Interface description:
ServiceSos_REST.pdf
At first, check whether there is SOS data available for your vehicle by calling
VehicleHasBulletins(...)
.
If so, you should call ManualList(...)
to get a list of SOS main groups, subgroups and items for your vehicle.
A html page containing the selected manual will be provided by a call to the web service method ManualHtml(...)
.
TechnicalManuals
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Manuals - Interface description:
ServiceTm_REST.pdf
First, check if there are any technical manuals available for your car. To do so, call
VehicleHasManuals(...)
passing your type id. To get all the information of technical manuals for one vehicle call ManualList(...)
, which will provide a list
with your requested information. To get a single manual in HTML format, call ManualHtml(...)
.
Tyres
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. To this a unique value, which identifiers the customers users which uses the TecRMI
web service by the customers application has to be passed. The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Tyres - Interface description:
ServiceTd_REST.pdf
First of all, check if your vehicle has tyre data using
VehicleHasTyres(...)
.
To get a listing of available ABEs, KBAs and VSNs for your type id, call TyreTypes(...)
.
To get information for a special ABE, call Tyres(...)
. Call method
AllTyresForType(...)
when a list of all tyre which are available for the
vehicle is needed. The HTML version of the list of all tyres can be fetched by calling the web service method
AllTyresForTypeHtml(...)
.
VehicleTree
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. This is a unique value meant to be used to identify the customer´s users.
The length of the ConsumerId
property value is restricted to 50
characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/VehicleTree - Interface description:
ServiceVt_REST.pdf
To build the TecRMI vehicle tree yourself, you should first call
MakeList(...)
, which will return a list
containing all necessary vehicle manufacturers (makes). After selecting a make from this list, you can call RangeList(...)
and pass it the make id of your chosen make to get the model ranges belonging to this make.
To get the types belonging to a selected model range, you call TypeList(...)
, passing your range id.
To view all the stored details of a particular type, you call TypeDetails(...)
passing your type id.
If a filter is used, it has to be applied on all of the three layers (make, range and type). Possible filter values, including Vin filter,
can be fetched by using the method
AddInfoKeys(...)
.
Some methods requires a classID as parameter. Following values are possible:
- ClassID: 1
- Represents car
- ClassID: 2
- Represents truck
- ClassID: 3
- Represents motorbike
- ClassID: 4
- Represents engine
- ClassID: 5
- Represents gearbox
- ClassID: 6
- Represents axle
- ClassID: 7
- Represents brakes
Wiring
The web service methods uses message classes as parameter value. All these classes are derived from the base class
BaseMsg
and contains properties for the data which are necessary for calling the web service method. To calling a method create an instance of their message class, set the
necessary data to the message class properties and pass it through the web service method.
Some methods require the LanguageCode properties, a 2-letter message internationalization language code as defined by ISO 639-1.
All text messages will be returned in the defined language.
Only language codes returned by
Languages(...)
in the TecRMI common web service are valid.
Some methods require the CountryCode properties, a 2-letter data internationalization country code as defined by ISO 3166-1.
All application data will be returned as it is available for this country.
Only county codes returned by
Countries(...)
in the TecRMI common web service are valid.
Some methods require the
ConsumerId
property. This is a unique value meant to be used to identify the customer´s users.
The length of the ConsumerId
property value is restricted to 50 characters and is used for access control and billing.
All methods send an error message if an exception occurred or the access to the web service was denied.
All methods that are documented to return a list return an array instead.
Some of the html documents could contain graphics in the .SVG format.
- Documentation:
https://rmi-services.tecalliance.net/swagger/ui/index#/Wiring - Interface description:
ServiceWd_REST.pdf
First, check if there are any wiring diagrams (wd) available for your vehicle. To do so, call
VehicleHasWiring(...)
passing your type id. To get all the wd information for one vehicle call ManualList(...)
, which will provide a
list with your requested information. To get a single manual in html format, call ManualHtml(...)
.
If a grafical selection based on HTML is planed to implement first call the method MainGroupHtml(...)
to fetch
the HTML document for the main group graphics. The HTML document for the subgroups can be retrieved by calling the web service method
SubGroupHtml(...)
.
© TecAlliance GmbH