SCS Get Trims By VIN API

Overview

Data Format

The following table represents the data formats used in the XML coding (Use to reference the “Format” column in the following XML schema tables)


Data type	Description	Example
X(10)	Characters of max length of 10	ABCDEABCDE
Date	yyyy-mm-dd	2000-12-21
DateTime	yyyy-mm-ddThh:mm:ss	2000-12-21T12:24:40
N(5)	Number, max length of 5	12345
N(8,2)	Number with two decimals, max length of 8.	123456.78
Boolean	Boolean true or false	true

Get Trims By VIN

Request Schema

This web service returns all valid trim values for a VIN.

GetTrimsByVIN Request


Tag	Format	Req/Opt/Cond	Attribute	Valid values	Description
TpaCode	X(4)	R			Third Party Administrator Code
UserId	X(30)	R			User ID issued to the requesting system
Password	X(255)	R			Password issued to the requesting system
VIN	X(17)	R			VIN used for trim lookup.

Sample GetTrimsByVIN SOAP Request

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope> 
<soap:Header/>
    <soap:Body>
        <GetTrimsByVIN>
            <request>
                <UserId>xxxx</UserId>
                <Password>xxxx</Password>
                <TpaCode>xxx</TpaCode>
                <VIN> 1HGCT2B96HA000295</VIN>
            </request>
        </GetTrimsByVIN>
    </soap:Body>
</soap:Envelope>

Response Schema

GetTrimsByVINResponse Object


Tag	Content Items	Format	Description
GetTrimsByVINResponse
	GetTrimsByVINResult
	ResponseCode		2 = Successful, GetTrimsByVIN passed with warning; 1 = Successful, GetTrimsByVIN passed; 0 = GetTrimsByVIN failed; See Message Object for Type
	Messages	MessageObject)	Collection of Messages.
	Trims

Message Object


Tag	Format	Req/Opt/Cond	Valid values	Description
Type	Integer	R	1. – Error 2. – Info 3. – Warning 4. - Success	Message Type
Code	String, X(30)	R		Returns the associated message code with each message text.
Text	String, X(2000)	R		Message Text

Trims Object


Tag	Content Items	Format	Description
Trims/
	Trim		Collection (array 1..N) of Trims.

Trim Object


Tag	Format	Req/ Opt/ Cond	Attributes	Valid values	Description
Value	X(50)	R			Trim value

Sample GetTrimsByVIN SOAP Response

<soap:Envelope>
    <soap:Body>
        <GetTrimsByVINResponse>
            <GetTrimsByVINResult>
                <ResponseCode>0</ResponseCode>
                <Messages/>
                <Trims>
                    <Trim>
                        <Value>90</Value>
                    </Trim>
                    <Trim>
                        <Value>L5</Value>
                    </Trim>
                    <Trim>
                        <Value>SPORT</Value>
                    </Trim>
                </Trims>
            </GetTrimsByVINResult>
        </GetTrimsByVINResponse>
    </soap:Body>
</soap:Envelope>

Error Messages


Message Type	Error code	Message Text
Error	rfvTPACode	TPA Code is required.
Error	VD0003	TPA is invalid.
Error	VD0009	Authentication Failed. You do not have necessary permission to execute this web method.
Error	VIN_NOT_ENTER	Vehicle information is missing or not valid.
Information	NO_TRIMS	There are no Trims for the requested VIN.

04 Get Trims By VIN API

SCS Get Trims By VIN API#

Overview#

Data Format#

Get Trims By VIN#

Request Schema#

GetTrimsByVIN Request#

Sample GetTrimsByVIN SOAP Request#

Response Schema#

GetTrimsByVINResponse Object#

Message Object#

Trims Object#

Trim Object#

Sample GetTrimsByVIN SOAP Response#

Error Messages#