Api documentation

Api documentation
API Console

Find Franchise by ID

Details and Location
 
 
v2 v1
 
 
Overview  
api/dealer/v2/franchises/{franchiseId} 
 
 

Response format

JSON Response w/ view=basic (default)

{
    "franchiseId": {string},
    "dealerId": {string},
    "name": {string},
    "niceName": {string},
    "address": {
        "street": {string},
        "apartment": {string},
        "city": {string},
        "stateCode": {string},
        "stateName": {string},
        "county": {string},
        "country": {string},
        "latitude": {double},
        "longitude": {double},
        "zipcode": {string}
    },
    "make": {
        "name": {string},
        "niceName": {string}
    },
    "contactInfo": {
        "phone": {string},
        "website": {string}
    },
    "active": {boolean},
    "state": {string},
    "type": {string}
}
Property Description Visibility
franchiseId The franchise ID Edmunds, Partners, Public
dealerId The dealer location ID Edmunds, Partners, Public
name The franchise name Edmunds, Partners, Public
niceName The franchise logical name Edmunds, Partners, Public
address The address for the franchise Edmunds, Partners, Public
active Indicates that the franchise is active Edmunds, Partners, Public
make The make supported by the franchise Edmunds, Partners, Public
contactInfo The franchise contact info Edmunds, Partners, Public
state The vehicle state the franchise works with Edmunds, Partners, Public
type The dealer location type Edmunds, Partners, Public

JSON Response w/ view=full

{
    "dealerId": {string},
    "name": {string},
    "niceName": {string},
    "operations": {
        "Wednesday": {string},
        "Thursday": {string},
        "Tuesday": {string},
        "Saturday": {string},
        "Friday": {string},
        "Monday": {string},
        "Sunday": {string}
    },
    "address": {
        "street": {string},
        "apartment": {string},
        "city": {string},
        "stateCode": {string},
        "stateName": {string},
        "county": {string},
        "country": {string},
        "latitude": {double},
        "longitude": {double},
        "zipcode": {string}
    },
    "make": {
        "name": {string},
        "niceName": {string}
    },
    "contactInfo": {
        "phone": {string},
        "website": {string}
    },
    "active": {boolean},
    "franchiseId": {string},
    "contactInfo": {
        "phone": {string},
        "website": {string}
    },
    "state": {string},
    "type": {string}
}
Property Description Visibility
franchiseId The franchise ID Edmunds, Partners, Public
dealerId The dealer location ID Edmunds, Partners, Public
name The franchise name Edmunds, Partners, Public
niceName The franchise logical name Edmunds, Partners, Public
operations The list of operations Edmunds, Partners, Public
address The address for the franchise Edmunds, Partners, Public
active Indicates that the franchise is active Edmunds, Partners, Public
make The make supported by the franchise Edmunds, Partners, Public
contactInfo The franchise contact info Edmunds, Partners, Public
state The vehicle state the franchise works with Edmunds, Partners, Public
type The dealer location type Edmunds, Partners, Public
Previous Next