Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Structs:

vtRetailerVehicleRequest4

FieldData TypeRequiredDocumentation
RetailerIdIntegerYesCompanyID returned from Login
VehicleIdIntegerYesVehicleID returned from VehicleServices selector methods
ProductCategoriesBooleanYesSwitch to return product categories
ProductsBooleanYesSwitch to return products
InstallPartsIntegerYesSwitch to return install parts
ProductCategoryIdAnsiStringNo 
CustomCategoryAnsiStringNo 
ProductAttributesBooleanNoSwitch to return product attributes


vtRetailerVehicleResponse9

FieldData TypeDocumentation
VehicleNameAnsiStringFull Year, Make, Model, Body, Trim description of vehicle
ProductCategoriesvtProductCategory2ArrayArray of product categories
ProductsvtProduct15ArrayArray of products
ImageInformationvtKeyValueArrayArray of Vehicle Images
RadioInformationvtOpeningInformationRadio opening details
SpeakerInformationvtOpeningInformationArrayArray of speaker opening details
InstallPartInformationvtInstallPartInformationArrayArray of install parts

Methods:

GetRetailerVehicleInformation11

Parameters:

FlagNameTypeDocumentation
InSessionIDAnsiStringCurrent SessionID
InRequestvtRetailerVehicleRequest4Input struct, see field descriptions above
OutResponsevtRetailerVehicleResponse9Output struct, see field descriptions above

C# Syntax:

public void vtProductServices.GetRetailerVehicleInformation11(AnsiString SessionId , vtRetailerVehicleRequest4 Request , out vtRetailerVehicleResponse9 Response);

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:Header>
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtProductServices___GetRetailerVehicleInformation11 xmlns:v1="http://tempuri.org/">
         <v1:SessionId>SessionId</v1:SessionId>
         <v1:Request>
            <v1:RetailerId>RetailerId</v1:RetailerId>
            <v1:VehicleId>233562</v1:VehicleId>
            <v1:ProductCategories>false</v1:ProductCategories>
            <v1:Products>true</v1:Products>
            <v1:InstallParts>true</v1:InstallParts>
            <v1:ProductCategoryId>0</v1:ProductCategoryId>
            <v1:CustomCategory />
            <v1:ProductAttributes>true</v1:ProductAttributes>
         </v1:Request>
      </v1:vtProductServices___GetRetailerVehicleInformation11>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response
