woosmap-sdk/com.woosmap.sdk.api.distance/DistanceStatus

DistanceStatus

enum DistanceStatus : Enum<DistanceStatus>

Returns more info on if the request was successful or not. * OK indicates the response contains a valid result. * INVALID_REQUEST indicates that the provided request was invalid (e.g. wrong URL syntax). * MAX_ELEMENTS_EXCEEDED indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q). * MAX_ROUTE_LENGTH_EXCEEDED indicates that at least one of requested route is too long and the matrix cannot be processed (>500km). * REQUEST_DENIED indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, …). * BACKEND_ERROR indicates a Distance API request could not be processed due to a server error. This may indicate that the origin and/or destination of this pairing could not be matched to the network. The request may or may not succeed if you try again. * OVER_QUERY_LIMIT (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the usage limits

Values: oK,iNVALIDREQUEST,mAXELEMENTSEXCEEDED,mAXROUTELENGTHEXCEEDED,rEQUESTDENIED,bACKENDERROR,oVERQUERYLIMIT

Entries

Link copied to clipboard
@SerializedName(value = "OK")
Ok
Link copied to clipboard
@SerializedName(value = "INVALID_REQUEST")
InvalidRequest
Link copied to clipboard
@SerializedName(value = "MAX_ELEMENTS_EXCEEDED")
MaxElementsExceeded
Link copied to clipboard
@SerializedName(value = "MAX_ROUTE_LENGTH_EXCEEDED")
MaxRouteLengthExceeded
Link copied to clipboard
@SerializedName(value = "REQUEST_DENIED")
RequestDenied
Link copied to clipboard
@SerializedName(value = "BACKEND_ERROR")
BackendError
Link copied to clipboard
@SerializedName(value = "OVER_QUERY_LIMIT")
OverQueryLimit

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val entries: EnumEntries<DistanceStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
val value: String

Functions

Link copied to clipboard
open override fun toString(): String

Override toString() to avoid using the enum variable name as the value, and instead use the actual value defined in the API spec file.

Link copied to clipboard
fun valueOf(value: String): DistanceStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard
fun values(): Array<DistanceStatus>

Returns an array containing the constants of this enum type, in the order they're declared.