Contents

VppClientConfigResponse

The response that contains the client configuration.

Declaration

object VppClientConfigResponse

Properties

NameTypeDescription
apnTokenstring

The Apple Push Notification token to use for notifications.

appleIdstring

The AppleID associated with the provided sToken.

clientContextstring

The value currently associated with the provided sToken. This field is only included in the response when a value has been set via the Client Configuration endpoint.

See Protecting Your VPP Account for more information.

countryCodestring

The two-letter ISO 3166-1 code that designates the country where the VPP account is located. For example, US stands for United States, CA for Canada, JP for Japan, and so on.

defaultPlatformstring

The value to be passed for the platform parameter in the contentMetadataLookupUrl request. Possible values are:

  • volumestore: For apps in the educational store.

  • enterprisestore: For apps in the enterprise store.

See Getting App and Book Information (Legacy) for more information.

emailstring

The email address associated with the provided sToken.

errorMessagestring

The human-readable explanation of the error.

errorNumberint32

The numeric code of the error.

expirationMillisint64

The UNIX epoch timestamp, in milliseconds, when the account’s sToken or password expires (whichever is earlier).

locationVppLocation

The location associated with the provided sToken. This field is only returned when a location token is used with an Apple School Manager account.

organizationIdstring

The unique identifier assigned to an organization by the VPP.

organizationIdHashstring

The hash of organizationId.

statusint32

The status code for the response. Possible values are:

  • 0 = Success.

  • -1 = Failure.

uIdstring

The unique library identifier. When querying records using multiple tokens that may share libraries, use the uId field to filter duplicates. In this way, you can avoid double-counting records when duplicate tokens are uploaded by different content managers.

See Also

Request and Response