Reference for SetScheduleForVolumes

Url: agents/{agentId}/setSchedule

HTTP Method: POST

Message direction | Format | Body
--- | --- | ---
Request | XML | Example,Schema
Response | XML | Example,Schema

The following is an example request XML body:

    <?xml version="1.0" encoding="utf-16"?>
    <volumeScheduleUpdateRequest xmlns="http://apprecovery.com/management/api/2010/05">
      <scheduleConfiguration>
        <friday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </friday>
        <monday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </monday>
        <saturday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </saturday>
        <sunday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </sunday>
        <thursday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </thursday>
        <tuesday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </tuesday>
        <wednesday>
          <transferScheduleItemsCollection>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
            <!--Valid elements of type: intervalTransferScheduleItem-->
            <transferScheduleItem i:type="intervalTransferScheduleItem" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
              <endTime>P428DT10H30M12.3S</endTime>
              <priority>2147483647</priority>
              <startTime>P428DT10H30M12.3S</startTime>
              <step>P428DT10H30M12.3S</step>
            </transferScheduleItem>
          </transferScheduleItemsCollection>
        </wednesday>
      </scheduleConfiguration>
      <volumes>
        <volumeGuidName>
          <guidName>String content</guidName>
        </volumeGuidName>
        <volumeGuidName>
          <guidName>String content</guidName>
        </volumeGuidName>
      </volumes>
    </volumeScheduleUpdateRequest>

The following is an example response XML body:

    No Xml response output for this method.

The following is the request XML Schema:

    <?xml version="1.0" encoding="utf-16"?>
    <Schemas>
      <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:element name="anyType" nillable="true" type="xs:anyType" />
        <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
        <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
        <xs:element name="boolean" nillable="true" type="xs:boolean" />
        <xs:element name="byte" nillable="true" type="xs:byte" />
        <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
        <xs:element name="decimal" nillable="true" type="xs:decimal" />
        <xs:element name="double" nillable="true" type="xs:double" />
        <xs:element name="float" nillable="true" type="xs:float" />
        <xs:element name="int" nillable="true" type="xs:int" />
        <xs:element name="long" nillable="true" type="xs:long" />
        <xs:element name="QName" nillable="true" type="xs:QName" />
        <xs:element name="short" nillable="true" type="xs:short" />
        <xs:element name="string" nillable="true" type="xs:string" />
        <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
        <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
        <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
        <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
        <xs:element name="char" nillable="true" type="tns:char" />
        <xs:simpleType name="char">
          <xs:restriction base="xs:int" />
        </xs:simpleType>
        <xs:element name="duration" nillable="true" type="tns:duration" />
        <xs:simpleType name="duration">
          <xs:restriction base="xs:duration">
            <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
            <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
            <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
          </xs:restriction>
        </xs:simpleType>
        <xs:element name="guid" nillable="true" type="tns:guid" />
        <xs:simpleType name="guid">
          <xs:restriction base="xs:string">
            <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
          </xs:restriction>
        </xs:simpleType>
        <xs:attribute name="FactoryType" type="xs:QName" />
        <xs:attribute name="Id" type="xs:ID" />
        <xs:attribute name="Ref" type="xs:IDREF" />
      </xs:schema>
      <xs:schema xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
        <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" />
        <xs:complexType name="volumeScheduleUpdateRequest">
          <xs:sequence>
            <xs:element minOccurs="0" name="scheduleConfiguration" nillable="true" type="tns:transferScheduleConfiguration" />
            <xs:element minOccurs="0" name="volumes" nillable="true" type="tns:volumeGuidNames" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="volumeScheduleUpdateRequest" nillable="true" type="tns:volumeScheduleUpdateRequest" />
        <xs:complexType name="transferScheduleConfiguration">
          <xs:sequence>
            <xs:element minOccurs="0" name="friday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="monday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="saturday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="sunday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="thursday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="tuesday" nillable="true" type="tns:transfersAgenda" />
            <xs:element minOccurs="0" name="wednesday" nillable="true" type="tns:transfersAgenda" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="transferScheduleConfiguration" nillable="true" type="tns:transferScheduleConfiguration" />
        <xs:complexType name="transfersAgenda">
          <xs:sequence>
            <xs:element minOccurs="0" name="transferScheduleItemsCollection" nillable="true" type="tns:transferScheduleItemsCollection" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="transfersAgenda" nillable="true" type="tns:transfersAgenda" />
        <xs:complexType name="transferScheduleItemsCollection">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="transferScheduleItem" nillable="true" type="tns:transferScheduleItem" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="transferScheduleItemsCollection" nillable="true" type="tns:transferScheduleItemsCollection" />
        <xs:complexType name="transferScheduleItem">
          <xs:sequence />
        </xs:complexType>
        <xs:element name="transferScheduleItem" nillable="true" type="tns:transferScheduleItem" />
        <xs:complexType name="intervalTransferScheduleItem">
          <xs:complexContent mixed="false">
            <xs:extension base="tns:transferScheduleItem">
              <xs:sequence>
                <xs:element minOccurs="0" name="endTime" type="ser:duration" />
                <xs:element minOccurs="0" name="priority" type="xs:int" />
                <xs:element minOccurs="0" name="startTime" type="ser:duration" />
                <xs:element minOccurs="0" name="step" type="ser:duration" />
              </xs:sequence>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
        <xs:element name="intervalTransferScheduleItem" nillable="true" type="tns:intervalTransferScheduleItem" />
        <xs:complexType name="volumeGuidNames">
          <xs:sequence>
            <xs:element minOccurs="0" maxOccurs="unbounded" name="volumeGuidName" nillable="true" type="tns:volumeGuidName" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="volumeGuidNames" nillable="true" type="tns:volumeGuidNames" />
        <xs:complexType name="volumeGuidName">
          <xs:sequence>
            <xs:element minOccurs="0" name="guidName" nillable="true" type="xs:string" />
          </xs:sequence>
        </xs:complexType>
        <xs:element name="volumeGuidName" nillable="true" type="tns:volumeGuidName" />
      </xs:schema>
    </Schemas>

The following is the response XML Schema:

    The response body is empty.