<?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:vtProductServices___GetRetailerVehicleInformation11Response>
         <v1:Response>
            <v1:FitGuideAttributes />
            <v1:ImageInformation>
               <v1:vtKeyValue>
                  <v1:Key>Radio Image</v1:Key>
                  <v1:Value>12221.PDF</v1:Value>
               </v1:vtKeyValue>
               <v1:vtKeyValue>
                  <v1:Key>Front Speaker Image</v1:Key>
                  <v1:Value>12493.PDF</v1:Value>
               </v1:vtKeyValue>
            </v1:ImageInformation>
            <v1:InstallPartInformation />
            <v1:NoProductFitsMessage />
            <v1:ProductCategories />
            <v1:ProductFitsMessage />
            <v1:Products>
               <v1:vtProduct15>
                  <v1:Active>true</v1:Active>
                  <v1:ApplicationNotes />
                  <v1:AttributeGroups />
                  <v1:AttributeValues />
                  <v1:AvailableInStore>true</v1:AvailableInStore>
                  <v1:AvailableOnline>true</v1:AvailableOnline>
                  <v1:CategoryID>18</v1:CategoryID>
                  <v1:CategoryIds />
                  <v1:CreateDate>12/14/2011 11:10:22 AM</v1:CreateDate>
                  <v1:CustomCategory />
                  <v1:DeletedCategoryIds />
                  <v1:Description>Complete security system with dual-stage shock sensor, 6-tone siren, lock, unlock, trunk release, parking light flash, LED and starter-kill option</v1:Description>
                  <v1:DynamicProductDetails>false</v1:DynamicProductDetails>
                  <v1:EndYear />
                  <v1:FitGuides>true</v1:FitGuides>
                  <v1:Image>32046.jpg</v1:Image>
                  <v1:Instructions>32046.pdf</v1:Instructions>
                  <v1:LargeDescription>Complete security system with dual-stage shock sensor, 6-tone siren, lock, unlock, trunk release, parking light flash, LED and starter-kill option</v1:LargeDescription>
                  <v1:Link>http://www.compustar.com/products/cs/CM1000A_K.html</v1:Link>
                  <v1:ListPrice>0</v1:ListPrice>
                  <v1:Manufacturer>Compustar</v1:Manufacturer>
                  <v1:ManufacturerID>449</v1:ManufacturerID>
                  <v1:MAPPrice>0</v1:MAPPrice>
                  <v1:MSRPPrice>0</v1:MSRPPrice>
                  <v1:OnLanding>false</v1:OnLanding>
                  <v1:OnlinePrice>0</v1:OnlinePrice>
                  <v1:OrderForms>false</v1:OrderForms>
                  <v1:PartNumber>CM1000-A</v1:PartNumber>
                  <v1:ProductAttributeValues />
                  <v1:ProductFeatures />
                  <v1:ProductID>32046</v1:ProductID>
                  <v1:Sizes />
                  <v1:SKU />
                  <v1:SpecialOrder>false</v1:SpecialOrder>
                  <v1:SpecialPrice>0</v1:SpecialPrice>
                  <v1:Specs />
                  <v1:StartYear />
                  <v1:StorePrice>0</v1:StorePrice>
                  <v1:Universal>true</v1:Universal>
                  <v1:UPC />
                  <v1:Updatedate>10/8/2012 11:33:00 AM</v1:Updatedate>
                  <v1:VehicleGuides>true</v1:VehicleGuides>
               </v1:vtProduct15>
               <v1:vtProduct15>
                  <v1:Active>true</v1:Active>
                  <v1:ApplicationNotes />
                  <v1:AttributeGroups />
                  <v1:AttributeValues />
                  <v1:AvailableInStore>true</v1:AvailableInStore>
                  <v1:AvailableOnline>true</v1:AvailableOnline>
                  <v1:CategoryID>148</v1:CategoryID>
                  <v1:CategoryIds />
                  <v1:CreateDate>12/14/2011 11:13:05 AM</v1:CreateDate>
                  <v1:CustomCategory />
                  <v1:DeletedCategoryIds />
                  <v1:Description>Compustar Keyless Entry with lock, unlock, and trunk release features and ultra slim remote</v1:Description>
                  <v1:DynamicProductDetails>false</v1:DynamicProductDetails>
                  <v1:EndYear />
                  <v1:FitGuides>true</v1:FitGuides>
                  <v1:Image>32047.jpg</v1:Image>
                  <v1:Instructions>32047.pdf</v1:Instructions>
                  <v1:LargeDescription />
                  <v1:Link>http://www.compustar.com/products/cs/CM1000A_K.html</v1:Link>
                  <v1:ListPrice>0</v1:ListPrice>
                  <v1:Manufacturer>Compustar</v1:Manufacturer>
                  <v1:ManufacturerID>449</v1:ManufacturerID>
                  <v1:MAPPrice>0</v1:MAPPrice>
                  <v1:MSRPPrice>0</v1:MSRPPrice>
                  <v1:OnLanding>false</v1:OnLanding>
                  <v1:OnlinePrice>0</v1:OnlinePrice>
                  <v1:OrderForms>false</v1:OrderForms>
                  <v1:PartNumber>CM1000-K</v1:PartNumber>
                  <v1:ProductAttributeValues />
                  <v1:ProductFeatures />
                  <v1:ProductID>32047</v1:ProductID>
                  <v1:Sizes />
                  <v1:SKU />
                  <v1:SpecialOrder>false</v1:SpecialOrder>
                  <v1:SpecialPrice>0</v1:SpecialPrice>
                  <v1:Specs />
                  <v1:StartYear />
                  <v1:StorePrice>0</v1:StorePrice>
                  <v1:Universal>true</v1:Universal>
                  <v1:UPC />
                  <v1:Updatedate>10/8/2012 11:32:46 AM</v1:Updatedate>
                  <v1:VehicleGuides>true</v1:VehicleGuides>
               </v1:vtProduct15>
            </v1:Products>
            <v1:RadioInformation>
               <v1:Depth>11</v1:Depth>
               <v1:Link />
               <v1:OpeningName>Car Deck Size</v1:OpeningName>
               <v1:Size>CORPORATE PANEL</v1:Size>
            </v1:RadioInformation>
            <v1:ShowInstallAccessories>true</v1:ShowInstallAccessories>
            <v1:ShowProductFitMessages>false</v1:ShowProductFitMessages>
            <v1:ShowRadioFit>true</v1:ShowRadioFit>
            <v1:ShowSpeakerFit>true</v1:ShowSpeakerFit>
            <v1:SpeakerInformation>
               <v1:vtOpeningInformation>
                  <v1:Depth>4</v1:Depth>
                  <v1:Link />
                  <v1:OpeningName>Front Speaker</v1:OpeningName>
                  <v1:Size>6X9</v1:Size>
               </v1:vtOpeningInformation>
               <v1:vtOpeningInformation>
                  <v1:Depth>2</v1:Depth>
                  <v1:Link />
                  <v1:OpeningName>Front Tweeter</v1:OpeningName>
                  <v1:Size>2.5</v1:Size>
               </v1:vtOpeningInformation>
               <v1:vtOpeningInformation>
                  <v1:Depth>5</v1:Depth>
                  <v1:Link />
                  <v1:OpeningName>Rear Speaker</v1:OpeningName>
                  <v1:Size>6X9</v1:Size>
               </v1:vtOpeningInformation>
            </v1:SpeakerInformation>
            <v1:VehicleExceptionMessage />
            <v1:VehicleName>2015 TOYOTA CAMRY 4DR SEDAN WITH 2.5L ENGINE AND 6-SPEAKER AUDIO SYSTEM</v1:VehicleName>
         </v1:Response>
      </v1:vtProductServices___GetRetailerVehicleInformation11Response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

JSON Examples:

Request
{
   "version":"1.1",
   "method":"vtProductServices.GetRetailerVehicleInformation11",
   "params":{
      "SessionId":"SessionID",
      "Request":{
         "CustomCategory":"",
         "InstallParts":true,
         "ProductAttributes":true,
         "ProductCategories":false,
         "ProductCategoryId":0,
         "Products":true,
         "RetailerId":RetailerID,
         "VehicleId":229513
      }
   }
}
Response
{
   "version":"1.1",
   "result":{
      "Response":{
         "FitGuideAttributes":[
         ],
         "ImageInformation":[
         ],
         "InstallPartInformation":[
         ],
         "NoProductFitsMessage":"",
         "ProductCategories":[
         ],
         "ProductFitsMessage":"",
         "Products":[
            {
               "Active":true,
               "ApplicationNotes":"",
               "AttributeGroups":[
               ],
               "AttributeValues":[
               ],
               "AvailableInStore":true,
               "AvailableOnline":true,
               "CategoryID":"8",
               "CategoryIds":[
               ],
               "CreateDate":"6\/4\/2012 11:53:19 AM",
               "CustomCategory":"",
               "DeletedCategoryIds":[
               ],
               "Description":"06-Up Ford CAN w\/ RAP Acc. & Nav Outputs & Sub Plug",
               "DynamicProductDetails":false,
               "EndYear":"",
               "FitGuides":true,
               "Image":"33376.jpg",
               "Instructions":"33376.pdf",
               "LargeDescription":"Product Details\r\n\r\nProvides accessory (12 volt 10 amp). \r\nRetains R.A.P. (retained accessory power) if equipped. \r\nProvides navigation outputs (reverse\/parking brake\/vehicle speed sense). \r\nUsed in non amplified systems or when removing amplified system. \r\nUSB Updatable and in new case. \r\nProvides subwoofer retention (excludes Sony\/THX sound systems). \r\nProvides harness for ASWC.",
               "Link":"",
               "ListPrice":"0",
               "Manufacturer":"Metra Electronics Corp.",
               "ManufacturerID":"1",
               "MAPPrice":"0",
               "MSRPPrice":"0",
               "OnLanding":false,
               "OnlinePrice":"0",
               "OrderForms":false,
               "PartNumber":"AFDI-5V",
               "ProductAttributeValues":[
               ],
               "ProductFeatures":[
               ],
               "ProductID":"33376",
               "Sizes":[
               ],
               "SKU":"",
               "SpecialOrder":false,
               "SpecialPrice":"0",
               "Specs":[
               ],
               "StartYear":"",
               "StorePrice":"0",
               "Universal":false,
               "UPC":"",
               "Updatedate":"8\/16\/2013 3:01:46 PM",
               "VehicleGuides":true
            }
         ],
         "RadioInformation":{
            "Depth":"10",
            "Link":"",
            "OpeningName":"Car Deck Size",
            "Size":"CORPORATE PANEL"
         },
         "ShowInstallAccessories":true,
         "ShowProductFitMessages":false,
         "ShowRadioFit":true,
         "ShowSpeakerFit":true,
         "SpeakerInformation":[
            {
               "Depth":"3.5",
               "Link":"",
               "OpeningName":"Front Speaker",
               "Size":"6.5"
            },
            {
               "Depth":"3.5",
               "Link":"",
               "OpeningName":"Rear Speaker",
               "Size":"6.5"
            }
         ],
         "VehicleExceptionMessage":"",
         "VehicleName":"2013 FORD FUSION 4DR SEDAN WITH 2.5L ENGINE AND STANDARD AUDIO SYSTEM"
      }
   }
}

