HomeGuides
Submit Documentation FeedbackJoin Developer CommunityLog In

Dealers

This topic describes the Dealers API handler.

HTTP Verb: GET

URL: /api/v1/dealers

Description: Returns a collection of dealers

Base: HandlerBase<GetDealerCollectionParameter, GetDealerCollectionResult>

Handlers:

OrderHandlerDescription
500GetCoordinatesSets Latitude, Longitude and Radius properties in the result object.
600GetDealersCountRetrieves dealers count using DealerRepository. The dealers count is stored in the TotalCount property in the result object.
700GetDealersIf DealerId parameter has a value, retrieves a dealers by DealersId parameter. Otherwise retrieves a dealers using DealerRepository by coordinates. The dealers are stored in the DealerDtos property in the result object.
800CreateGetDealerResultsRetrieves HtmlContent for each dealer. Copy custom properties to each dealer object. Create GetDealerResults from DealerDtos and stored it in the GetDealerResults property in the result object. Also find DistanceUnitOfMeasure and stored it in the DistanceUnitOfMeasure property in the result object.

HTTP Verb: GET

URL: /api/v1/dealers/{dealerId}

Description: Returns a single dealer record

Base: HandlerBase<GetDealerParameter, GetDealerResult>

Handlers:

OrderHandlerDescription
500GetDealerRetrieves a dealer by DealerId parameter using GetDealerCollectionHandler handler chain. The dealer is stored in the Dealer property in the result object.

Did this page help you?