BatchGetDevicePosition - Amazon Location Service

BatchGetDevicePosition

Lists the latest device positions for requested devices.

Request Syntax

POST /tracking/v0/trackers/TrackerName/get-positions HTTP/1.1 Content-type: application/json { "DeviceIds": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

TrackerName

The tracker resource retrieving the device position.

Length Constraints: Minimum length of 1.

Pattern: ^[-._\w]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

DeviceIds

Devices whose position you want to retrieve.

  • For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\p{L}\p{N}]+$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DevicePositions": [ { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "ReceivedTime": number, "SampleTime": number } ], "Errors": [ { "DeviceId": "string", "Error": { "Code": "string", "Message": "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.

DevicePositions

Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

Type: Array of DevicePosition objects

Errors

Contains error details for each device that failed to send its position to the tracker resource.

Type: Array of BatchGetDevicePositionError objects

Errors

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

AccessDeniedException

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

HTTP Status Code: 403

InternalServerException

The request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource that you've entered was not found in your AWS account.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

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