GetCompanyProducts2

Parameters:

FlagNameTypeDocumentation
InSessionIdAnsiStringCurrent SessionID
InCompanyIdIntegerCompanyId returned from login
OutProductsvtProduct10ArrayArray of products

C# Syntax:

public void vtProductServices.GetCompanyProducts2(AnsiString SessionId , Int32 CompanyId , out vtProduct10Array Products);

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:vtProductServices___GetCompanyProducts2 xmlns:v1="http://tempuri.org/">
         <v1:SessionId>SessionId</v1:SessionId>
         <v1:CompanyId>CompanyId</v1:CompanyId>
      </v1:vtProductServices___GetCompanyProducts2>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Response
 <?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:vtProductServices___GetCompanyProducts2Response>
         <v1:Products>
            <v1:vtProduct10>
               <v1:Active>false</v1:Active>
               <v1:ApplicationNotes />
               <v1:AttributeGroups />
               <v1:AttributeValues />
               <v1:CategoryID>48</v1:CategoryID>
               <v1:CategoryIds />
               <v1:CreateDate>11/17/2015 9:21:27 PM</v1:CreateDate>
               <v1:DeletedCategoryIds />
               <v1:Description>CompD® 10-Inch (25cm) Subwoofer, Dual Voice Coil, 2-Ohm</v1:Description>
               <v1:DynamicProductDetails>false</v1:DynamicProductDetails>
               <v1:EndYear />
               <v1:FitGuides>false</v1:FitGuides>
               <v1:Image />
               <v1:Instructions />
               <v1:LargeDescription />
               <v1:Link>http://www.kicker.com/compd-10-inch-subwoofer</v1:Link>
               <v1:Manufacturer>Kicker</v1:Manufacturer>
               <v1:ManufacturerID>65</v1:ManufacturerID>
               <v1:MAPPrice>0</v1:MAPPrice>
               <v1:MSRPPrice>0</v1:MSRPPrice>
               <v1:OnLanding>false</v1:OnLanding>
               <v1:OnlinePrice>0</v1:OnlinePrice>
               <v1:OrderForms>false</v1:OrderForms>
               <v1:PartNumber>COMPD10#2</v1:PartNumber>
               <v1:ProductID>42421</v1:ProductID>
               <v1:Sizes />
               <v1:SpecialPrice>0</v1:SpecialPrice>
               <v1:Specs />
               <v1:StartYear />
               <v1:StorePrice>0</v1:StorePrice>
               <v1:Universal>true</v1:Universal>
               <v1:Updatedate>11/17/2015 9:21:27 PM</v1:Updatedate>
               <v1:VehicleGuides>false</v1:VehicleGuides>
            </v1:vtProduct10>
            <v1:vtProduct10>
               <v1:Active>false</v1:Active>
               <v1:ApplicationNotes />
               <v1:AttributeGroups />
               <v1:AttributeValues />
               <v1:CategoryID>48</v1:CategoryID>
               <v1:CategoryIds />
               <v1:CreateDate>11/17/2015 9:21:27 PM</v1:CreateDate>
               <v1:DeletedCategoryIds />
               <v1:Description>CompD® 10-Inch (25cm) Subwoofer, Dual Voice Coil, 4-Ohm</v1:Description>
               <v1:DynamicProductDetails>false</v1:DynamicProductDetails>
               <v1:EndYear />
               <v1:FitGuides>false</v1:FitGuides>
               <v1:Image />
               <v1:Instructions />
               <v1:LargeDescription />
               <v1:Link>http://www.kicker.com/10-comps-subwoofer-4-ohm</v1:Link>
               <v1:Manufacturer>Kicker</v1:Manufacturer>
               <v1:ManufacturerID>65</v1:ManufacturerID>
               <v1:MAPPrice>0</v1:MAPPrice>
               <v1:MSRPPrice>0</v1:MSRPPrice>
               <v1:OnLanding>false</v1:OnLanding>
               <v1:OnlinePrice>0</v1:OnlinePrice>
               <v1:OrderForms>false</v1:OrderForms>
               <v1:PartNumber>COMPD10#4</v1:PartNumber>
               <v1:ProductID>42422</v1:ProductID>
               <v1:Sizes />
               <v1:SpecialPrice>0</v1:SpecialPrice>
               <v1:Specs />
               <v1:StartYear />
               <v1:StorePrice>0</v1:StorePrice>
               <v1:Universal>true</v1:Universal>
               <v1:Updatedate>11/17/2015 9:21:27 PM</v1:Updatedate>
               <v1:VehicleGuides>false</v1:VehicleGuides>
            </v1:vtProduct10>
         </v1:Products>
      </v1:vtProductServices___GetCompanyProducts2Response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

