Contents

DeviceLocationResponse

A response from the device after it processes the command to request the location of a device when in Lost Mode.

Declaration

object DeviceLocationResponse

Properties

NameTypeDescription
Altitude Requirednumber

The altitude of the device’s location, which is a negative value if the altitude is unknown.

CommandUUIDstring

The unique identifier of the command for this response.

Course Requirednumber

The direction the device is traveling, which is a negative value if the course is unknown.

EnrollmentID Requiredstring

The per-enrollment identifier for the device. The system requires this value if the enrollment type is a user enrollment.

Available in iOS 13 and later, macOS 10.15 and later, and visionOS 2 and later.

EnrollmentUserID Requiredstring

The per-enrollment identifier for the user. The system requires this value if the enrollment type is a user enrollment on the user channel.

Available in macOS 10.15 and later.

ErrorChain[DeviceLocationResponse.ErrorChainItem]

An array of dictionaries that describes any errors that occur.

HorizontalAccuracy Requirednumber

The radius of uncertainty for the location in meters, which is a negative value if the horizontal accuracy is unknown.

Latitude Requirednumber

The latitude of the device’s location.

Longitude Requirednumber

The longitude of the device’s location.

NotOnConsole Requiredboolean

If true, the device isn’t on-console.

Speed Requirednumber

The speed of the device in meters per second, which is a negative value if the speed is unknown.

Status Requiredstring

The status of the response, which is one of the following values:

  • Acknowledged: The device processed the command successfully.

  • Error: An error occurred. See the ErrorChain for more details.

  • CommandFormatError: A protocol error occurred, which can result from a malformed command.

  • Idle: The device is idle; there’s no status.

  • NotNow: The device received the command, but can’t run it.

Timestamp Requiredstring

The RFC 3339 timestamp of when the server determines the location of the device.

UDID Requiredstring

The device’s UDID (unique device identifier). The system requires this value if the enrollment type is a device enrollment.

UserIDstring

For macOS, this value is the ID of the user.

For Shared iPad, this value is FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF to indicate that authentication doesn’t occur.

UserLongName Requiredstring

The full name of the user.

UserShortNamestring

For macOS, this value is the short name of the user.

For Shared iPad, this value is the Managed Apple Account identifier of the user on Shared iPad. It indicates that the token is for the user channel.

VerticalAccuracy Requirednumber

The accuracy of the altitude value in meters, which is a negative value if the vertical accuracy is unknown.

Topics

Objects

See Also

Commands and responses