2.2.2.2.2 GetCookie

  • Article

Synopsis:

A client invokes this method to obtain or renew a cookie containing opaque implementation-specific authorization, authentication, and state information for use by the server.

 <wsdl:operation name="GetCookie" />

The SOAP operation is defined as follows.

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

Request:

 <s:element name="GetCookie">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="authCookies" 
          type="s1:ArrayOfAuthorizationCookie" />
       <s:element minOccurs="0" maxOccurs="1" name="oldCookie" 
          type="s1:Cookie" />
       <s:element minOccurs="1" maxOccurs="1" name="lastChange" 
          type="s:dateTime" />
       <s:element minOccurs="1" maxOccurs="1" name="currentTime" 
          type="s:dateTime" />
       <s:element minOccurs="0" maxOccurs="1" name="protocolVersion" 
          type="s:string" />
     </s:sequence>
   </s:complexType>
 </s:element>

authCookies: Specifies an array of authorization cookies. Its format (ArrayOfAuthorizationCookie) is in the following example. Upon successful completion of this operation, this element MUST be present and MUST contain exactly one AuthorizationCookie (section 2.2.3.4). 

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

AuthorizationCookie: Authorization cookie MUST be as specified in section 2.2.3.4.

oldCookie: Optionally specifies an existing cookie (that MUST have been obtained from a previous method call to GetCookie, GetFileLocations (section 2.2.2.2.7), or SyncUpdates (section 2.2.2.2.4)) that needs renewal by the server.

lastChange: Specifies the value returned from the client's most recent call to the GetConfig (section 2.2.2.2.1) method.

currentTime: The current time on the client.

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".

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

 <s:element name="GetCookieResponse">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="GetCookieResult" 
          type="s1:Cookie" />
     </s:sequence>
   </s:complexType>
 </s:element>

GetCookieResult: On successful completion of this operation, this element MUST be returned. The format for this element MUST be as specified in section 2.2.3.5.