2.2.2.2.3 RegisterComputer

Article
11/28/2023

Synopsis:

The client invokes this method to perform registration with the server by providing information about its operating system, hardware, and network parameter configuration.

 <wsdl:operation name="RegisterComputer" />

The SOAP operation is defined as follows.

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

Request:

 <s:element name="RegisterComputer">
   <s:complexType>
     <s:sequence>
       <s:element minOccurs="0" maxOccurs="1" name="cookie" 
          type="s1:Cookie" />
       <s:element minOccurs="0" maxOccurs="1" name="computerInfo" 
          type="s1:ComputerInfo" />
     </s:sequence>
   </s:complexType>
 </s:element>

cookie: Specifies a cookie that MUST have been obtained from a previous call to GetCookie (section 2.2.2.2.2), GetFileLocations (section 2.2.2.2.7), or SyncUpdates (section 2.2.2.2.4). This element MUST be present.

computerInfo: Information about the client computer (2). Its format is as follows.

 <s:complexType name="ComputerInfo">  <s:sequence>
     <s:element minOccurs="0" maxOccurs="1" name="DnsName" 
        type="s:string" />
     <s:element minOccurs="1" maxOccurs="1" name="OSMajorVersion" 
        type="s:int" />
     <s:element minOccurs="1" maxOccurs="1" name="OSMinorVersion" 
        type="s:int" />
     <s:element minOccurs="1" maxOccurs="1" name="OSBuildNumber" 
        type="s:int" />
     <s:element minOccurs="1" maxOccurs="1" name="OSServicePackMajorNumber" 
        type="s:short" />
     <s:element minOccurs="1" maxOccurs="1" name="OSServicePackMinorNumber" 
        type="s:short" />
     <s:element minOccurs="0" maxOccurs="1" name="OSLocale" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="ComputerManufacturer" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="ComputerModel" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="BiosVersion" 
        type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="BiosName" 
        type="s:string" />
     <s:element minOccurs="1" maxOccurs="1" name="BiosReleaseDate" 
        type="s:dateTime" />
     <s:element minOccurs="0" maxOccurs="1" name="ProcessorArchitecture" 
        type="s:string" />
     <s:element minOccurs="1" maxOccurs="1" name="SuiteMask" 
        type="s:short" />
     <s:element minOccurs="1" maxOccurs="1" name="OldProductType" 
        type="s:unsignedByte" />
     <s:element minOccurs="1" maxOccurs="1" name="NewProductType" 
        type="s:int" />
     <s:element minOccurs="1" maxOccurs="1" name="SystemMetrics" 
        type="s:int" />
     <s:element minOccurs="1" maxOccurs="1" name="ClientVersionMajorNumber" 
        type="s:short" />
     <s:element minOccurs="1" maxOccurs="1" name="ClientVersionMinorNumber" 
        type="s:short" />
     <s:element minOccurs="1" maxOccurs="1" name="ClientVersionBuildNumber" 
        type="s:short" />
     <s:element minOccurs="1" maxOccurs="1" name="ClientVersionQfeNumber" 
        type="s:short" /> 
     <s:element minOccurs="0" maxOccurs="1" name="OSDescription" type="s:string" />  
     <s:element minOccurs="0" maxOccurs="1" name="OEM" type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="DeviceType" type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="FirmwareVersion" type="s:string" />    
     <s:element minOccurs="0" maxOccurs="1" name="MobileOperator" type="s:string" />
   </s:sequence>
 </s:complexType>

DnsName: The client's name. It MUST uniquely identify the computer on the network. The client MUST also use the same value in the call to GetAuthorizationCookie (section 2.2.2.1.1). This element MUST be present.

OSMajorVersion: The client operating system major version number.

OSMinorVersion: The client operating system minor version number.

OSBuildNumber: The client operating system build number.

OSServicePackMajorNumber: The client operating system service pack major number.

OSServicePackMinorNumber: The client operating system service pack minor number.

OSLocale: The client operating system locale, as specified in [MS-LCID].

ComputerManufacturer: The manufacturer of the client computer.

ComputerModel: The model of the client computer.

BiosVersion: The version of the client computer's BIOS firmware.

BiosName: The name of the client computer's BIOS firmware.

BiosReleaseDate: The release date of the client computer's BIOS firmware.

ProcessorArchitecture: The architecture of the client computer's CPU. Unlike the ProcessorArchitecture element used in the ReportEventBatch method (described in section 2.2.2.3.1), the ProcessorArchitecture element of the RegisterComputer method is not an enumeration; there is no predefined set of values, and a given client need not use the same value for ProcessorArchitecture in the ReportEventBatch method that it uses for the RegisterComputer method.

SuiteMask, OldProductType, NewProductType, SystemMetrics: Operating system properties that help the server identify the name of the client's operating system. These elements SHOULD <13> be present.

ClientVersionMajorNumber: The Windows Update Agent (WUA) major version number. This is the first part in the four-part WUA version string. This element SHOULD be present.

ClientVersionMinorNumber: The WUA minor version number. This is the second part in the four-part WUA version string. This element SHOULD be present.

ClientVersionBuildNumber: The WUA build number. This is the third part in the four-part WUA version string. This element SHOULD be present.

ClientVersionQfeNumber: The WUA QFE number. This is the fourth part in the four-part WUA version string. This element SHOULD be present.

The following elements SHOULD <14> be present.

OSDescription: The commercial name of the operating system including the edition.

OEM: The original equipment manufacturer of the client device.

DeviceType: The model of the client device.

FirmwareVersion: The firmware version of the client device; for example 2040.0021.12522.211.

MobileOperator: For devices with mobile SKUs only. This is the current mobile operator of the device. The field is in form xxx-yy where xxx is the alphanumeric mobile operator ID and yy is the country code. For example: 000-88 (World-wide Open Market), or VZW-US (Verizon Wireless).

Response:

 <s:element name="RegisterComputerResponse">
   <s:complexType />
 </s:element>

This type has no fields.

2.2.2.2.3 RegisterComputer

Additional resources