2.2.4.12 ListDefinitionSchema

  • Article

The ListDefinitionSchema complex type specifies the results from retrieving a specified list.

 <s:complexType name="ListDefinitionSchema">
   <s:complexContent>
           <s:extension base="tns:ListDefinitionCT">
             <s:sequence>
               <s:element name="Validation" minOccurs="0">
                 <s:complexType>
                   <s:attribute name="Message" type="s:string" use="optional" />
                  </s:complexType>
                 </s:element>
               <s:element name="ValidationDisplayNames" minOccurs="0"  
                          type="s:string" />
               <s:element name="Fields">
                 <s:complexType mixed="true">
                   <s:sequence>
                     <s:element name="Field" 
                                type="core:FieldDefinition" 
                                minOccurs="0" maxOccurs="unbounded" />
                   </s:sequence>
                 </s:complexType>
               </s:element>
               <s:element name="RegionalSettings" >
                 <s:complexType mixed="true">
                   <s:sequence>
                     <s:element name="Language" type="s:string" />
                     <s:element name="Locale" type="s:string" />
                     <s:element name="AdvanceHijri" type="s:string" />
                     <s:element name="CalendarType" type="s:string" />
                     <s:element name="Time24" type="s:string" />
                     <s:element name="TimeZone" type="s:string" />
                     <s:element name="SortOrder" type="s:string" />
                     <s:element name="Presence" type="s:string" />
                   </s:sequence>
                 </s:complexType>
               </s:element>
               <s:element name="ServerSettings" >
                 <s:complexType mixed="true">
                   <s:sequence>
                     <s:element name="ServerVersion" type="s:string" />
                     <s:element name="RecycleBinEnabled" type="core:TRUEFALSE" />
                     <s:element name="ServerRelativeUrl" type="s:string" />
                   </s:sequence>
                 </s:complexType>
               </s:element>
             </s:sequence>
           </s:extension>
   </s:complexContent>
 </s:complexType>
 

ListDefinitionSchema.Validation: An expression as specified by [MS-WSSTS] section 2.9. Each data-reference in the expression MUST correspond to a valid Name attribute of a field (2) in the current list. If present, this element MUST NOT be longer than 1024 characters.<26>

ListDefinitionSchema.Validation.Message: A message used to indicate that data validation was not satisfied. If present, this element MUST NOT be longer than 1024 characters.<27>

ListDefinitionSchema.ValidationDisplayNames: An expression as specified by [MS-WSSTS] section 2.9. Each data-reference in the expression MUST correspond to a valid DisplayName attribute of a field (2) in the current list. Constants MUST be formatted according to the Locale attribute of the RegionalSettings element. Commas MUST be replaced with the appropriate separator character according to the Locale attribute of the RegionalSettings element.<28>

ListDefinitionSchema.Fields: Specifies the collection of all the field (2) in the list.

ListDefinitionSchema.Fields.Field: A FieldDefinition, as specified in [MS-WSSFO2] section 2.2.8.3.3.

ListDefinitionSchema.RegionalSettings: Specifies the regional settings of the list.

ListDefinitionSchema.Language: A valid language code identifier (LCID), as defined in [MS-LCID].

ListDefinitionSchema.Locale: A valid LCID, as defined in [MS-LCID].

ListDefinitionSchema.AdvanceHijri: An integer between -2 and 2, based on how many days the Hijri calendar needs to be adjusted.

ListDefinitionSchema.CalendarType: Specifies the type of calendar. See [MS-WSSFO2] section 2.2.3.3 for the different types of calendar supported.

ListDefinitionSchema.Time24: Specifies that the list uses 24-hour time, if set to True; otherwise, the list does not use 24-hour time.

ListDefinitionSchema.TimeZone: An unsigned short integer that specifies the identifier of the time zone that is stored on the server. The value of the integer represents the number of minutes that the time zone differs from UTC.

ListDefinitionSchema.SortOrder: The Regional Settings Collation LCID.

ListDefinitionSchema.Presence: Specifies that presence is enabled, if set to True; otherwise, Presence is not enabled.

ListDefinitionSchema.ServerSettings: Specifies a collection of protocol server settings.

ListDefinitionSchema.ServerVersion: The current version of protocol server.

ListDefinitionSchema.RecycleBinEnabled: Specifies that the Recycle Bin is enabled, if set to True; otherwise, the Recycle Bin is not enabled.

ListDefinitionSchema.ServerRelativeUrl: The protocol server-relative URL of the site to which this list belongs. This value is relative to the URL of the top-level site of the site collection to which the site belongs.