• Table of Contents
• Previous Next

MergeDivision

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.

When you specify this operation, iTunes U:

1. Updates existing division items with the information you specify.

2. Creates new items in the division for any entities you specify that do not already exist in the destination division, and, if the Destructive entity is set to true, deletes any existing items in the destination division for entities you do not specify.

3. Merges information in the division for any entities you specify that already exist in the destination division.

You specify the following entities with the MergeDivision operation:

• DivisionHandle. Specifies the handle in your iTunes U site for the division you want to update. The division handle must correspond to a division item in your iTunes U site. If the handle does not match an existing item, iTunes U returns an error message. If you do not specify the DivisionHandle entity, iTunes U uses the destination string in your URL.

• DivisionPath. Specifies the path in your iTunes U site for the division you want to update. The division path must correspond to a division item in your iTunes U site. If the path does not match an existing item, or matches multiple items, iTunes U returns an error message. If you do not specify the DivisionPath entity, iTunes U uses the destination string in your URL. The DivisionPath entity must be in the form “a/b/c” where a, b, and c are folder names. For example, if you have a site named “CupertinoU” containing a division named “Fall07,” you can refer to the DivisionPath as <DivisionPath>CupertinoU/Fall07</DivisionPath> in your MergeDivision operation. If specifying the root path, you must start the DivisionPath entity with a leading slash (/). To specify a slash (/) as a character within a node of the slash-delimited path, escape the character with a second slash (//).

• MergeByHandle. Specifies whether or not you want to merge division information using Division handles. You can specify one of the following values: true, false. By default, iTunes U merges division information using the Name entity.

  iTunes U preserves the order of section items within the Division entity. By default, when you merge a division, iTunes U uses the Name entity to determine how to merge and order similar items in the destination division. You can set MergeByHandle=true to rename a division and merge the entities based on handles instead of names.

• Division. Specifies the entities for the division attributes you want to update, including division Name, ShortName, Identifier, AllowSubscription, Permission, Section, ThemeHandle, and Description. By specifying this information, you can override existing settings in the division.

• Destructive. Specifies whether or not you want to delete from the destination division any Section or Permission items not specified in the Division entity. You can specify one of the following values: true, false. By default, iTunes U sets the Destructive entity to false and merges items.

Notes:

• Specify simple text string values for the Name entity.

• To specify whether or not users can subscribe to a specific division as a podcast, you can specify the following values for AllowSubscription: true, false. You can use this entity to override your global track preferences setting on a per-division basis.

• Specify all details for any Group (including Name) or Permission (including Credential and Access) entities.

Warning: Web Services does not provide an undo operation. Be careful when using the Destructive entity. If misused, you can destroy your entire iTunes U site structure.

The following is an example of an iTunes U Web Services document using MergeDivision:

<?xml version="1.0" encoding="UTF-8"?>
<ITunesUDocument>
    <Version>1.1.4</Version>
    <MergeDivision>
        <DivisionHandle>divisionhandle value</DivisionHandle>
        <DivisionPath>divisionpath value</DivisionPath>
        <MergeByHandle>mergebyhandle value</MergeByHandle>
        <Destructive>destructive value</Destructive>
        <Division>
            <Name>name value</Name>
            <ShortName>shortname value</ShortName>
            <Identifier>identifier value</Identifier>
            <AllowSubscription>allowsubscription value</AllowSubscription>
            <Permission>
                <Credential>credential value</Credential>
                <Access>access value</Access>
            </Permission>
            <Section>
                <Name>name value</Name>
                <Handle>handle value</Handle>
                <Course>
                    <Name>name value</Name>
                    <CourseType>coursetype value</CourseType>
                    <Group>
                            <Name>name value</Name>
                            <Handle>handle value</Handle>
                            <Track>
                                <Name>name value</Name>
                                <Handle>handle value</Handle>
                                <Kind>kind value</Kind>
                                <DiscNumber>discnumber value</DiscNumber>
                                <DurationMilliseconds>
                                durationmilliseconds value
                                </DurationMilliseconds>
                                <AlbumName>albumname value</AlbumName>
                                <ArtistName>artistname value</ArtistName>
                                <DownloadURL>downloadurl value</DownloadURL>
                            </Track>
                            <Permission>
                                <Credential>credential value</Credential>
                                <Access>access value</Access>
                            </Permission>
                    </Group>
                </Course>
            </Section>
            <ThemeHandle>themehandle value</ThemeHandle>
        </Division>
    </MergeDivision>
</ITunesUDocument>