Export (0) Print
Expand All

Error (JSON)

The error structure is the same across all APIs. Noteworthy elements are as follows.

Error

The Error object has the following specification.

MemberTypeDescription
ErrorCodeStringThe error code, as described in the following table of error codes.
DescriptionStringA user-friendly description of the error code.
MessageStringA more contextual message describing what may have gone wrong.

These error structures can be optionally embedded in any Xbox Music Platform service response. If an error is reported, the Error.ErrorCode and Error.Description elements will always be provided.

Error codes

NameDefault HTTP codeDescription
CATALOG_UNAVAILABLE502 Bad GatewayNo response from catalog.
CATALOG_NO_RESULT404 Not FoundItem does not exist.
CATALOG_INVALID_DATA Error while reading catalog data; some results may be missing.
COLLECTION_NO_RESULT404 NotFoundNo result from Collection
COLLECTION_INVALID_RESPONSE502 BadGatewayInvalid response from Cloud Collection
COLLECTION_INVALID_DATA200 OKError while reading collection data, some results may be missing or incomplete
COLLECTION_FULL400 BadRequestYour collection is full
COLLECTION_PLAYLIST_FULL400 BadRequestThis playlist is full
COLLECTION_INVALID_OPERATION400 BadRequestThis operation is not supported
COLLECTION_INVALID_ID400 BadRequestInvalid collection id for this operation
COLLECTION_INVALID_PLAYLIST_INFO400 BadRequestRequired playlist information is missing
COLLECTION_OPERATION_UNKNOWN_ERROR502 BadGatewayThe operation failed
COLLECTION_SOME_OPERATIONS_FAILED200 OKSome of the operations failed
DISCOVERY_NO_RESULT404 NotFoundNo result from Discovery
DISCOVERY_INVALID_GENRE404 NotFoundNo result from Discovery, you might want to check if genre is well formatted
DISCOVERY_INVALID_RESPONSE502 BadGatewayInvalid response from Discovery
DISCOVERY_INVALID_DATA200 OKError while reading discovery data, some results may be missing or incomplete
DELIVERY_INVALID_RESPONSE502 BadGatewayInvalid response from the Music Delivery Service
DELIVERY_UNAVAILABLE_CONTENT404 NotFoundContent is not available for streaming
DELIVERY_CONCURRENT_STREAMING409 ConflictThe user is already streaming on another device
DELIVERY_ERROR404 NotFoundUnknown delivery error
ACCESS_TOKEN_MISSING401 UnauthorizedAzure Marketplace access token required.
ACCESS_TOKEN_INVALID401 UnauthorizedInvalid Azure Marketplace token.
ACCESS_TOKEN_EXPIRED401 UnauthorizedExpired Azure Marketplace token.
ACCESS_TOKEN_VALIDATION_ERROR500 Internal Server ErrorUnexpected error while validating Azure Marketplace token.
ACCESS_TOKEN_INVALID_SUBSCRIPTION401 UnauthorizedAzure Marketplace client ID is not a subscriber to the Xbox Music data offer.
ACCESS_TOKEN_SUBSCRIPTION_VALIDATION_ERROR500 Internal Server ErrorUnexpected error while validating Azure Marketplace subscription status.
CONTINUATION_TOKEN_INVALID_ERROR 400 Bad RequestThe continuation token provided is incorrect.
INVALID_AUTHORIZATION_HEADER401 UnauthorizedMissing or invalid authorization header
NO_MUSIC_PASS_SUBSCRIPTION403 ForbiddenThe user does not have an Xbox Music subscription
MISSING_INPUT_PARAMETER400 Bad RequestMissing or empty mandatory parameter.
INVALID_INPUT_PARAMETER400 Bad RequestInvalid parameter value.
INCOMPATIBLE_INPUT_PARAMETERS400 Bad RequestIncompatible parameters.
UNAUTHORIZED_INPUT_PARAMETER200 OKUnauthorized input parameter
UNAUTHORIZED_API_METHOD403 ForbiddenUnauthorized API method
INVALID_COUNTRY400 BadRequestThe requested functionality is not available in this region
INTERNAL_SERVER_ERROR500 Internal Server ErrorOops, something went seriously wrong.
TOO_MANY_REQUESTS429 TooManyRequestsToo Many Requests

Sample JSON syntax

{
  "ErrorCode": "CATALOG_NO_RESULT",
  "Description": "Item does not exist"
}
    

Community Additions

ADD
Show:
© 2014 Microsoft