When you create an iTunes U Web Services document, you specify iTunes U operations, entities, and instructions that describe to the iTunes U servers how you want to view or modify the structure and data contained in your iTunes U site.
All iTunes U Web Services operations, with the exception of ShowTree, fall into three categories:
Adding an item. iTunes U adds the item and information specified in your document to your iTunes U site.
Deleting an item. iTunes U deletes the item specified in your document from your iTunes U site.
Merging an item. iTunes U recursively adds, deletes, and merges the item and information specified in your document with items and information in your iTunes U site.
You can specify the following operations and entities.
Operation | Entity | Value (default values in bold) | Description |
|---|---|---|---|
Handle KeyGroup | handle "minimal" | "most" | "maximal" | Displays the data in your iTunes U site. | |
SiteHandle MergeByHandle Destructive Site | handle "true" | "false" "true" | "false" site item entity | Specifies the site information you want to update in your iTunes U site. iTunes U merges the site information specified in your document with the information in your iTunes U site. | |
ParentHandle ParentPath TemplateHandle Division | handle path handle division item entity | Specifies a division you want to add to your iTunes U site. | |
DivisionHandle DivisionPath | handle path | Specifies a division you want to delete from your iTunes U site. | |
DivisionHandle DivisionPath MergeByHandle Destructive Division | handle path "true" | "false" "true" | "false" division item entity | Specifies the division information you want to update in your iTunes U site. iTunes U merges the division information specified in your document with the division information in your iTunes U site. | |
ParentHandle ParentPath Section | handle path section item entity | Specifies a section you want to add to your iTunes U site. | |
SectionHandle SectionPath | handle path | Specifies a section you want to delete from your iTunes U site. | |
SectionHandle SectionPath MergeByHandle Destructive Section | handle path "true" | "false" "true" | "false" section item entity | Specifies the section information you want to update in your iTunes U site. iTunes U merges the section information specified in your document with the section information in your iTunes U site. | |
ParentHandle ParentPath TemplateHandle Course | handle path handle course item entity | Specifies a course you want to add to a section in your iTunes U site. | |
CourseHandle CoursePath | handle path | Specifies a course you want to delete from a section in your iTunes U site. | |
CourseHandle CoursePath MergeByHandle Destructive Course | handle path "true" | "false" "true" | "false" course item entity | Specifies the course information you want to update in your iTunes U site. iTunes U merges the course information specified in your document with the course information in your iTunes U site. | |
ParentHandle ParentPath Group | handle path group item entity | Specifies a group you want to add to a course in your iTunes U site. | |
GroupHandle GroupPath | handle path | Specifies a group you want to delete from a course in your iTunes U site. | |
GroupHandle GroupPath MergeByHandle Destructive Group | handle path "true" | "false" "true" | "false" group item entity | Specifies the group information you want to update in a course in your iTunes U site. iTunes U merges the group information specified in your document with the group information in your iTunes U site. | |
GroupHandle | handle | Specifies a feed group you want to update in a course in your iTunes U site with data from the feed source. For more information, see PingPodcast information in “Adding Content Using a Feed Group” and “Creating Group Types.” | |
FeedIdentifier | handle | feed URL | Specifies a feed course or feed group you want to update in your iTunes U site with data from the feed source. For more information, see PingPodcast information in “Adding Content Using a Feed Course” and “Adding Content Using a Feed Group.” | |
ParentHandle ParentPath Track | handle path track item entity | Specifies a track you want to add to a group in your iTunes U site. | |
TrackHandle | handle | Specifies a track you want to delete from your iTunes U site. | |
TrackHandle Track | handle track item entity | Specifies the track properties you want to update in your iTunes U site. iTunes U merges the track information specified in your document with the track information in your iTunes U site. | |
ParentHandle ParentPath Permission | handle path permission item entity | Specifies a permission you want to add to a section, course, or group in your iTunes U site. | |
ParentHandle ParentPath Credential | handle path credential item entity | Specifies a permission you want to delete from a section, course, or group in your iTunes U site. | |
ParentHandle ParentPath Permission | handle path permission item entity | Specifies the permission information you want to update for a section, course, or group in your iTunes U site. iTunes U merges the permission information specified in your document with the permission information in your iTunes U site. |
Notes:
Each page, each group within each page, and each track within each group in your iTunes U site has a unique handle and unique URL representing the destination, making it easy for you to reference a specific iTunes U page, group, or track. For information on how to obtain a handle or URL for a specific iTunes U page, group, or track, see “Obtaining an iTunes U URL.”
If you do not specify a handle or path, iTunes U determines the destination from the destination string in the URL. If you specify a handle, with or without a path, iTunes U uses the handle. If you do not specify a handle but instead specify a path, iTunes U uses the path. If you specify both a handle and path, iTunes U uses the handle.
In order to return a timely response, iTunes U may not process all of the requests in your web service document. If this occurs, iTunes U returns a message with the response indicating which operations were not processed.
If you do not include <Version> in your request, iTunes U returns the version 1.1 response. If you do include <Version>, iTunes U returns a response matching the version you specified, unless the version has been deprecated, in which case iTunes U returns an error.
ShowTree
MergeSite
AddDivision
DeleteDivision
MergeDivision
AddSection
DeleteSection
MergeSection
AddCourse
DeleteCourse
MergeCourse
AddGroup
DeleteGroup
MergeGroup
UpdateGroup
UpdateFeed
AddTrack
DeleteTrack
MergeTrack
AddPermission
DeletePermission
MergePermission
© 2009 Apple Inc. All Rights Reserved. (Last updated: 2009-11-04)