Contents

InstallMediaResponse

A response from the device after it processes the command to install a book on a device.

Declaration

object InstallMediaResponse

Properties

NameTypeDescription
CommandUUIDstring

The unique identifier of the command for this response.

EnrollmentID Requiredstring

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

Available: iOS 13+ | iPadOS 13+ | macOS 10.15+ Deprecated: macOS 11+ Removed: macOS 11+

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: macOS 10.15+ Deprecated: macOS 11+ Removed: macOS 11+

ErrorChain[InstallMediaResponse.ErrorChainItem]

An array of dictionaries that describes any errors that occur.

iTunesStoreIDinteger

The book’s iTunes Store identifier, if present in the command.

Deprecated: macOS 11+ Removed: macOS 11+

MediaTypestring

The media type, which can only be Book.

Deprecated: macOS 11+ Removed: macOS 11+

MediaURLstring

The URL to retrieve the book, if present in the command.

Available: iOS 8+ | iPadOS 8+ Deprecated: macOS 11+ Removed: macOS 11+

NotOnConsole Requiredboolean

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

PersistentIDstring

The book’s persistent identifier, if present in the command.

Available: iOS 8+ | iPadOS 8+ Deprecated: macOS 11+ Removed: macOS 11+

RejectionReasonstring

The reason, if installation fails, which is one of the following values:

  • CouldNotVerifyITunesStoreID: The iTunesStoreID is invalid.

  • PurchaseNotFound: The Volume Purchase Program (VPP) license isn’t in the user’s history.

  • AppStoreDisabled: App Store isn’t available on the device.

  • WrongMediaType: The media type is invalid. The only valid type is Book.

  • DownloadInvalid: The URL doesn’t lead to a valid book.

  • EnterpriseBooksNotSupportedInMultiUser: Multiuser mode doesn’t support enterprise books.

Deprecated: macOS 11+ Removed: macOS 11+

Statestring

The installation state of this book. The Failed and Unknown states are transient and the device only reports them once. Books from the Book Store report their state as Installed instead of Managed.

Deprecated: macOS 11+ Removed: macOS 11+

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.

UDID Requiredstring

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

Deprecated: macOS 11+ Removed: macOS 11+

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.

Available: iOS 9.3+ | iPadOS 9.3+ | macOS 10.9+ Deprecated: macOS 11+ Removed: macOS 11+

UserLongName Requiredstring

The full name of the user.

Available: macOS 10.9+ Deprecated: macOS 11+ Removed: macOS 11+

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.

Available: iOS 9.3+ | iPadOS 9.3+ | macOS 10.9+ Deprecated: macOS 11+ Removed: macOS 11+

Topics

Objects

See Also

Commands and responses