Get Replacement Details

Get information about the device that a replacement device replaces.

URL

GET https://mdmenrollment.apple.com/device/replacementDetails

Query Parameters

Name	Type	Description
`device` Required	string	The serial number of the replacement device.

Response Codes

Status Reason Type Description

Status	Reason	Type	Description
200	OK Content-Type: application/json	`GetReplacementDetailsResponse`
400	Bad Request		`DEVICE_ID_REQUIRED`: No device serial number was provided as a query parameter. `USER_AGENT_INVALID:` The `User-Agent` header is invalid. `USER_AGENT_MISSING:` The `User-Agent` header is missing or has no assigned value.
404	Not Found		`DEVICE_NOT_FOUND`: No replacement record was found for the specified device. The serial number is invalid, the device isn’t a replacement device, or the device isn’t accessible by this MDM server.

200

Content-Type: application/json

GetReplacementDetailsResponse

400

Bad Request

DEVICE_ID_REQUIRED: No device serial number was provided as a query parameter.
USER_AGENT_INVALID: The User-Agent header is invalid.
USER_AGENT_MISSING: The User-Agent header is missing or has no assigned value.

404

Not Found

DEVICE_NOT_FOUND: No replacement record was found for the specified device. The serial number is invalid, the device isn’t a replacement device, or the device isn’t accessible by this MDM server.

Discussion

This endpoint returns the original device serial number and replacement date for a replacement device. Call this endpoint only when the device’s is_replacement_device field is true in the response from Get a List of Devices, Sync the List of Devices, or Get Device Details. Calling it for a device whose is_replacement_device value is false returns HTTP 404 DEVICE_NOT_FOUND.

This request requires X-Server-Protocol-Version 10 or later.

Topics

Response

GetReplacementDetailsResponse