GetPosition - AWS IoT Wireless

GetPosition

Get the position information for a given resource.

Request Syntax

GET /positions/ResourceIdentifier?resourceType=ResourceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ResourceIdentifier

Resource identifier used to retrieve the position information.

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Required: Yes

ResourceType

Resource type of the resource for which position information is retrieved.

Valid Values: WirelessDevice | WirelessGateway

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Accuracy": { "HorizontalAccuracy": number, "VerticalAccuracy": number }, "Position": [ number ], "SolverProvider": "string", "SolverType": "string", "SolverVersion": "string", "Timestamp": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Accuracy

The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

Type: Accuracy object

Position

The position information of the resource.

Type: Array of floats

SolverProvider

The vendor of the positioning solver.

Type: String

Valid Values: Semtech

SolverType

The type of solver used to identify the position of the resource.

Type: String

Valid Values: GNSS

SolverVersion

The version of the positioning solver.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50.

Timestamp

The timestamp at which the device's position was determined.

Type: String

Pattern: ^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: