Share via

3.1.4.18.2.2 UpdateColumnsResponse

  • Article

The SOAP body contains an UpdateColumnsResponse element, which has the following definition:

 <s:element name="UpdateColumnsResponse">
   <s:complexType>
     <s:sequence>
       <s:element name="UpdateColumnsResult" minOccurs="0">
         <s:complexType>
           <s:sequence>
             <s:element name="Results">
               <s:complexType>
                 <s:sequence>
                   <s:element name="NewFields">
                     <s:complexType>
                       <s:sequence>
                         <s:element name="Method" minOccurs="0" maxOccurs="unbounded" >
                           <s:attribute name="ID" type="s:string" use="required"/> 
                           <s:complexType>
                             <s:sequence>
                               <s:element name="ErrorCode" type="s:string" minOccurs="1" maxOccurs="1"/>
                               <s:element name="ErrorText" type="s:string" minOccurs="0" maxOccurs="1"/>
                               <s:element name="Field" minOccurs="0" maxOccurs="1" type="core:FieldDefinition"/>
                             </s:sequence>
                           </s:complexType>
                         </s:element>        
                       </s:sequence>
                     </s:complexType>
                   </s:element>
                   <s:element name="UpdateFields">
                     <s:complexType>
                       <s:sequence>
                         <s:element name="Method" minOccurs="0" maxOccurs="unbounded" >
                           <s:attribute name="ID" type="s:string" use="required"/> 
                           <s:complexType>
                             <s:sequence>
                               <s:element name="ErrorCode" type="s:string" minOccurs="1" maxOccurs="1"/>
                               <s:element name="ErrorText" type="s:string" minOccurs="0" maxOccurs="1"/>
                               <s:element name="Field" minOccurs="0" maxOccurs="1" type="core:FieldDefinition"/>          
                             </s:sequence>
                           </s:complexType>
                         </s:element>        
                       </s:sequence>
                     </s:complexType>
                   </s:element>
                   <s:element name="DeleteFields">
                     <s:complexType>
                       <s:sequence>
                         <s:element name="Method" minOccurs="0" maxOccurs="unbounded" >
                           <s:attribute name="ID" type="s:string" use="required"/> 
                           <s:complexType>
                             <s:sequence>
                               <s:element name="ErrorCode" type="s:string" minOccurs="1" maxOccurs="1"/>
                               <s:element name="ErrorText" type="s:string" minOccurs="0" maxOccurs="1"/>
                               <s:element name="Field" minOccurs="0" maxOccurs="1" type="core:FieldDefinition"/>       
                             </s:sequence>
                           </s:complexType>
                         </s:element>        
                       </s:sequence>
                     </s:complexType>
                   </s:element>
                 </s:sequence>
               </s:complexType>
             </s:element>
           </s:sequence>
         </s:complexType>
       </s:element>
     </s:sequence>
   </s:complexType>
 </s:element>

UpdateColumnsResult: This element contains a Results element.

Results: This element contains NewFields, UpdateFields, and DeleteFields elements.

NewFields: This element contains one or more Method elements for all columns added to the context site and all child sites in its hierarchy.

UpdateFields: This element contains one or more Method elements for all columns updated on the context site and all child sites in its hierarchy.

DeleteFields: This element contains one or more Method elements for all columns deleted from the context site and all child sites in its hierarchy.

Method: This element contains an ErrorText, an ErrorCode, and a Field element.

Method.ID: This attribute MUST have the same value as the Method.ID attribute that was sent to the protocol server in the UpdateColumns message of this UpdateColumnsResponse for an add, update, or delete operation.

ErrorCode: A hexadecimal value that represents the error returned by the protocol server.

ErrorText: A string value that explains the error returned by the protocol server.

Field: A field definition element that represents a column. This type is specified in [MS-WSSFO2] section 2.2.8.3.3.

A SOAP fault MUST be returned if the protocol server encounters the following error condition while running this operation:

  • Occurs when an invalid element is the child element of the newFields, updateFields, or deleteFields elements.

  • Occurs when one of the newFields, updateFields, or deleteFields elements of the UpdateColumns element has multiple Method elements without a Fields element defined as the root element.

If the protocol server encounters one of the error conditions in the following table while running this operation, ErrorCode and ErrorText elements MUST be returned in the UpdateColumnsResponse element, which SHOULD contain one of the error codes in the following table for the specified error condition.

Error code

Error condition(s)

0x80004005

Occurs when:

  • An attempt is made to add an already existing column to the site.

  • An attempt is made to delete a non-existing column from the site.

  • An invalid GUID is passed in as the ID attribute for updateFields and deleteFields.

  • Neither the Name nor the DisplayName attribute is passed in a Field element of newFields.

  • An invalid Field element is passed in any of the parameters.

  • The specified Name attribute does not match any of the existing columns.