Contents

Get a Catalog Activity's Relationship Directly by Name

Fetch an activity’s relationship by using its identifier.

URL

GET https://api.music.apple.com/v1/catalog/{storefront}/activities/{id}/{relationship}

Path Parameters

NameTypeDescription
id Requiredstring

A unique identifier for the activity.

relationship Requiredstring

The name of the relationship you want to fetch for this resource.

storefront Requiredstring

An iTunes Store territory, specified by an ISO 3166 alpha-2 country code. The possible values are the id attributes of Storefront objects.

Query Parameters

NameTypeDescription
limit Optionalinteger

Limit is the number of objects or number of objects in the specified relationship returned.

l Optionalstring

The localization to use, specified by a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object specified by storefront. Otherwise, the default is defaultLanguageTag in Storefront.

include Optional[string]

A list of relationship names to include for resources in the response.

extend Optional[string]

A list of attribute extensions to apply to resources in the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RelationshipResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

500Internal Server Error
Content-Type: application/json
ErrorsResponse

A response indicating an error occurred on the server.

Discussion

If successful, the HTTP status code is 200 (OK) and the data array contains a single Activity.Relationships object. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. For more information, see Handling Requests and Responses.

Example

See Also

Related Documentation

Requesting Catalog Activites