Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Methods:

Anchor
GetRetailerVehicleMakesDown
GetRetailerVehicleMakesDown
GetRetailerVehicleMakesDown

...

Code Block
titleRequest
collapsetrue
{
   "version":"1.1",
   "method":"vtVehicleServices.GetRetailerVehicleYearsDown",
   "params":{
      "SessionId":"97F3DF1E-3C83-47CC-8F7F-92EDBF81FE16SessionID",
      "RetailerId":16952RetailerID,
      "MakeId":47,
      "ModelId":590
   }
}

...

public void vtVehicleServices.GetRetailerVehicleBodyTypesDown(AnsiString SessionId , Int32 RetailerId , Int32 MakeId , Int32 ModelId , Int32 Year , out vtVehicleBodyTypeArray BodyTypeList , out vtVehicleTrim2Array TrimList);

SOAP Examples:

...

Code Block
languagexml
titleRequest
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...


   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">

...


      <v1:vtVehicleServices___GetRetailerVehicleBodyTypesDown xmlns:v1="http://tempuri.org/">

...


         <v1:SessionId>SessionId</v1:SessionId>

...


         <v1:RetailerId>RetailerId</v1:RetailerId>

...


         <v1:MakeId>MakeId</v1:MakeId>

...


         <v1:ModelId>ModelId</v1:ModelId>

...


         <v1:Year>Year</v1:Year>

...


      </v1:vtVehicleServices___

...

GetRetailerVehicleBodyTypesDown>
   </SOAP-ENV:Body>

...


</SOAP-ENV:Envelope>
Code Block
languagexml

...

titleResponse
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:v1="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...


   </SOAP-ENV:Header>

...


   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">

...


      <v1:vtVehicleServices___

...

GetRetailerVehicleBodyTypesDownResponse>
         <v1:BodyTypeList>
            <v1:vtVehicleBodyType>
               <v1:BodyType>2DR COUPE</v1:BodyType>
               <v1:BodyTypeID>1</v1:BodyTypeID>

...


            </v1:

...

vtVehicleBodyType>
         </v1:BodyTypeList>

...


         <v1:TrimList>
            <v1:vtVehicleTrim2>
               <v1:TrimLevel />
               <v1:VehicleId>127340</v1:VehicleId>
            </v1:vtVehicleTrim2>
         </v1:TrimList>
      </v1:vtVehicleServices___

...

GetRetailerVehicleBodyTypesDownResponse>
   </SOAP-ENV:Body>

...


</SOAP-ENV:Envelope>

...

GetRetailerVehicleTrims

...

JSON Examples:

...

Code Block

...

title

...

Request

...

collapse

...

true
{
   "version":"1.1",
   "method":"vtVehicleServices.GetRetailerVehicleBodyTypesDown",
   "params":{
      "SessionId":"SessionID",
      "RetailerId":RetailerID,
      "MakeId":47,
      "ModelId":590,
      "Year":2016
   }
}
Code Block
titleResponse
collapsetrue
{
   "version":"1.1",
   "result":{
      "BodyTypeList":[
         {
            "BodyType":"4DR SEDAN",
            "BodyTypeID":"7"
         }
      ],
      "TrimList":[
         {
            "TrimLevel":"",
            "VehicleId":"236034"
         }
      ]
   }
}

Anchor
GetRetailerVehicleTrims
GetRetailerVehicleTrims
GetRetailerVehicleTrims

Parameters:

FlagNameTypeDocumentation
InSessionIdAnsiStringCurrent SessionID
InRetailerIdIntegerCompanyID returned from Login
InMakeIdIntegerMakeID to return models for
InModelIdIntegerModelID to return years for
InYearIntegerYear to return bodytypes for
InBodyTypeIdIntegerBodyTypeID to return trims for
OutTrimListvtVehicleTrim2ArrayArray of Vehicle Trims

...

public void vtVehicleServices.GetRetailerVehicleTrims(AnsiString SessionId , Int32 RetailerId , Int32 MakeId , Int32 ModelId , Int32 Year , Int32 BodyTypeId , out vtVehicleTrim2Array TrimList);

SOAP Examples:

Code Block
language

...

xml
titleRequest
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...


   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">

...


      <v1:vtVehicleServices___GetRetailerVehicleTrims xmlns:v1="http://tempuri.org/">

...


         <v1:SessionId>SessionId</v1:SessionId>

