• Table of Contents
• Previous Next

MergeSite

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 site information in your iTunes U site.

When you specify this operation, iTunes U:

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

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

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

You specify the following entities with the MergeSite operation:

• SiteHandle. Specifies the handle for the site you want to update. The site handle must correspond to the root 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 SiteHandle entity, iTunes U uses the destination string in your URL.

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

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

• Site. Specifies the entities for the site attributes you want to update, including site Name, Handle, AllowSubscription, Permission, Section, Templates, and ThemeHandle. By specifying this information, you can override existing settings in the site.

• Destructive. Specifies whether or not you want to delete from the destination site any Section or Permission items not specified in the Site 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 site 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-site 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 MergeSite:

<?xml version="1.0" encoding="UTF-8"?>
<ITunesUDocument>
    <Version>1.1.4</Version>
    <MergeSite>
        <SiteHandle>sitehandle value</SiteHandle>
        <MergeByHandle>mergebyhandle value</MergeByHandle>
        <Destructive>destructive value</Destructive>
        <Site>
            <Name>name value</Name>
            <Handle>handle value</Handle>
            <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>
                </Course>
            </Section>
            <Templates>
                <Name>name value</Name>
                <Handle>handle value</Handle>
                <Course>course value</Course>
            </Templates>
            <ThemeHandle>themehandle value</ThemeHandle>
        </Site>
    </MergeSite>
</ITunesUDocument>