Documentation

 

VINfix Web Service API


The VINfix Web Service merely produces one or multiple suggestions when a problem VIN is submitted. It's up to end users(human being) to make the final decision: which suggestion to take or no suggestion would be taken at all. Therefore, any kind of batch processing without any human involvement is not recommmended.

Do Not Send The Same VIN More Than Once

Our system will take one credit off from your account balance when XML resuslt is returned regardless of what the result turns out to be. So please be sure to have a mechanism in place in your system to prevent the same VIN from being sent to the web service more than once.

 

REST API Description

The VINfix Web Service provides programmatic access to two of our state-of-the-art machine learning algorithms.

Parameter Name Parameter Value Used in URL
API Key accesscode xxxxx-xxxxx-xxxxx-xxxxx GET http://www.recognition.ws/vinfix/v1?accesscode=xxxxx-xxxxx-xxxxx-xxxxx&vin=XXXXXXXXXXXXXXXXX
Vehicle Identification Number vin XXXXXXXXXXXXXXXXX GET http://www.recognition.ws/vinfix/v1?accesscode=xxxxx-xxxxx-xxxxx-xxxxx&vin=XXXXXXXXXXXXXXXXX

Output in XML

The VINfix Web Service produces suggestions made by two machine learning algorithms: Algorithm 1 and Algorithm 2.

  • Algorithm 1 and Algorithm 2 don't always agree with each other;
  • Algorithm 1 usually produces more accurate suggestions than Algorithm 2 does;
  • Algorithm 1 always produces at least one suggestion;
  • Algorithm 1 usually produces only one suggestion;
  • Algorithm 2 often produces more than one suggestions;
  • Algorithm 2 could produce no suggestions at all.
  • It is recommended that the suggestions from Algorithm 2 should be hidden from end-users by default unless the suggestions from Algorithm 1 were not satifactory and a second opion was needed.
        
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
<VINfix Date="4/22/2015" Version="1.0.0" Status="SUCCESS" Number="XXXXXXXXXXX123456>
    <Algorithm1>
	<Item Value="XXXXXXXXXXX123456" Key="Suggestion1"/>
        <Item Value="..." Key="..."/>
        <Item Value="XXXXXXXXXXX123456" Key="SuggestionM"/>
    </Algorithm1>
    <Algorithm2>
       <Item Value="XXXXXXXXXXX123456" Key="Suggestion1"/>
       <Item Value="..." Key="..."/>
       <Item Value="XXXXXXXXXXX123456" Key="SuggestionN"/>
    </Algorithm2>
</VINfix>
        
    

Error Codes

Error Code (Key) Description (Value)
0 Database Errors.
17 Insufficient balance for VINfix
18 Length of VIN too short for VINfix; It must be at least 10 digits.
19 Invalid VIN number: The last 4 digits of this VIN number must all be numeric.
20 Invalid VIN number: The last 6 digits of this VIN number must all be numeric.
21 Invalid VIN number: The 12th digit of this VIN number must be a letter.
22 Invalid VIN number: The 13th digit of this VIN number must be a letter.
28 VINfix data model not ready.
        
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<VINfix version="1.0.0" Date="5/28/2015 1:39:10 PM" Status="FAILED">
  <Message Key="0" Value="Database Errors." />
</VINfix>