VehicleXchange Web API Help Page

Account

API	Description
POST api/account/create-account	No documentation available.
POST api/account/validate-account	No documentation available.
POST api/account/change-password	No documentation available.
POST api/account/sso	No documentation available.
POST api/account/simulate-session	No documentation available.

Customer

API	Description
GET api/customer/details/{id}?prospectid={prospectid}&prospect={prospect}	No documentation available.
GET api/customer/authorize/{id}?zipcode={zipcode}&pin={pin}&simulated={simulated}&recordtype={recordtype}&recordid={recordid}&dealershipid={dealershipid}&dealer={dealer}	No documentation available.
GET api/customer/user-settings/{id}?zipcode={zipcode}&pin={pin}&simulated={simulated}&recordtype={recordtype}&recordid={recordid}&dealershipid={dealershipid}&dealer={dealer}	No documentation available.
GET api/customer/favorites?prospectid={prospectid}&prospect={prospect}	No documentation available.
GET api/customer/owned-vehicles?prospectid={prospectid}&prospect={prospect}	No documentation available.
GET api/customer/summary/{id}?prospectid={prospectid}&prospect={prospect}	No documentation available.
GET api/customer/qualifications	No documentation available.
POST api/customer/send-adf	No documentation available.
POST api/customer/add-favorite	No documentation available.
POST api/customer/remove-favorite	No documentation available.
POST api/customer/add-owned-vehicle	No documentation available.
POST api/customer/remove-owned-vehicle	No documentation available.
GET api/customer/settings?prospect={prospect}&prospectid={prospectid}	No documentation available.
GET api/customer/messages?prospect={prospect}&prospectid={prospectid}	No documentation available.
POST api/customer/messages-read	No documentation available.
GET api/customer/locked-vehicles?prospectid={prospectid}&prospect={prospect}	No documentation available.
POST api/customer/lock-vehicle	No documentation available.
POST api/customer/unlock-vehicle	No documentation available.
POST api/customer/update-prospect	No documentation available.
POST api/customer/opt-out	No documentation available.
POST api/customer/resend-pin	No documentation available.
POST api/customer/prospect-info	No documentation available.

Dealer

