GetSystemPatchLevel

Examines the operating system patch level and queries if it is up to date. Recommended asynchronous implementation.

Syntax

Method ID

#define WAAPI_MID_GET_SYSTEM_PATCH_LEVEL 50550

JSON Input Structure

{
  "input": {
    "method": 50550,
    "tolerance": number,
    "force_timeout": number
  }
}

Input Properties

Parameter	Type	Description
`tolerance`	number	(optional) A tolerance factor that can be used to loosen the 'is_current' metric. The default tolerance value is '1'.
`force_timeout`	number	(optional) A timeout value in seconds that can be set per method call, recommended that the value be at least 120 seconds. The default value is set off the server timeout configuration value.

JSON Output Structure

{
  "result": {
    "method": 50550,
    "code": number,
    "timing": number,
    "timestamp": string,
    "is_current": boolean,
    "count_behind": number,
    "is_missing_service_pack": boolean,
    "details": {
      "ie_count_behind": number,
      "dot_net_count_behind": number
    }
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.is_current`	boolean	True if the system is up to date.
`result.count_behind`	number	The number of patches the operating system is behind. Value 0 means that the system is up-to-date.
`result.is_missing_service_pack`	boolean	(optional) Whether there is a service pack amongs missing patches or not.
`result.details`	object	(optional) Detail information about the missing patches
`result.details.ie_count_behind`	number	(optional) Number of missing patches for Internet Explorer. Only on Windows.
`result.details.dot_net_count_behind`	number	(optional) Number of missing patches for .NET Framework. Only on Windows.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​