...


         <v1:RetailerId>RetailerId</v1:RetailerId>

...


         <v1:MakeId>MakeId</v1:MakeId>

...


         <v1:ModelId>ModelId</v1:ModelId>

...


         <v1:Year>Year</

...

v1:Year>
         <v1:BodyTypeId>BodyTypeId</v1:BodyTypeId>

...


      </v1:vtVehicleServices___

...

GetRetailerVehicleTrims>
   </SOAP-ENV:Body>

...


</SOAP-ENV:Envelope>

...

Code Block
languagexml
titleResponse
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:v1="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...


   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">

...


      <v1:vtVehicleServices___

...

GetRetailerVehicleTrimsResponse>
         <v1:TrimList>
            <v1:vtVehicleTrim2>
               <v1:TrimLevel />
               <v1:VehicleId>127340</v1:VehicleId>

...


            </v1:

...

vtVehicleTrim2>
         </v1:TrimList>

...


      </v1:vtVehicleServices___

...

GetRetailerVehicleTrimsResponse>
   </SOAP-ENV:Body>

...


</SOAP-ENV:Envelope>

...

GetAttributeValues

Parameters:

FlagNameTypeDocumentation
InSessionIDAnsiStringCurrent SessionID
InVehicleIDIntegerVehicleID to return values for
InOutValueListvtAttributeValueArray

Attribute values array

C# Syntax:

public Boolean vtVehicleServices.GetAttributeValues(AnsiString SessionID , Int32 VehicleID , ref vtAttributeValueArray ValueList);

SOAP Examples:

Request:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtVehicleServices___GetAttributeValues xmlns:v1="http://tempuri.org/">
         <v1:SessionID>SessionID</v1:SessionID>
         <v1:VehicleID>VehicleID</v1:VehicleID>
         <v1:ValueList>
            <v1:vtAttributeValue>
               <v1:AttributeID>12905</v1:AttributeID>
               <v1:Value />
            </v1:vtAttributeValue>
            <v1:vtAttributeValue>
               <v1:AttributeID>12906</v1:AttributeID>
               <v1:Value />
            </v1:vtAttributeValue>
         </v1:ValueList>
      </v1:vtVehicleServices___GetAttributeValues>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response:

...

JSON Examples:

Code Block
titleRequest
collapsetrue
{
   "version":"1.1",
   "method":"vtVehicleServices.GetRetailerVehicleTrims",
   "params":{
      "SessionId":"SessionID",
      "RetailerId":RetailerID,
      "MakeId":47,
      "ModelId":590,
      "Year":2016,
      "BodyTypeId":7
   }
}
Code Block
titleResponse
collapsetrue
{
   "version":"1.1",
   "result":{
      "TrimList":[
         {
            "TrimLevel":"",
            "VehicleId":"236034"
         }
      ]
   }
}

Anchor
GetAttributeValues
GetAttributeValues
GetAttributeValues

Parameters:

FlagNameTypeDocumentation
InSessionIDAnsiStringCurrent SessionID
InVehicleIDIntegerVehicleID to return values for
InOutValueListvtAttributeValueArray

Attribute values array

C# Syntax:

public Boolean vtVehicleServices.GetAttributeValues(AnsiString SessionID , Int32 VehicleID , ref vtAttributeValueArray ValueList);

SOAP Examples:

Code Block
languagexml
titleRequest
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap

...

.org/soap/envelope/" xmlns:

...

HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...


   <SOAP-ENV:

...

Body xmlns:ro="

...

http://tempuri.org/">
      <v1:vtVehicleServices___GetAttributeValues xmlns:v1="http://tempuri.org/">

...


         <v1:SessionID>SessionID</v1:SessionID>
         <v1:VehicleID>VehicleID</v1:VehicleID>
         <v1:ValueList>
            <v1:vtAttributeValue>
               <v1:AttributeID>12905</v1:AttributeID>

...


               <v1:Value />

...


            </v1:

...

vtAttributeValue>
            <v1:vtAttributeValue>
               <v1:AttributeID>12906</v1:AttributeID>

...


               <v1:Value />

...


            </v1:

...

vtAttributeValue>
         </v1:ValueList>

...


      </v1:vtVehicleServices___

...

GetAttributeValues>
   </SOAP-ENV:Body>

...

GetVehicleIDByVIN

Parameters:

FlagNameTypeDocumentation
InSessionIdAnsiStringCurrent SessionID
InVINAnsiStringVIN number to lookup
OutVehicleIDIntegerMatching Vehicle ID result

C# Syntax:

public void vtVehicleServices.GetVehicleIDByVIN(AnsiString SessionId , AnsiString VIN , out  Int32 VehicleID);

SOAP Examples:

Request:

...


</SOAP-ENV:Envelope>
Code Block
languagexml
titleResponse
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap

...

.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:v1="http://tempuri.org/" xmlns:xsd="http://

...

www.w3.org/2001/XMLSchema" xmlns:

...

xsi="http://www.w3.org/2001

...

/XMLSchema-instance">
   <SOAP-ENV:Header>
      <ROClientIDHeader xmlns="urn:vtVehicles" SOAP-ENV:mustUnderstand="0">
         <ID>{3D3B4BB9-CC13-43DA-A047-A21B1848A4E1}</ID>
      </ROClientIDHeader>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body xmlns:ro="http://

...

tempuri.

...

org

...

/

...

">
      <v1:vtVehicleServices___GetAttributeValuesResponse>
         <v1:Result>true</v1:Result>
         <v1:ValueList>
            <v1:vtAttributeValue>
               <v1:AttributeID>12905</v1:AttributeID>
               <v1:Value />
            </v1:vtAttributeValue>
            <v1:vtAttributeValue>
               <v1:AttributeID>12906</v1:AttributeID>
               <v1:Value />
            </v1:vtAttributeValue>
         </v1:ValueList>
      </v1:vtVehicleServices___

...

GetAttributeValuesResponse>
   </SOAP-ENV:Body>

...


</SOAP-ENV:Envelope>

Response:

...

JSON Examples:

Code Block
titleRequest
collapsetrue
{
   "version":"1.

...

1",
   "method":"vtVehicleServices.GetAttributeValues",
   "params":{
      "SessionID":"SessionID",
      "VehicleID":236034,
      "ValueList":[
         {
            "AttributeID":12905,
            "Value":""
         },
         {
            "AttributeID":12906,
            "Value":""
         }
      ]
   }
}
Code Block
titleResponse
collapsetrue
{
   "version":"1.1",
   "result":{
      "Result":true,
      "ValueList":[
         {
            "AttributeID":"12905",
            "Value":"UNDER DRIVER\u2019S SIDE DASH, NEAR THE PARKING-BRAKE RELEASE"
         },
         {
            "AttributeID":"12906",
            "Value":"12747.PDF"
         }
      ]
   }
}

Anchor
GetVehicleIDByVin
GetVehicleIDByVin
GetVehicleIDByVIN

Parameters:

FlagNameTypeDocumentation
InSessionIdAnsiStringCurrent SessionID
InVINAnsiStringVIN number to lookup
OutVehicleIDIntegerMatching Vehicle ID result

C# Syntax:

public void vtVehicleServices.GetVehicleIDByVIN(AnsiString SessionId , AnsiString VIN , out  Int32 VehicleID);

SOAP Examples:

Code Block
languagexml
titleRequest
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtVehicleServices___GetVehicleIDByVIN xmlns:v1="http://tempuri.org/">
         <v1:SessionId>SessionID</v1:SessionId>
         <v1:VIN>5FNRL5H96EB074997</v1:VIN>
      </v1:vtVehicleServices___GetVehicleIDByVIN>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Code Block
languagexml
titleResponse
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:v1="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Header>
      <ROClientIDHeader xmlns="urn:vtVehicles" SOAP-ENV:mustUnderstand="0">
         <ID>{755EB19F-C325-4436-B430-3E0BEBFF4D7C}</ID>
      </ROClientIDHeader>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtVehicleServices___GetVehicleIDByVINResponse>
         <v1:VehicleID>231832</v1:VehicleID>
      </v1:vtVehicleServices___GetVehicleIDByVINResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

JSON Examples:

Code Block
titleRequest
collapsetrue
{
   "version":"1.1",
   "method":"vtVehicleServices.GetVehicleIDByVIN",
   "params":{
      "SessionId":"SessionID",
      "VIN":"5FNRL5H96EB074997"
   }
}
Code Block
titleResponse
collapsetrue
{
   "version":"1.1",
   "result":{
      "VehicleID":"231832"
   }
}