{ "swagger": "2.0", "info": { "version": "1.0.485.7354", "title": "NADAService", "description": "Delivers valuation data for used vehicles" }, "host": "apitest.microbilt.com", "basePath": "/NADAVehiclePricing", "schemes": [ "https" ], "paths": { "/GetStates": { "get": { "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] } ], "responses": { "default": { "description": "GetStates", "schema": { "$ref": "#/definitions/StateCollection" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetYears": { "get": { "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] } ], "responses": { "default": { "description": "GetYears", "schema": { "$ref": "#/definitions/YearCollection" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetMake": { "get": { "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "year", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "default": { "description": "GetMake", "schema": { "$ref": "#/definitions/MakeCollection" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetSeries": { "get": { "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "year", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "make", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "default": { "description": "GetSeries", "schema": { "$ref": "#/definitions/SeriesCollection" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetBody": { "get": { "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "year", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "make", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "series", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "default": { "description": "GetBody", "schema": { "$ref": "#/definitions/BodiesCollection" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetReport": { "post": { "parameters": [ { "name": "Content-Type", "description": "Specifies the format of the request", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml", "text/html" ] }, { "name": "body", "in": "body", "description": "payload", "required": true, "schema": { "$ref": "#/definitions/NADAMessageRq" }, "x-example": { "application/json": [ { "name": "JSON request example", "body": "{\"AutomobileInfo\":{\"Make\":\"47\",\"RegState\":\"6\",\"VIN\":\"19UYA31581L000000\",\"Series\":\"890\",\"ModelYear\":\"2005\"},\"Period\":\"2018-04-05\",\"UID\":\"1129413\",\"Mileage\":\"275000\"}" } ], "application/xml": [ { "name": "XML request example", "body": "47619UYA31581L00000089020052018-04-051129413275000" } ] } } ], "responses": { "default": { "description": "GetReport", "schema": { "$ref": "#/definitions/NADAMessageRs" } } }, "security": [ { "oauth": [ ] } ] } }, "/GetArchiveReport": { "get": { "parameters": [ { "name": "Accept", "description": "Specifies the format of the response", "in": "header", "required": true, "type": "string", "enum": [ "application/json", "application/xml", "text/html" ] }, { "name": "AppId", "required": true, "in": "query", "type": "string" } ], "responses": { "default": { "description": "GetArchiveReport", "schema": { "$ref": "#/definitions/NADAMessageRs" } } }, "security": [ { "oauth": [ ] } ] } } }, "securityDefinitions": { "oauth": { "type": "oauth2", "authorizationUrl": "https://apitest.microbilt.com/OAuth/GetAccessToken?grant_type=client_credentials", "tokenUrl": "https://apitest.microbilt.com/OAuth/GetAccessToken?grant_type=client_credentials", "flow": "accessCode", "scopes": { } } }, "definitions": { "StateCollection": { "type": "object", "properties": { "States": { "type": "array", "items": { "$ref": "#/definitions/IdNameType" } } } }, "IdNameType": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "YearCollection": { "type": "object", "properties": { "Year": { "type": "array", "items": { "type": "string" } } } }, "MakeCollection": { "type": "object", "properties": { "Makes": { "type": "array", "items": { "$ref": "#/definitions/IdNameType" } } } }, "SeriesCollection": { "type": "object", "properties": { "Series": { "type": "array", "items": { "$ref": "#/definitions/IdNameType" } } } }, "BodiesCollection": { "type": "object", "properties": { "Bodies": { "type": "array", "items": { "$ref": "#/definitions/IdNameType" } } } }, "NADAMessageRq": { "type": "object", "properties": { "AutomobileInfo": { "$ref": "#/definitions/AutomobileInfo" }, "Period": { "type": "string", "format": "date-time", "example": "2018-04-05", "description": "" }, "UID": { "type": "string", "example": "1129413", "description": "Vehicle Unique Identification Number" }, "Mileage": { "type": "string", "example": "275000", "description": "The distance the vehicle has covered in its lifetime" } } }, "AutomobileInfo": { "type": "object", "properties": { "Make": { "type": "string", "example": "47", "description": "Vehicle Make" }, "RegState": { "type": "string", "example": "6", "description": "Registration State" }, "VIN": { "type": "string", "example": "19UYA31581L000000", "description": "Vehicle Identification Number composed of 17 characters" }, "Series": { "type": "string", "example": "890", "description": "Brand of the car" }, "ModelYear": { "type": "string", "example": "2005", "description": "Vehicle Model Year" } } }, "CurrencyAmount": { "type": "object", "properties": { "Amt": { "type": "string" }, "CurCode": { "type": "string" } } }, "NADAMessageRs": { "type": "object", "properties": { "MsgRsHdr": { "$ref": "#/definitions/MsgRsHdr" }, "RefNum": { "type": "string" }, "AutomobileInfo": { "$ref": "#/definitions/AutomobileInfo" }, "MSRPAmt": { "$ref": "#/definitions/CurrencyAmount" }, "TradeInAmt": { "$ref": "#/definitions/CurrencyAmount" }, "RetailValueAmt": { "$ref": "#/definitions/CurrencyAmount" }, "LoanValueAmt": { "$ref": "#/definitions/CurrencyAmount" }, "UID": { "type": "string" }, "Mileage": { "type": "string" }, "VAC": { "type": "array", "items": { "$ref": "#/definitions/VAC" } }, "Auction": { "$ref": "#/definitions/Auction" }, "Text": { "type": "array", "items": { "type": "string" } } } }, "MsgRsHdr": { "type": "object", "properties": { "RqUID": { "type": "string" }, "Status": { "$ref": "#/definitions/Status" } } }, "Status": { "type": "object", "properties": { "StatusCode": { "type": "integer", "format": "int64" }, "ServerStatusCode": { "type": "string" }, "Severity": { "type": "string", "enum": [ 0, 1, 2 ], "x-enumNames": [ "Error", "Warn", "Info" ] }, "StatusDesc": { "type": "string" }, "AdditionalStatus": { "type": "array", "items": { "$ref": "#/definitions/AdditionalStatus" } } } }, "AdditionalStatus": { "type": "object", "properties": { "StatusCode": { "type": "integer", "format": "int64" }, "ServerStatusCode": { "type": "string" }, "Severity": { "type": "string", "enum": [ 0, 1, 2 ], "x-enumNames": [ "Error", "Warn", "Info" ] }, "StatusDesc": { "type": "string" } } }, "VAC": { "type": "object", "properties": { "SelectionStatus": { "type": "string" }, "Description": { "type": "string" }, "Trade": { "type": "string" }, "Loan": { "type": "string" }, "Retail": { "type": "string" }, "VACCode": { "type": "string" } } }, "Auction": { "type": "object", "properties": { "LowAdjustedAuctionValue": { "type": "integer", "format": "int32" }, "AverageAdjustedAuctionValue": { "type": "integer", "format": "int32" }, "HighAdjustedAuctionValue": { "type": "integer", "format": "int32" }, "DateRange": { "type": "string" }, "AccessoriesAdjustedList": { "type": "array", "items": { "$ref": "#/definitions/AdjustedAccessories" } }, "Error": { "type": "string" } } }, "AdjustedAccessories": { "type": "object", "properties": { "AccCode": { "type": "string" }, "AccDesc": { "type": "string" } } } } }