2.2.2.2.1 GetConfig

Synopsis:

This method returns information on the server's registration, authorization, and reporting requirements.

 <wsdl:operation name="GetConfig" />

The SOAP operation is defined as follows.

 <soap:operation soapAction="http://www.microsoft.com/
    SoftwareDistribution/Server/ClientWebService/GetConfig" 
    style="document" />

Request:

 <s:element name="GetConfig">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="protocolVersion" 
          type="s:string" />
     </s:sequence>
   </s:complexType>
 </s:element>

protocolVersion: The client protocol version, as a two-part version string where the two parts are separated by a period. The client SHOULD pass "1.8".<11>

Response: The server MUST return a result with the following syntax.

 <s:element name="GetConfigResponse">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="GetConfigResult" 
          type="s1:Config" />
     </s:sequence>
   </s:complexType>
 </s:element>

GetConfigResult: On successful completion of this operation, this element MUST be returned. The syntax of the GetConfigResult type MUST be as follows.

 <s:complexType name="Config">
   <s:sequence>
     <s:element minOccurs="1" maxOccurs="1" name="LastChange" 
        type="s:dateTime" />
     <s:element minOccurs="1" maxOccurs="1" name="IsRegistrationRequired" 
        type="s:boolean" />
     <s:element minOccurs="0" maxOccurs="1" name="AuthInfo" 
        type="s1:ArrayOfAuthPlugInInfo" />
     <s:element minOccurs="0" maxOccurs="1" name="AllowedEventIds" 
        type="s1:ArrayOfInt" />
     <s:element minOccurs="0" maxOccurs="1" name="Properties" 
        type="s1:ArrayOfConfigurationProperty" />
   </s:sequence>
 </s:complexType>

LastChange: The last time configuration data changed on the server.

IsRegistrationRequired: Specifies whether the server requires registration (as specified in section 2.2.2.2.3). Set TRUE to indicate registration is required. Set FALSE to indicate that registration is not required.

AuthInfo: Contains an array of authorization plug-ins supported by the server. On successful execution of this operation, this array MUST contain exactly one element. Its format (ArrayOfAuthPlugInInfo) is as follows.

 <s:complexType name="ArrayOfAuthPlugInInfo">
   <s:sequence>
     <s:element minOccurs="0" maxOccurs="unbounded" name="AuthPlugInInfo" 
        nillable="true" type="s1:AuthPlugInInfo" />
   </s:sequence>
 </s:complexType>

AuthPlugInInfo: This field MUST be present and MUST contain exactly one element in the array. It provides information about the Authorization PlugIn available on the server. Its format is as follows.

 <s:complexType name="AuthPlugInInfo">
   <s:sequence>
     <s:element minOccurs="0" maxOccurs="1" name="PlugInID" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="ServiceUrl" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="Parameter" 
        type="s:string" />
   </s:sequence>
 </s:complexType>

PlugInID: This MUST be present and MUST have the value "SimpleTargeting".

ServiceUrl: This MUST be set to the URL of the SimpleAuth Web service. It is a partial URL that can be appended to http://<server>:<server port>/ to form the full URL to be used for SimpleAuth Web service. The client MUST only use this web service URL to make GetAuthorizationCookie calls.

Parameter: Unused. It MUST NOT be present and MUST be ignored upon receipt.

AllowedEventIds: Contains an array of event identifiers specifying events required by the reporting Web service of the server.

Properties: A set of properties used in the protocol. Its format (ArrayOfConfigurationProperty) is in the following example. A ConfigurationProperty with Name set to "MaxExtendedUpdatesPerRequest" MUST be present. The other listed ConfigurationProperty properties SHOULD be present in server protocol version 3.0 or higher, but MUST NOT be present in prior versions.

 <s:complexType name="ArrayOfConfigurationProperty">
   <s:sequence>
     <s:element minOccurs="0" maxOccurs="unbounded" 
        name="ConfigurationProperty" nillable="true" 
        type="s1:ConfigurationProperty" />
   </s:sequence>
 </s:complexType>

ConfigurationProperty: Its format is as follows.

 <s:complexType name="ConfigurationProperty">
   <s:sequence>
     <s:element minOccurs="0" maxOccurs="1" name="Name" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="Value" 
        type="s:string" />
   </s:sequence>
 </s:complexType>

Name	Value
MaxExtendedUpdatesPerRequest	This element specifies the maximum number of revisionIDs that the server allows the client to specify in the GetExtendedUpdateInfo (section 2.2.2.2.6) method.
PackageServerShare	This element is a UncPath that specifies the repair path.
ProtocolVersion	This element specifies the server protocol version number that this protocol server is using. It SHOULD be "3.2".<12>
IsInventoryRequired	The value MUST be "0".
ClientReportingLevel	The value SHOULD be "2".