JSON Examples:

 

Request
 {
   "version":"1.1",
   "method":"vtProductServices.GetCompanyProducts2",
   "params":{
      "SessionId":"SessionID",
      "CompanyId":CompanyID
   }
}
Response
 {
   "version":"1.1",
   "result":{
      "Products":[
         {
            "Active":false,
            "ApplicationNotes":"",
            "AttributeGroups":[
            ],
            "AttributeValues":[
            ],
            "CategoryID":"28",
            "CategoryIds":[
            ],
            "CreateDate":"2\/24\/2009 2:33:33 PM",
            "DeletedCategoryIds":[
            ],
            "Description":"Domestic Vehicle Auxiliary Input Interface",
            "DynamicProductDetails":false,
            "EndYear":"",
            "FitGuides":false,
            "Image":"16351.jpg",
            "Instructions":"16351.pdf",
            "LargeDescription":"",
            "Link":"",
            "Manufacturer":"Metra Electronics Corp.",
            "ManufacturerID":"1",
            "MAPPrice":"0",
            "MSRPPrice":"0",
            "OnLanding":false,
            "OnlinePrice":"0",
            "OrderForms":false,
            "PartNumber":"\u0022DISCONTINUED\u0022 XIA-D01",
            "ProductID":"16351",
            "Sizes":[
            ],
            "SpecialPrice":"0",
            "Specs":[
            ],
            "StartYear":"",
            "StorePrice":"0",
            "Universal":false,
            "Updatedate":"6\/2\/2011 10:03:34 AM",
            "VehicleGuides":false
         },
         {
            "Active":false,
            "ApplicationNotes":"",
            "AttributeGroups":[
            ],
            "AttributeValues":[
            ],
            "CategoryID":"28",
            "CategoryIds":[
            ],
            "CreateDate":"2\/25\/2009 8:21:13 AM",
            "DeletedCategoryIds":[
            ],
            "Description":"BMW Harness (w\/Sat tuner) for use with XIA-EU1",
            "DynamicProductDetails":false,
            "EndYear":"",
            "FitGuides":false,
            "Image":"16356.jpg",
            "Instructions":"16356.pdf",
            "LargeDescription":"",
            "Link":"",
            "Manufacturer":"Metra Electronics Corp.",
            "ManufacturerID":"1",
            "MAPPrice":"0",
            "MSRPPrice":"0",
            "OnLanding":false,
            "OnlinePrice":"0",
            "OrderForms":false,
            "PartNumber":"\u0022DISCONTINUED\u0022 XIAH-BM2",
            "ProductID":"16356",
            "Sizes":[
            ],
            "SpecialPrice":"0",
            "Specs":[
            ],
            "StartYear":"",
            "StorePrice":"0",
            "Universal":false,
            "Updatedate":"6\/2\/2011 10:04:56 AM",
            "VehicleGuides":false
         },
         {
            "Active":false,
            "ApplicationNotes":"",
            "AttributeGroups":[
            ],
            "AttributeValues":[
            ],
            "CategoryID":"9",
            "CategoryIds":[
            ],
            "CreateDate":"9\/10\/2014 11:18:20 AM",
            "DeletedCategoryIds":[
            ],
            "Description":"Install Bay YVST8 Spade Terminal Vinyl Connector 12\/10 Gauge #8, Yellow (100-Pack)",
            "DynamicProductDetails":false,
            "EndYear":"",
            "FitGuides":false,
            "Image":"",
            "Instructions":"",
            "LargeDescription":"",
            "Link":"",
            "Manufacturer":"Metra Electronics Corp.",
            "ManufacturerID":"1",
            "MAPPrice":"0",
            "MSRPPrice":"0",
            "OnLanding":false,
            "OnlinePrice":"0",
            "OrderForms":false,
            "PartNumber":"YVST8",
            "ProductID":"38804",
            "Sizes":[
            ],
            "SpecialPrice":"0",
            "Specs":[
            ],
            "StartYear":"",
            "StorePrice":"0",
            "Universal":true,
            "Updatedate":"9\/10\/2014 11:18:20 AM",
            "VehicleGuides":false
         }
      ]
   }
}

 

 

  • No labels