SRT

Detailed description of API:

Version & Updates

Version	Revision Date	Revision History
1.0	16th June 2024	New Release

Overview

SRT API is intended to expose details related to a SRT code, its description, timesheet, model, product line, region etc. This enables the DMS providers to have information on the rates, work units at the time of creating a flat rate work order repair/quote. A DMS provider can query the SRT data on a real time basis by providing the Vehicle Identification Number (VIN) or the Model Number. The API provides information that are available in Smart basket application today for the given equipment or model after filtering information that might not be useful for the dealers. All the SRT and its relevant data are extracted from the Smart Basket system of CNHi. Please refer to diagram below for information on the data flow of this interface.

1 working unit = 6 minutes

Pre-requisites

Pre-requisites

• Dealer must use their Dealer Portal credentials to authorize API call.
• Each DMS provider will have a Subscription key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• Each Subscription key is unique to DMS and the environment it belongs to.

Authentication

Authentication

• DMS will pass Basic auth in HTTP header with username/password
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
• DEP API will require subscription_key in HTTP header to identify client

API Format

• REST

The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. New development for this interface are always recommended to the build to REST API for greater simplicity.

Connection Details

For SRT there's 3 API types offered:

• Parts APIs
• VIN APIs
• VIN & Parts APIs

CNHi provides two environments for its APIs:

• Cert/UAT
• Production

The environments are identical, requiring only that you change out your connection string and authorization endpoint to connect to any of the environments.

Parts API

Endpoints

Environment	API URL	API	Request Type
UAT / Staging	https://{base_url}/emeaexternal/srtpartsservice/part/{partnumber}	REST	GET
Production	https://{base_url}/emeaexternal/srtpartsservice/part/{partnumber}	REST	GET

Request Parameters

Name	Params Type	Type	Is Required	Default Value	Comments
partNumber	Template	String	True	-	Part identification number
Lang	Query	String	False	en	Language – default value will be English
responseFormat	Query	String	False	json	Response Format [xml or json] – default will be json

Response Description

Name	Type	Description
pnCode	String	Part number code
pnDesc	String	Part number description
operationGp.group.GpdGr	String	Group ID
operationGp.group.desc	String	Group description
operationGp.group.grCode	String	Group Code
operationGp.group.subGroup.sGr	String	Sub group ID
operationGp.group.subGroup.desc	String	Sub group description
operationGp.group.subGroup.sGrCode	String	Sub group code
operationGp.group.subGroup.defect.sSGr	String	Sub sub group code
operationGp.group.subGroup.defect.desc	String	Sub sub group description
operationGp.group.subGroup.defect.sSGrCode	String	Sub sub group code
operationGp.group.subGroup.defect.operation.opID	String	Operation ID
operationGp.group.subGroup.defect.operation.desc	String	Operation description
operationGp.group.subGroup.defect.operation.code	String	Operation code
operationGp.group.subGroup.defect.operation.rank	String	Rank

Sample Parts API Response

Download Sample Parts API Reponse

VIN APIs

VIN APIs can be summarized in 4 parts: Group, Subgroup, Subsubgroup and Operation. Because of that, CNHi offers 4 APIs:

• Group API
• Subgroup API
• Sub Subgroup API
• Operation API

Group API

Endpoints

Environment	API URL	API	Request Type
UAT / Staging	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}	REST	GET
Production	https://{base_url}/emeaexternal/srtvinsservice/vin/{vinnumber}	REST	GET

Request Parameters

Name	Params Type	Type	Is Required	Default Value	Comments
vinNumber	Template	String	True	-	Serial/Vehicle Identification number of the equipment
Lang	Query	String	False	en	Language – default value will be English
responseFormat	Query	String	False	json	Response Format [xml or json] – default will be JSON

Response Description

Name	Type	Description
response.product.Brand	String	Brand Name
response.product.brandId	String	Brand ID
response.product.Type	String	Type
response.product.Typeid	String	Type ID
response.product.Productname	String	Productname
response.product.Productid	String	Productid
response.product.Series	String	Series
response.product.seriesID	String	seriesID
response.product.Model	String	Model
response.product.Desc	String	Desc
response.product.technicalTypeCode	String	TechnicalTypeCode
response.product.serialnumbercode	String	Serial Number or Vehicle Number
response.product.group.dGr	String	Group ID
response.product.group.desc	String	Group Description
response.product.group.grCode	String	Group Code

Sample Group API Response

Download Sample Group API Reponse

Subgroup API

Endpoints

Environment	API URL	API	Request Type
UAT / Staging	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}/{groupId}	REST	GET
Production	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}/{groupId}	REST	GET

Request Parameters

Name	Params Type	Type	Is Required	Default Value	Comments
vinNumber	Template	String	True	-	Serial/Vehicle Identification number of the equipment
groupId	Template	Integer	True	-	Group ID
Lang	Query	String	False	en	Language – default value will be English
responseFormat	Query	String	False	json	Response Format [xml or Json] – default will be JSON

Response Description

Name	Type	Description
response.subGroup.sGr	String	Group ID
response.subGroup.desc	String	Group Description
response.subGroup.sgrCode	String	SubGroup Code

Sample Subgroup API Response

Download Sample Subgroup API Response

Subsubgroup API

Endpoints

Environment	API URL	API	Request Type
UAT / Staging	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}	REST	GET
Production	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}	REST	GET

Request Parameters

Name	Params Type	Type	Is Required	Default Value	Comments
vinNumber	Template	String	True	-	Serial/Vehicle Identification number of the equipment
groupId	Template	Integer	True	-	Group ID
subgroupId	Template	Integer	True	-	Sub Group ID
Lang	Query	String	False	en	Language – default value will be English
responseFormat	Query	String	False	json	Response Format [xml or Json] – default will be JSON