API	Description
GET api/dealer/get-sms-alert-distribution?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/get-user-manage-sms-profile?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/update-sms-alert-distribution	No documentation available.
GET api/dealer/get-default-campaign-settings?dealer={dealer}&dealershipid={dealershipid}	No documentation available.
POST api/dealer/send-sms-alert	No documentation available.
GET api/dealer/get-user-alert-distribution?userid={userid}&dealershipid={dealershipid}&dealer={dealer}	No documentation available.
POST api/dealer/update-user-alert-distribution	No documentation available.
GET api/dealer/get-dealer-alert-distribution?dealershipid={dealershipid}&dealer={dealer}	No documentation available.
POST api/dealer/update-dealer-alert-distribution	No documentation available.
POST api/dealer/get-performance-report-daterange	No documentation available.
POST api/dealer/get-dealer-performance-report	No documentation available.
GET api/dealer/get-dealer-performance-manager?userid={userid}&dealershipid={dealershipid}&dealer={dealer}	No documentation available.
GET api/dealer/get-show-propensity?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/consumer-transfer	No documentation available.
POST api/dealer/get-make-models	No documentation available.
GET api/dealer/prospect-statistics?dealer={dealer}&dealershipid={dealershipid}&from={from}&to={to}&purpose={purpose}	No documentation available.
POST api/dealer/remote-login	No documentation available.
POST api/dealer/authenticate	No documentation available.
POST api/dealer/change-store	No documentation available.
GET api/dealer/stores	No documentation available.
GET api/dealer/user-settings?userid={userid}&dealer={dealer}&dealershipid={dealershipid}	No documentation available.
GET api/dealer/contact-info?dealershipid={dealershipid}&dealer={dealer}&name={name}&status={status}&city={city}&state={state}&zipcode={zipcode}&primarycontactname={primarycontactname}&primarycontactemail={primarycontactemail}&defaultworkflowcode={defaultworkflowcode}	No documentation available.
POST api/dealer/send-adf	No documentation available.
POST api/dealer/add-contact-info	No documentation available.
GET api/dealer/vendor-info?vendorid={vendorid}&status={status}&name={name}&vendortype={vendortype}&city={city}&state={state}&zipcode={zipcode}&primarycontactname={primarycontactname}&primarycontactemail={primarycontactemail}	No documentation available.
POST api/dealer/add-vendor-info	No documentation available.
GET api/dealer/dashboard?dealershipid={dealershipid}&dealer={dealer}&campaignid={campaignid}&salespersonid={salespersonid}&asofdate={asofdate}	No documentation available.
POST api/dealer/pre-approvals	No documentation available.
GET api/dealer/get-tier-description?dealershipid={dealershipid}&dealer={dealer}	No documentation available.
POST api/dealer/hotsheet-details	No documentation available.
GET api/dealer/actionable-leads?dealershipid={dealershipid}&dealer={dealer}&campaignid={campaignid}&leadcategory={leadcategory}&leadsource={leadsource}&leadsourcenumber={leadsourcenumber}&listactionable={listactionable}&listhotleads={listhotleads}&listnotprocessed={listnotprocessed}&haslockedvehicle={haslockedvehicle}&lastlogindatefrom={lastlogindatefrom}&lastlogindateto={lastlogindateto}&searchdatefrom={searchdatefrom}&searchdateto={searchdateto}&userid={userid}	No documentation available.
POST api/dealer/not-processed	No documentation available.
POST api/dealer/prospect-list-filtered	No documentation available.
GET api/dealer/hot-leads?dealershipid={dealershipid}&dealer={dealer}&campaignid={campaignid}&leadcategory={leadcategory}&leadsource={leadsource}&leadsourcenumber={leadsourcenumber}&listactionable={listactionable}&listhotleads={listhotleads}&listnotprocessed={listnotprocessed}&haslockedvehicle={haslockedvehicle}&lastlogindatefrom={lastlogindatefrom}&lastlogindateto={lastlogindateto}&searchdatefrom={searchdatefrom}&searchdateto={searchdateto}&userid={userid}	No documentation available.
POST api/dealer/lead-status	No documentation available.
GET api/dealer/pricing-profile?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/customer-status	No documentation available.
POST api/dealer/customer-note	No documentation available.
POST api/dealer/update-do-not-call-status	No documentation available.
POST api/dealer/update-do-not-email-status	No documentation available.
POST api/dealer/sales-person	No documentation available.
POST api/dealer/hot-lead	No documentation available.
GET api/dealer/inventory?dealershipid={dealershipid}&dealer={dealer}	No documentation available.
GET api/dealer/messages?dealer={dealer}&dealerid={dealerid}	No documentation available.
POST api/dealer/messages-read	No documentation available.
POST api/dealer/update-prospect	No documentation available.
POST api/dealer/update-dealer-value	No documentation available.
POST api/dealer/list-opt-campaigns	No documentation available.
POST api/dealer/update-opt-campaign	No documentation available.
POST api/dealer/list-dealer-incentives	No documentation available.
POST api/dealer/get-market-counts	No documentation available.
POST api/dealer/check-prospect	No documentation available.
POST api/dealer/prequal-customer	No documentation available.
POST api/dealer/update-opt-running-campaign	No documentation available.
POST api/dealer/search-prospect	No documentation available.
GET api/dealer/search-hints?searchtype={searchtype}&searchstring={searchstring}&dealer={dealer}&dealershipid={dealershipid}&userid={userid}&searchlimit={searchlimit}	No documentation available.
POST api/dealer/search-customer	No documentation available.
GET api/dealer/allow-add-customer?dealer={dealer}	No documentation available.
GET api/dealer/allow-customer-prescreen?dealer={dealer}	No documentation available.
GET api/dealer/experian-terms-conditions?dealer={dealer}	No documentation available.
GET api/dealer/search-globally?searchfield={searchfield}&searchstring={searchstring}&dealer={dealer}&prospect={prospect}&prospectid={prospectid}&loggedinuserid={loggedinuserid}&dealershipid={dealershipid}	No documentation available.
GET api/dealer/search-by-hints?searchtype={searchtype}&dealer={dealer}&firstname={firstname}&lastname={lastname}&searchstringfull={searchstringfull}&loggedinuserid={loggedinuserid}&dealershipid={dealershipid}	No documentation available.
GET api/dealer/hotsheet-summary?dealershipid={dealershipid}&dealer={dealer}&asofdate={asofdate}	No documentation available.
GET api/dealer/hotsheet-prospects?dealershipid={dealershipid}&dealer={dealer}&leadsource={leadsource}&processstatus={processstatus}&type={type}&value={value}&dailyhotsheetid={dailyhotsheetid}	No documentation available.
GET api/dealer/sessions	No documentation available.
GET api/dealer/allow-export?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/experian-loan?prospectid={prospectid}&customerid={customerid}&prospect={prospect}	No documentation available.
POST api/dealer/create-work-deal-lead	No documentation available.
POST api/dealer/get-work-deal-lead-list	No documentation available.
POST api/dealer/get-work-deal-lead	No documentation available.
POST api/dealer/modify-lead-notes	No documentation available.
POST api/dealer/get-notes-for-lead	No documentation available.
POST api/dealer/set-workdeal-batch-process	No documentation available.
GET api/dealer/get-show-work-deal?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/send-adf-lead	No documentation available.
GET api/dealer/call-for-availability?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/display-customer-apr?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/manage-cdk-crm-users?apikey={apikey}	No documentation available.
POST api/dealer/get-dealership-limiters	No documentation available.
POST api/dealer/get-dealerusers-limit	No documentation available.
POST api/dealer/manage-dealer-limiters	No documentation available.
POST api/dealer/manage-user-limits	No documentation available.
POST api/dealer/manage-dealer-limiters-age-defaults	No documentation available.
GET api/dealer/get-percentfield-types?dealership={dealership}	No documentation available.
GET api/dealer/has-srx-limiter?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/has-modify-srx-limiter?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/has-expiring-lease-campaign?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/tracker-url?prospect={prospect}&prospectid={prospectid}&dealership={dealership}&dealershipid={dealershipid}&emailaddress={emailaddress}&source={source}	No documentation available.
GET api/dealer/email-template-list?dealer={dealer}&prospect={prospect}&template={template}&dealershipid={dealershipid}&prospectid={prospectid}	No documentation available.
POST api/dealer/email-template-html	No documentation available.
GET api/dealer/get-email-profile?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/get-lease-calculation-profile?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/save-conquest-campaign	No documentation available.
POST api/dealer/get-conquest-count	No documentation available.
GET api/dealer/infobahn-uploads?dealer={dealer}	No documentation available.
POST api/dealer/save-infobahn-campaign	No documentation available.
POST api/dealer/get-infobahn-campaign-data	No documentation available.
GET api/dealer/has-infobahn?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/get-infobahn-model-list?lockid={lockid}	No documentation available.
POST api/dealer/get-sales-count	No documentation available.
POST api/dealer/update-profileoptions	No documentation available.
GET api/dealer/display-mapping?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/display-user-administration?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/dealer-users	No documentation available.
POST api/dealer/user-dealers	No documentation available.
POST api/dealer/get-user-mappings	No documentation available.
POST api/dealer/add-user-mappings	No documentation available.
POST api/dealer/update-user	No documentation available.
POST api/dealer/create-user	No documentation available.
POST api/dealer/update-user-mapping	No documentation available.
POST api/dealer/update-userdealers	No documentation available.
POST api/dealer/reset-password	No documentation available.
GET api/dealer/get-exp-lease-dropdown?dealer={dealer}&dealershipid={dealershipid}	No documentation available.
GET api/dealer/get-exp-lease-model-list?dealer={dealer}&dealershipid={dealershipid}&makeid={makeid}	No documentation available.
POST api/dealer/create-expiring-lease-campaign	No documentation available.
POST api/dealer/get-expiring-lease-count-data	No documentation available.
POST api/dealer/get-lease-vehicle-count-data	No documentation available.
GET api/dealer/check-auto-mapping-leads?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/check-round-robin-distribution?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/get-service-lead-assignment?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
GET api/dealer/view-unassigned-leads?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.
POST api/dealer/update-round-robin-distribution	No documentation available.
POST api/dealer/update-auto-mapping-leads	No documentation available.
POST api/dealer/update-service-lead-assignment-flag	No documentation available.
POST api/dealer/update-view-unassigned-leads	No documentation available.
POST api/dealer/get-leads-distribution	No documentation available.
POST api/dealer/update-lead-distribution	No documentation available.
POST api/dealer/get-user-assignments	No documentation available.
POST api/dealer/reassign-user-assignments	No documentation available.
POST api/dealer/get-user-and-campaign-types	No documentation available.
GET api/dealer/get-batch-crm-profile?optioncode={optioncode}&userid={userid}&dealershipid={dealershipid}&groupid={groupid}&dealer={dealer}	No documentation available.

