GetCoordinatesDetailed (...)

Introduction

Geocodes or looks up the latitude and longitude from a list of addresses, returning one result per input address with an explicit GeocodeStatus so callers can distinguish an address that was not found from one that was rejected for exceeding the provider's input length limit, or that could not be resolved due to a transient provider failure. Results are returned in input order and a single rejected or failed address never fails the rest of the batch.

When MapBox is the configured geocoder, each address is limited to 20 search tokens. Addresses exceeding that limit are not looked up and return InputTooLong with a null coordinate; a transient provider failure (rate limit, timeout) for an address returns Unknown — not NotFound — since the address may resolve on retry. Use this method instead of WebMethods.GetCoordinatesAsync when you need to act on individual per-address outcomes; GetCoordinates returns null for both "not found" and "input rejected" and remains unchanged.

Parameters

The formatted addresses in an array of String(s).

The user's Geotab login credentials.

Return value

The array of CoordinateDetailed(s), one per input address in input order. Empty when addresses is empty; when no geocoder is available for the addresses, one Unknown result per input address is returned (order preserved). CoordinateDetailed.coordinate is null when CoordinateDetailed.status is not Ok.

Code samples

Rate limits

Method	Description	Limit	Period
GetCoordinatesDetailed	Limit of 300 requests per 1m.	300	1m

Loading API Runner...