Response Description

Name	Type	Description
response.defect.SSGr	String	Sub Subgroup ID
response.defect.Desc	String	Sub Subgroup Description
response.defect.SSGrCode	String	Sub Subgroup Code

Sample API Response

Download Sample Subsubgroup API Response

Operations API

Endpoints

Environment	API URL	API	Request Type
UAT / Staging	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}/{SubSubGroupId}	REST	GET
Production	https://{base_url}/emeaexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}/{SubSubGroupId}	REST	GET

Request Parameters

Name	Params Type	Type	Is Required	Default Value	Comments
vinNumber	Template	String	True	-	Serial/Vehicle Identification number of the equipment
groupId	Template	Integer	True	-	Group Id
subgroupId	Template	Integer	True	-	Sub Group Id
subsubgroupId	Template	Integer	True	-	Subsub Group Id
Lang	Query	String	False	en	Language – default value will be English
responseFormat	Query	String	False	json	Response Format [xml or Json] – default will be Json

Response Description

Name	Type	Description
response.operation.opID	String	Operation ID
response.operation.desc	String	Operation Description
response.operation.code	String	Operation Code
response.operation.type	String	Type
response.operation.addDesc	String	Add Desc
response.operation.time	String	Time taken for the operation
response.operation.additionalInfo.rollupList.rolUp_id	String	Roll Up ID
response.operation.additionalInfo.rollupList.rollup_order	String	Roll Up Order
response.operation.additionalInfo.rollupList.rolUp_desc	String	Roll Up Description
response.operation.additionalInfo.Included.opID	String	Included Operation ID
response.operation.additionalInfo.Included.desc	String	Included Operation Description
response.operation.additionalInfo.Excluded.opID	String	Excluded Operation ID
response.operation.additionalInfo.Excluded.desc	String	Excluded Operation Description

Sample API Response

Download Sample Operations API Response

VIN & Parts API

Endpoints

Environment	API URL	API	Request Type
UAT / Staging	https://{base_url}/emeaexternal/srtvinandpartsservice/vin/{vinNumber}/part/{partNumber}	REST	GET
Production	https://{base_url}/emeaexternal/srtvinandpartsservice/vin/{vinNumber}/part/{partNumber}	REST	GET

Request Parameters

Name	Parameter Type	Type	Is Required	Default Value	Comments
VIN Number	Template	String	True	-	Serial/Vehicle Identification number of the equipment
partNumber	Template	String	True	-	Parts Identification number
Lang	Query	String	False	en	Language – default value will be English
responseFormat	Query	String	False	json	Response Format [xml or json] – default will be json

Response Description

Name	Type	Description
response.product.brand	String	Brand Name
response.product.brandid	String	Brand ID
response.product.type	String	Product Type
response.product.typeid	String	Product Type ID
response.product.productName	String	Product Name
response.product.productID	String	Product ID
response.product.series	String	Product Series
response.product.seriesID	String	Product Series
response.product.model	String	Product Model
response.product.desc	String	Product Description
response.product.technicalTypeCode	String	It's TT Code for VIN
response.product.Serialnumbercode	String	Serial Number or Vehicle Number
response.product.pnCode	String	Part number code
response.product.timesheet.timesheetcode	String	Timesheet Code
response.product.timesheet.columncode	String	Timesheet Column Code
response.product.timesheet.columndescription	String	Timesheet Column Description
response.product.timesheet.Opgroup.dGr	string	Group ID
response.product.timesheet.Opgroup.desc	String	Group Description
response.product.timesheet.Opgroup.grCode	String	Group Code
response.product.timesheet.Opgroup.subGroup.sGr	String	Sub group ID
response.product.timesheet.Opgroup.subGroup.desc	String	Sub Group description
response.product.timesheet.Opgroup.subGroup.sGrCode	String	Sub Group code
response.product.timesheet.Opgroup.subGroup.defect.sSGr	String	Sub Sub Group code
response.product.timesheet.Opgroup.subGroup.defect.desc	String	Sub Sub Group description
response.product.timesheet.Opgroup.subGroup.defect.sSGrCode	String	Sub Sub Group code
response.product.timesheet.Opgroup.subGroup.defect.operation.opID	string	Operation ID
response.product.timesheet.Opgroup.subGroup.defect.operation.desc	string	Operation description
response.product.timesheet.Opgroup.subGroup.defect.operation.code	string	Operation Code
response.product.timesheet.Opgroup.subGroup.defect.operation.time	string	Time taken for the operation
response.product.timesheet.Opgroup.subGroup.defect.operation.rank	string	This is the rank for Part Number and Operation ID combination
response.product.timesheet.Opgroup.subGroup.defect.operation.addDesc	string	Operation Additional Description
response.product.timesheet.Opgroup.subGroup.defect.operation.type	String	Operation Type
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.rollupList.rolUp_id	string	Operation Additional Rollup ID
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.rollupList.rollup_order	string	Operation Additional Rollup Order
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.rollupList.rolUp_desc	String	Roll Up Description
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Included.opID	String	Included Operation ID
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Included.desc	String	Included Operation Description
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Excluded.opID	String	Excluded Operation ID
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Excluded.desc	String	Excluded Operation Description

Sample API Response

Download Sample VIN & Parts API Response

Response Codes

Title	Reason	Code
REST SRT success response	Success	200
REST SRT failure response	Bad Request: Request query params are invalid	400
REST SRT failure response	Part Number Invalid	200
REST SRT failure response	No records found / Resource Not Found	404
REST SRT failure response	Internal Server Error	500