Reports

API	Description
POST api/reports/get-all-service-filters	No documentation available.
POST api/reports/get-all-sales-filters	No documentation available.
POST api/reports/save-service-filter	No documentation available.
POST api/reports/save-sales-filter	No documentation available.
POST api/reports/remove-filter	No documentation available.
POST api/reports/get-service-equity	No documentation available.
POST api/reports/get-sales-equity	No documentation available.
POST api/reports/get-equity-details	No documentation available.
POST api/reports/get-optin-roi-summary	No documentation available.
POST api/reports/get-optin-roi-details	No documentation available.
POST api/reports/get-optin-roi-custom-details	No documentation available.
POST api/reports/get-service-roi-summary	No documentation available.
POST api/reports/get-service-roi-detail	No documentation available.
POST api/reports/get-campaign-stats	No documentation available.
POST api/reports/get-performance-report	No documentation available.
POST api/reports/get-campaign-performance-report	No documentation available.

Utilities

API	Description
GET api/utilities/alg-adjustments	No documentation available.
GET api/utilities/get-current-date-and-time	No documentation available.
GET api/utilities/chat-support	No documentation available.
POST api/utilities/email	No documentation available.
POST api/utilities/email-details	No documentation available.
GET api/utilities/upload-policy?mimetype={mimetype}&successcode={successcode}	No documentation available.
GET api/utilities/letter-screenshot?prospectid={prospectid}&userid={userid}&prospect={prospect}&referrerbaseurl={referrerbaseurl}	No documentation available.
GET api/utilities/letter-html?prospectid={prospectid}&userid={userid}&prospect={prospect}&referrerbaseurl={referrerbaseurl}	No documentation available.
GET api/utilities/d-a?de={de}	No documentation available.
POST api/utilities/get-email-log	No documentation available.
POST api/utilities/infobahn-file?dealer={dealer}	No documentation available.

Vehicle

API	Description
GET api/vehicle/details?vin={vin}&chromestyleid={chromestyleid}&dealershipid={dealershipid}&dealer={dealer}&imagesonly={imagesonly}	No documentation available.
GET api/vehicle/describe?vin={vin}&miles={miles}&uvc={uvc}	No documentation available.
POST api/vehicle/default-image	No documentation available.
GET api/vehicle/reviews?make={make}&model={model}&year={year}	No documentation available.
GET api/vehicle/makes?yearid={yearid}&makeid={makeid}&modelid={modelid}&styleid={styleid}&chromestyleid={chromestyleid}	No documentation available.
GET api/vehicle/models?yearid={yearid}&makeid={makeid}&modelid={modelid}&styleid={styleid}&chromestyleid={chromestyleid}	No documentation available.
GET api/vehicle/bodystyles?yearid={yearid}&makeid={makeid}&modelid={modelid}&styleid={styleid}&chromestyleid={chromestyleid}	No documentation available.