Open Specifications

https://learn.microsoft.com/en-us/openspecs/
Admin
Microsoft's Open Specifications program offers free access to technical documents detailing...
Tokens:8,063,371
Snippets:30,788
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Common Configuration Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-drsr/0ed8c294-a1d3-425b-81c7-8b9d61cee13d

Provides a practical example of a common configuration setup within the directory services context.

```APIDOC
## Common Configuration Example

### Description
This section illustrates a typical configuration scenario, demonstrating how various components and settings are applied in practice.

### Method
N/A (Example)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

--------------------------------

### Printer Setup Sequence: Get All Dev Caps Request and Response

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpexps/5d69422d-0a50-40d4-bb4e-f4aa78151aab

Illustrates the process of retrieving all device capabilities for a printer. It includes the Get All Dev Caps Request from the server and the subsequent Get All Dev Caps Response from the client, detailing the structure and fields related to device capabilities.

```text
ChannelName = XPSRD,12,server to client
00000000 00 00 00 00 00 00 00 00 01 01 00 00 .......

00 00 00 00 -> InterfaceId = 0x00000000
00 00 00 00 -> MessageId = 0x00000000
01 01 00 00 -> GET_ALL_DEV_CAPS_REQ = 0x00000101


(4) Get All Dev Caps Response
ChannelName = XPSRD,8564,client to server
00000000 00 00 00 00 00 00 00 00 24 00 00 00 ........$

00 00 00 00 -> InterfaceId = 0x00000000
00 00 00 00 -> MessageId = 0x00000000
24 00 00 00 -> numCaps = 0x00000024

                                          ff ff ff ff ........$.......
00000010 00 00 00 00 00 00 00 00 

ff ff ff ff -> TSDEVICE_CAPABILITIES: ReturnValue
00 00 00 00 -> TSDEVICE_CAPABILITIES: ErrorCode = ERROR_SUCCESS
00 00      -> TSDEVICE_CAPABILITIES: numBytes = 0
           -> TSDEVICE_CAPABILITIES: Data(variable length=0)
00 00      -> TSDEVICE_CAPABILITIES: numBytes2 = 0

                                          53 ff 81 03 00 00 00 00 ........S.......
00000020 00 00 00 00 

53 ff 81 03 -> TSDEVICE_CAPABILITIES: ReturnValue = 0x0381ff53
00 00 00 00 -> TSDEVICE_CAPABILITIES: ErrorCode = ERROR_SUCCESS
00 00      -> TSDEVICE_CAPABILITIES: numBytes = 0
            -> TSDEVICE_CAPABILITIES: Data(variable length=0)
00 00      -> TSDEVICE_CAPABILITIES: numBytes2 = 0

                                          19 00 00 00 00 00 00 00 32 00 01 00 ............2...
00000030 05 00 06 00 07 00 08 00 09 00 0b 00 0c 00 0d 00 ................
00000040 11 00 14 00 18 00 1b 00 1c 00 22 00 25 00 42 00 ..........".%.B.
00000050 52 00 81 00 84 00 87 00 94 00 5e 01 d7 01 ff 7f R.........^.....
00000060 32 00 

19 00 00 00 -> TSDEVICE_CAPABILITIES: ReturnValue
00 00 00 00 -> TSDEVICE_CAPABILITIES: ErrorCode = ERROR_SUCCESS
32 00      -> TSDEVICE_CAPABILITIES: numBytes = 0x32
            -> TSDEVICE_CAPABILITIES: Data (variable length=0x32)
32 00      -> TSDEVICE_CAPABILITIES: numBytes2 = 0x32


(skipped)

00002160 00 00 14 01 00 00 15 01 00 00 16 01 00 00 5c 00 ..............\.
00002170 00 00 00 00 ....

00 00 00 00 - Result = S_OK
```

--------------------------------

### Pre-login Request Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-tds/e710eb18-043a-44de-b864-8f1ee8656614

This snippet illustrates an example of a pre-login request. It outlines the initial communication from the client to the server before a full login is established. This example is key to understanding the early stages of client-server connection setup.

```Network Protocol
Pre-login request example
```

--------------------------------

### Web Part Authoring Example

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-wpps/8819a33e-6389-4b00-8215-1d3fce5108bf

This example focuses on the authoring of Web Parts. It likely covers the creation and initial setup of Web Parts, providing guidance for developers. The specific programming language or API is not detailed here.

```text
Web Part authoring example
```

--------------------------------

### Installation and Configuration

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Endpoints related to checking installation status, setting operating modes, managing scheduled updates, and uninstalling components.

```APIDOC
## IsInstalled

### Description
Checks if a component or feature is installed.

### Method
SOAP

### Endpoint
N/A (SOAP)

### Parameters
#### Request Body
- **parameters** (element: tns:IsInstalled) - The request element for checking installation status.

### Request Example
```xml
<IsInstalled xmlns="http://schemas.microsoft.com/...">
  <!-- Additional parameters if any -->
</IsInstalled>
```

### Response
#### Success Response (200)
- **parameters** (element: tns:IsInstalledResponse) - The response element indicating installation status.

#### Response Example
```xml
<IsInstalledResponse xmlns="http://schemas.microsoft.com/...">
  <!-- Installation status details -->
</IsInstalledResponse>
```

## SetMode

### Description
Sets the operating mode for a component or feature.

### Method
SOAP

### Endpoint
N/A (SOAP)

### Parameters
#### Request Body
- **parameters** (element: tns:SetMode) - The request element for setting the mode.

### Request Example
```xml
<SetMode xmlns="http://schemas.microsoft.com/...">
  <!-- Mode settings -->
</SetMode>
```

### Response
#### Success Response (200)
- **parameters** (element: tns:SetModeResponse) - The response element confirming the mode change.

#### Response Example
```xml
<SetModeResponse xmlns="http://schemas.microsoft.com/...">
  <!-- Confirmation details -->
</SetModeResponse>
```

## SetScheduledUpdateSettings

### Description
Configures settings for scheduled updates.

### Method
SOAP

### Endpoint
N/A (SOAP)

### Parameters
#### Request Body
- **parameters** (element: tns:SetScheduledUpdateSettings) - The request element for configuring scheduled updates.

### Request Example
```xml
<SetScheduledUpdateSettings xmlns="http://schemas.microsoft.com/...">
  <!-- Update settings -->
</SetScheduledUpdateSettings>
```

### Response
#### Success Response (200)
- **parameters** (element: tns:SetScheduledUpdateSettingsResponse) - The response element confirming the update settings configuration.

#### Response Example
```xml
<SetScheduledUpdateSettingsResponse xmlns="http://schemas.microsoft.com/...">
  <!-- Confirmation details -->
</SetScheduledUpdateSettingsResponse>
```

## Uninstall

### Description
Uninstalls a component or feature.

### Method
SOAP

### Endpoint
N/A (SOAP)

### Parameters
#### Request Body
- **parameters** (element: tns:Uninstall) - The request element for initiating uninstallation.

### Request Example
```xml
<Uninstall xmlns="http://schemas.microsoft.com/...">
  <!-- Uninstall parameters -->
</Uninstall>
```

### Response
#### Success Response (200)
- **parameters** (element: tns:UninstallResponse) - The response element confirming the uninstallation.

#### Response Example
```xml
<UninstallResponse xmlns="http://schemas.microsoft.com/...">
  <!-- Uninstallation confirmation -->
</UninstallResponse>
```
```

--------------------------------

### Install - XSD Definition

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Defines the XML structure for the Install operation. This operation is used to initiate the installation process and does not take any input parameters.

```xml
<xsd:element name="Install">
        <xsd:complexType />
      </xsd:element>
      <xsd:element name="InstallResponse">
        <xsd:complexType/>
      </xsd:element>
```

--------------------------------

### HTTP Request Example for Protocol Usage

Source: https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-pwphp/e986c4de-7ed4-4fb7-998e-9b52bb296757

This snippet shows the HTTP GET request sent by a client to retrieve information about slide 256 of a presentation. It includes necessary headers like Accept, Host, and Connection.

```HTTP
GET http:// www.contoso.com/p/presentation.ashx?Pid=http://www.contoso.com/documents/loremipsum.pptx&ct=slide&wdSlideId=256 HTTP/1.1
Accept: */*
Host: contoso.com
Connection: Keep-Alive
```

--------------------------------

### Get Term Sets by GUID

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-emmwcf/9af7c8c9-edbe-4fef-ba9b-b69b03a40d1f

This endpoint retrieves term sets from the SharePoint taxonomy service based on provided term set GUIDs. It requires a raw partition ID and a list of term set GUIDs.

```APIDOC
## POST /_vti_bin/client.svc/GetTermSets

### Description
Retrieves term sets from the SharePoint taxonomy service based on provided term set GUIDs.

### Method
POST

### Endpoint
http://SERVER/b77ccb6b285d41c68335fb6d8f7d8e3e/MetadataWebService.svc

### Parameters
#### Request Body
- **rawPartitionId** (string) - Required - The partition ID of the term store.
- **termSetGuids** (array of GUIDs) - Required - A list of GUIDs for the term sets to retrieve.

### Request Example
```xml
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
  <s:Header>
    <a:Action s:mustUnderstand="1">http://schemas.microsoft.com/sharepoint/taxonomy/soap/IDataAccessReadOnly/GetTermSets</a:Action>
    <a:MessageID>urn:uuid:4978e393-2f00-46d1-b9de-d4b63b16adcc</a:MessageID>
    <a:ReplyTo>
      <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
    </a:ReplyTo>
    <ServiceContext xmlns="http://schemas.microsoft.com/sharepoint/servicecontext" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
      <correlationId>033747f4-70e9-4250-8744-682a5b9e4f44</correlationId>
      <locale>en-US</locale>
      <siteSubscriptionId>00000000-0000-0000-0000-000000000000</siteSubscriptionId>
    </ServiceContext>
    <a:To s:mustUnderstand="1">http://SERVER/b77ccb6b285d41c68335fb6d8f7d8e3e/MetadataWebService.svc</a:To>
  </s:Header>
  <s:Body>
    <GetTermSets xmlns="http://schemas.microsoft.com/sharepoint/taxonomy/soap/">
      <rawPartitionId>8CDCD08F-1C05-4d17-AE04-FC19E918E32B</rawPartitionId>
      <termSetGuids xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <b:guid>60936ba7-8be1-43b7-83d6-87fb85be6ca9</b:guid>
      </termSetGuids>
    </GetTermSets>
  </s:Body>
</s:Envelope>
```

### Response
#### Success Response (200)
- **GetTermSetsResult** (object) - Contains the retrieved term set data.
  - **Root** (object) - Represents the root of the term set structure.
    - **G** (array of objects) - Group information within the term set.
    - **NextResult** (object) - Placeholder for subsequent results.
    - **GTSIds** (object) - IDs for the term sets.
    - **TS** (object) - Represents a specific term set.

#### Response Example
```xml
<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
  <s:Header>
    <a:Action s:mustUnderstand="1">http://schemas.microsoft.com/sharepoint/taxonomy/soap/IDataAccessReadOnly/GetTermSetsResponse</a:Action>
    <ActivityId CorrelationId="40439e5b-e097-488f-90f0-8a4d680207ba" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">9b90d173-3614-4e83-bd66-32c6b3c1c95b</ActivityId>
  </s:Header>
  <s:Body>
    <GetTermSetsResponse xmlns="http://schemas.microsoft.com/sharepoint/taxonomy/soap/">
      <GetTermSetsResult>
        <Root>
          <G a6="3" a0="8CDCD08F-1C05-4d17-AE04-FC19E918E32B" a9="5e89a57f-e7c6-49b8-ad32-a761817c9233" a12="new group" a11="" a8="2009-06-29T21:44:13.397Z" a7="2009-06-29T21:43:55.197Z" a15="0" />
          <NextResult />
          <NextResult />
          <GTSIds a1="3" a6="4" />
          <NextResult />
          <TS a6="4" a0="8CDCD08F-1C05-4d17-AE04-FC19E918E32B" a7="2009-06-29T21:44:13.397Z" a8="2009-06-29T21:44:13.397Z" a14="USERNAME" a9="60936ba7-8be1-43b7-83d6-87fb85be6ca9" a12="new term set" a11="" a15="0" a16="False" a17="True" a18="" a68="" a1="3" />
          <NextResult />
        </Root>
      </GetTermSetsResult>
    </GetTermSetsResponse>
  </s:Body>
</s:Envelope>
```
```

--------------------------------

### Onboard Virtual Desktop

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Initiates the onboarding process for a virtual desktop.

```APIDOC
## POST /api/virtual-desktops/onboard

### Description
Initiates the onboarding process for a virtual desktop. This typically involves registration and configuration steps.

### Method
POST

### Endpoint
/api/virtual-desktops/onboard

### Parameters

#### Query Parameters
None

#### Request Body
- **desktopDetails** (object) - Required - Details about the virtual desktop to onboard.
  - **desktopId** (string) - Required - The unique identifier for the virtual desktop.
  - **user** (string) - Optional - The user associated with the desktop.
  - **configuration** (object) - Optional - Configuration parameters for the desktop.
```

--------------------------------

### OnboardVirtualDesktop

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Initiates the onboarding process for a virtual desktop. This operation prepares a new virtual machine for user assignment and operation within the virtual desktop infrastructure.

```APIDOC
## POST /OnboardVirtualDesktop

### Description
Initiates the onboarding process for a virtual desktop.

### Method
POST

### Endpoint
/OnboardVirtualDesktop

### Parameters
#### Request Body
- **parameters** (object) - Required - Contains the parameters for the OnboardVirtualDesktop operation.

### Request Example
```json
{
  "parameters": {
    "VirtualDesktopID": "string",
    "UserSessionID": "string"
  }
}
```

### Response
#### Success Response (200)
- **OnboardVirtualDesktopResponse** (object) - Contains the result of the onboarding operation.

#### Response Example
```json
{
  "OnboardVirtualDesktopResponse": {
    "Status": "Success"
  }
}
```
```

--------------------------------

### HTTP GET Request Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-n2ht/9201ed70-d245-41ce-accd-e609637583bf

An example of an HTTP 1.1 client requesting a resource using the GET method.

```APIDOC
## GET /test.htm HTTP/1.1

### Description
An HTTP 1.1 client requests a resource from a server using the GET method.

### Method
GET

### Endpoint
/test.htm

### Headers
- **User-Agent**: WHttpTst Test Harness
- **Host**: webctestlive.ntdev.corp.microsoft.com:543

### Request Example
```
GET /test.htm HTTP/1.1
User-Agent: WHttpTst Test Harness
Host: webctestlive.ntdev.corp.microsoft.com:543
```
```

--------------------------------

### HTTP GET Request Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-n2ht/9201ed70-d245-41ce-accd-e609637583bf

An HTTP 1.1 client sends a GET request to a server for a specific resource ('test.htm'). This example shows the basic structure of a GET request, including the User-Agent and Host headers.

```http
GET /test.htm HTTP/1.1
User-Agent: WHttpTst Test Harness
Host: webctestlive.ntdev.corp.microsoft.com:543

```

--------------------------------

### Onboard Virtual Desktop

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Initiates the onboarding process for a virtual desktop on the MultiPoint Server.

```APIDOC
## POST /OnboardVirtualDesktop

### Description
Initiates the onboarding process for a virtual desktop on the MultiPoint Server.

### Method
POST

### Endpoint
/OnboardVirtualDesktop

### Parameters
#### Query Parameters
- None

#### Request Body
- **VirtualDesktopName** (string) - Required - The name or identifier of the virtual desktop to onboard.

### Request Example
```json
{
  "VirtualDesktopName": "Desktop1"
}
```

### Response
#### Success Response (200)
- **Status** (string) - Indicates the success of the onboarding operation.

#### Response Example
```json
{
  "Status": "Onboarding initiated successfully."
}
```

#### Error Response (e.g., 500)
- **WmsFault** (object) - Contains details about the fault.
  - **Message** (string) - Error message.
  - **Detail** (string) - Detailed error information.
```
```

--------------------------------

### OnboardVirtualDesktop API

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Onboards a virtual desktop to the WMS environment.

```APIDOC
## POST /OnboardVirtualDesktop

### Description
Onboards a virtual desktop into the Windows Multipoint Server environment. This typically involves preparing a VM to be used as a virtual desktop.

### Method
POST

### Endpoint
/OnboardVirtualDesktop

### Parameters
#### Query Parameters
N/A

#### Request Body
- **VirtualMachineName** (String) - Required - The name of the virtual machine to onboard.
- **DesktopTemplate** (String) - Optional - The template to use for the virtual desktop.

### Request Example
```json
{
  "VirtualMachineName": "NewVM01",
  "DesktopTemplate": "DefaultTemplate"
}
```

### Response
#### Success Response (200)
- **Status** (String) - Indicates the success or failure of the onboarding operation.

#### Response Example
```json
{
  "Status": "Onboarding successful."
}
```
```

--------------------------------

### SetupID (Setup ID) Specification

Source: https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/5d9bac8e-6400-4d74-87a5-1add40e8c67a

Details the specification for the SetupID element, which specifies a GUID for cross-referencing with the GUID of the signature line stored in the document content.

```APIDOC
## SetupID (Setup ID)

### Description
Specifies a GUID which can be cross-referenced with the GUID of the signature line stored in the document content.

### Method
N/A (Data Specification)

### Endpoint
N/A (Data Specification)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **SetupID** (string) - A GUID that can be cross-referenced with the GUID of the signature line stored in the document content.

#### Response Example
```json
{
  "SetupID": "{123e4567-e89b-12d3-a456-426614174000}"
}
```

### Additional Information
- The possible values for this element are defined by the ST_UniqueIdentifierWithBraces simple type.
- Parent Element: SignatureInfoV1
```

--------------------------------

### WSDL Definitions for Installation and Update Operations

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

These WSDL message definitions specify the input and output parameters for operations related to installation and update management, such as checking if a component is installed, setting update modes, and uninstalling.

```xml
<wsdl:message name="IsInstalledSoapOut">
    <wsdl:part name="parameters" element="tns:IsInstalledResponse" />
  </wsdl:message>
  <wsdl:message name="SetModeSoapIn">
    <wsdl:part name="parameters" element="tns:SetMode" />
  </wsdl:message>
  <wsdl:message name="SetModeSoapOut">
    <wsdl:part name="parameters" element="tns:SetModeResponse" />
  </wsdl:message>
  <wsdl:message name="SetScheduledUpdateSettingsSoapIn">
    <wsdl:part name="parameters" element="tns:SetScheduledUpdateSettings" />
  </wsdl:message>
  <wsdl:message name="SetScheduledUpdateSettingsSoapOut">
    <wsdl:part name="parameters" element="tns:SetScheduledUpdateSettingsResponse" />
  </wsdl:message>
  <wsdl:message name="UninstallSoapIn">
    <wsdl:part name="parameters" element="tns:Uninstall" />
  </wsdl:message>
  <wsdl:message name="UninstallSoapOut">
    <wsdl:part name="parameters" element="tns:UninstallResponse" />
  </wsdl:message>
```

--------------------------------

### HTTP GET Request with Authorization Header Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-n2ht/9201ed70-d245-41ce-accd-e609637583bf

An example of an HTTP 1.1 client requesting a resource with authentication credentials.

```APIDOC
## GET /test.htm HTTP/1.1 with Authorization

### Description
The HTTP 1.1 client issues an HTTP GET request for a resource and provides authentication information in the `Authorization` header.

### Method
GET

### Endpoint
/test.htm

### Headers
- **User-Agent**: WHttpTst Test Harness
- **Host**: webctestlive.ntdev.corp.microsoft.com:543
- **Authorization**: Nego2 YIIEawYGKwYBBQUCoIIEXzCCBFugDjAMBgorBg ...

### Request Example
```
GET /test.htm HTTP/1.1
User-Agent: WHttpTst Test Harness
Host: webctestlive.ntdev.corp.microsoft.com:543
Authorization: Nego2 YIIEawYGKwYBBQUCoIIEXzCCBFugDjAMBgorBg ...
```
```

--------------------------------

### Onboard Virtual Desktop

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Onboards a virtual desktop, returning SSL details and a control password.

```APIDOC
## POST /api/virtualdesktops/onboard

### Description
Onboards a virtual desktop with the provided virtual machine ID and remote FQDN. The response includes SSL port, certificate thumbprint, certificate, and control/management passwords.

### Method
POST

### Endpoint
/api/virtualdesktops/onboard

### Parameters
#### Request Body
- **virtualMachineId** (string) - Required - The ID of the virtual machine.
- **remoteFqdn** (string) - Required - The fully qualified domain name of the remote desktop.

### Request Example
```json
{
  "virtualMachineId": "vm-1234",
  "remoteFqdn": "remote.example.com"
}
```

### Response
#### Success Response (200)
- **sslPort** (unsignedInt) - The SSL port for the virtual desktop.
- **sslCertificateThumbprint** (string) - The thumbprint of the SSL certificate.
- **sslCertificate** (ArrayOfBytes) - The SSL certificate in byte array format.
- **wmsControlPassword** (string) - The control password for the WMS.
- **wmsManagementPassword** (string) - The management password for the WMS.

#### Response Example
```json
{
  "sslPort": 443,
  "sslCertificateThumbprint": "a1b2c3d4e5f6...",
  "sslCertificate": [255, 255, 255],
  "wmsControlPassword": "control_password_example",
  "wmsManagementPassword": "management_password_example"
}
```
```

--------------------------------

### Creating an LobSystem Example - C#

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-bdcrawps/0b88d579-6022-4c97-92f1-f2e1c9952c4b

This example demonstrates the process of creating a new LobSystem (Line of Business System) within the Microsoft Business Data Catalog using C#. It involves defining the connection and configuration for an external system.

```csharp
// Example code for creating an LobSystem would go here.
// This involves using BDC administration APIs to define and register an LobSystem.
```

--------------------------------

### Get Default Installation Index Location

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-admws/3b6d8b33-0932-459e-81b0-22305e42998b

Retrieves the default installation index location.

```APIDOC
## GET /api/defaultInstallationIndexLocation

### Description
Retrieves the default location where the installation index is stored.

### Method
GET

### Endpoint
/api/defaultInstallationIndexLocation

### Response
#### Success Response (200)
- **DefaultInstallationIndexLocationResult** (string) - The default installation index location path.

#### Response Example
```json
{
  "DefaultInstallationIndexLocationResult": "/opt/learn/index"
}
```
```

--------------------------------

### HTTP GET Request with Authorization Header Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-n2ht/9201ed70-d245-41ce-accd-e609637583bf

An HTTP 1.1 client sends a GET request to a server, including an Authorization header. This header is used to provide authentication credentials to the server, in this case, using the Nego2 scheme.

```http
GET /test.htm HTTP/1.1
User-Agent: WHttpTst Test Harness
Host: webctestlive.ntdev.corp.microsoft.com:543
Authorization: Nego2 YIIEawYGKwYBBQUCoIIEXzCCBFugDjAMBgorBg ...

```

--------------------------------

### BeginPublish Operation

Source: https://learn.microsoft.com/en-us/openspecs/sql_server_protocols/ms-ssdpwp/7f117d12-8776-47a8-b8a5-5de1b67b4f86

Initiates a database publishing session. The client provides server connection details and user credentials.

```APIDOC
## POST /Database%20Publsihing%20Services%201.1/Publish/Service.asmx

### Description
Initiates a database publishing session. The client provides server connection details and user credentials.

### Method
POST

### Endpoint
/Database%20Publsihing%20Services%201.1/Publish/Service.asmx

### Parameters
#### Request Body
- **serverName** (string) - Required - The name of the server.
- **databaseName** (string) - Required - The name of the database.
- **sqlUsername** (string) - Required - The SQL username.
- **sqlPassword** (string) - Required - The SQL password.
- **useTransactions** (boolean) - Required - Whether to use transactions.

### Request Example
```xml
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BeginPublish 
xmlns="http://schemas.microsoft.com/sqlserver/2006/12/publishing">
      <serverName>myServer</serverName>
      <databaseName>myDatabase</databaseName>
      <sqlUsername>myUsername</sqlUsername>
      <sqlPassword>myPassword</sqlPassword>
      <useTransactions>true</useTransactions>
    </BeginPublish>
  </soap:Body>
</soap:Envelope>
```

### Response
#### Success Response (200)
- **BeginPublishResponse** - An empty element indicating success.

#### Response Example
```xml
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <BeginPublishResponse 
xmlns="http://schemas.microsoft.com/sqlserver/2006/12/publishing" />
  </soap:Body>
</soap:Envelope>
```
```

--------------------------------

### PeerDist Content Encoding - Client Hash Request Example

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-pccrtp/9707c2c9-cb97-4368-893a-69caf736bc25

Example of a client's GET request including the X-P2P-PeerDistEx header to make a hash request.

```APIDOC
## GET /welcome.png HTTP/1.1

### Description
Client sends a hash request to the server using the X-P2P-PeerDistEx header.

### Method
GET

### Endpoint
/welcome.png

### Headers
- **Host**: www.example.com
- **X-P2P-PeerDist**: Version=1.1
- **X-P2P-PeerDistEx**: MinContentInformation=1.0, MaxContentInformation=2.0, HashRequest=true

### Request Example
```http
 GET /welcome.png HTTP/1.1
 Host: www.example.com
 X-P2P-PeerDist: Version=1.1
 X-P2P-PeerDistEx: MinContentInformation=1.0, MaxContentInformation=2.0, HashRequest=true
```
```

--------------------------------

### Construct URL for Editing Existing Room (de-DE, GUID)

Source: https://learn.microsoft.com/en-us/openspecs/office_protocols/ms-ocgcweb/ddb83d8d-662d-4260-9208-ca5c012185a9

This example demonstrates constructing a URL for editing an existing room. It appends both the 'de-DE' language parameter and the room's unique GUID to the base URL. This is essential for targeting a specific room for modification.

```text
http://example.com/rm/?clientlang=de-DE&id=61E092C7-89BB-4DC4-A3F5-8C23FA940FAB
```

--------------------------------

### Upload Workflow to Server Example

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-wpps/8819a33e-6389-4b00-8215-1d3fce5108bf

This example illustrates the process of uploading a workflow to the server. It's a key operation for deploying workflows. The code snippet is a placeholder indicating the existence of such an example.

```text
Upload the workflow to the server example
```

--------------------------------

### Examples - Status and Control

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpesc/fd954469-654f-4487-a6d3-b7d5548a5875

Provides examples for getting the status of smart cards and controlling reader states.

```APIDOC
## Status and Control Examples

This section provides examples for retrieving status information and controlling reader states.

### Get Status Change Call Example

```json
{
  "hContext": "0x87654321",
  "dwTimeout": 5000,
  "rgReaderStates": [
    {
      "szReader": "MyReader1",
      "dwCurrentState": "SCARD_STATE_UNAWARE"
    }
  ]
}
```

### Get Status Change Return Example

```json
{
  "rgReaderStates": [
    {
      "szReader": "MyReader1",
      "dwCurrentState": "SCARD_STATE_PRESENT",
      "dwEventState": "SCARD_STATE_PRESENT"
    }
  ]
}
```

### Get Status ChangeA_Call structure

- **hContext** (handle) - The context handle.
- **dwTimeout** (number) - The timeout value in milliseconds.
- **rgReaderStates** (array of objects) - An array of reader state structures.

### GetStatusChange_Return

- **rgReaderStates** (array of objects) - An array of updated reader state structures.

```

--------------------------------

### WSDL Installation and Status Messages

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Defines WSDL messages for software installation and checking installation status. The messages are for 'Install' and 'IsInstalled' operations, specifying input and output parameters. These are standard WSDL definitions and do not require specific programming language code for their definition.

```wsdl
<wsdl:message name="InstallSoapIn">
    <wsdl:part name="parameters" element="tns:Install" />
  </wsdl:message>
  <wsdl:message name="InstallSoapOut">
    <wsdl:part name="parameters" element="tns:InstallResponse" />
  </wsdl:message>

  <wsdl:message name="IsInstalledSoapIn">

```

--------------------------------

### Printer Setup Sequence: Initialize Printer Request and Response

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpexps/5d69422d-0a50-40d4-bb4e-f4aa78151aab

Demonstrates the initial handshake for printer setup, including the Initialize Printer Request from the server to the client and the corresponding Initialize Printer Response. This sequence establishes communication for printer-related operations.

```text
ChannelName = XPSRD,16,server to client
00000000 00 00 00 00 00 00 00 00 00 01 00 00 0d 00 00 00 ................

00 00 00 00 -> InterfaceId = 0x00000000
00 00 00 00 -> MessageId = 0x00000000
00 01 00 00 -> INIT_PRINTER_REQ = 0x00000100
0d 00 00 00 -> ClientPrinterId = 0x0000000d


(2) Initialize Printer Response
ChannelName = XPSRD,12,client to server
00000000 00 00 00 00 00 00 00 00 00 00 00 00 .......

00 00 00 00 -> InterfaceId = 0x00000000
00 00 00 00 -> MessageId = 0x00000000
00 00 00 00 -> Result = S_OK
```

--------------------------------

### Get User Profile By GUID

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-uspsws/33726bb3-f692-4e1c-b756-e77c300cdcbf

Retrieves a user profile using their unique identifier (GUID).

```APIDOC
## POST /api/GetUserProfileByGuid

### Description
Retrieves a user's profile information using their globally unique identifier (GUID).

### Method
POST

### Endpoint
/api/GetUserProfileByGuid

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **guid** (string) - Required - The GUID of the user whose profile to retrieve.

### Request Example
```json
{
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (200)
- **profileData** (object) - Contains the user's profile information.

#### Response Example
```json
{
  "profileData": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane.smith@example.com"
  }
}
```
```

--------------------------------

### Is Installed - XSD Definition

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Defines the XML structure for the IsInstalled operation. This operation checks if the software is installed and returns a boolean value indicating the installation status.

```xml
<xsd:element name="IsInstalled">
        <xsd:complexType />
      </xsd:element>
      <xsd:element name="IsInstalledResponse">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element minOccurs="1" maxOccurs="1" name="pfIsInstalled" type="xsd:boolean" />
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
```

--------------------------------

### Retrieve Term Set by GUID

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-emmwcf/9af7c8c9-edbe-4fef-ba9b-b69b03a40d1f

This endpoint retrieves a specific term set using its unique identifier (GUID).

```APIDOC
## POST /MetadataWebService.svc/GetTermSets

### Description
Retrieves a term set by its GUID. This is part of the read-only operations for the taxonomy service.

### Method
POST

### Endpoint
http://SERVER/b77ccb6b285d41c68335fb6d8f7d8e3e/MetadataWebService.svc

### Parameters
#### Request Body
```xml
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
 <s:Header>
  <a:Action s:mustUnderstand="1">http://schemas.microsoft.com/sharepoint/taxonomy/soap/IDataAccessReadOnly/GetTermSets</a:Action>
  <a:MessageID>urn:uuid:7637ed0a-4250-43a6-82f4-016270fced49</a:MessageID>
  <a:ReplyTo>
   <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
  </a:ReplyTo>
  <ServiceContext xmlns="http://schemas.microsoft.com/sharepoint/servicecontext" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <correlationId>...</correlationId>
   <locale>en-US</locale>
   <siteSubscriptionId>00000000-0000-0000-0000-000000000000</siteSubscriptionId>
  </ServiceContext>
  <a:To s:mustUnderstand="1">http://SERVER/b77ccb6b285d41c68335fb6d8f7d8e3e/MetadataWebService.svc</a:To>
 </s:Header>
 <s:Body>
  <GetTermSets xmlns="http://schemas.microsoft.com/sharepoint/taxonomy/soap/">
   <partitionId>8CDCD08F-1C05-4d17-AE04-FC19E918E32B</partitionId>
   <termSetId>019bfde5-af07-4532-8f39-64774b5bfe92</termSetId>
  </GetTermSets>
 </s:Body>
</s:Envelope>
```

### Response
#### Success Response (200)
Returns the details of the requested term set.

#### Response Example
(Response example not provided in the input text)
```

--------------------------------

### Prepare CA Database Backup

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-csra/0e08a3d1-7d8e-4760-8160-a57ffadc4b13

This snippet shows the client initiating the CA database backup process by calling the ICertAdminD::BackupPrepare method. It includes parameters for the CA name and other settings, expecting S_OK (0) on success.

```cpp
ICertAdminD::BackupPrepare( L"RootCA", 0, 0, NULL, 0 )
```

--------------------------------

### OnboardVirtualDesktop WSDL Operation

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Defines the operations for onboarding a virtual desktop, including input, output, and fault messages.

```xml
<wsdl:operation name="OnboardVirtualDesktop">
      <wsdl:input wsaw:Action="http://MultiPoint/RemoteManagement/IMultiPointServer/OnboardVirtualDesktop" message="tns:OnboardVirtualDesktopSoapIn" />
      <wsdl:output wsaw:Action="http://MultiPoint/RemoteManagement/IMultiPointServer/OnboardVirtualDesktopResponse" message="tns:OnboardVirtualDesktopSoapOut" />
      <wsdl:fault name="WmsFault" wsaw:Action="http://MultiPoint/RemoteManagement/WmsFault" message="tns:WmsFaultMessage" />
    </wsdl:operation>
```

--------------------------------

### Excel PivotTable BrtBeginPivotCacheRecords Examples

Source: https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xlsb/b4988d7e-ace2-49b5-a072-1be442bfa193

Examples demonstrating the BrtBeginPivotCacheRecords structure in Excel PivotTables, marking the start of records for a PivotCache.

```Excel
PivotTable:BrtBeginPivotCacheRecords example
```

--------------------------------

### Excel PivotTable BrtBeginPivotCacheDef Examples

Source: https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-xlsb/b4988d7e-ace2-49b5-a072-1be442bfa193

Examples related to BrtBeginPivotCacheDef in Excel PivotTables, indicating the start of a PivotCache definition record.

```Excel
PivotTable:BrtBeginPivotCacheDef example
```

--------------------------------

### StartAsyncProvisioning API

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-ipamm/4fdb6e51-a939-45d9-b41f-ed1cf259f44f

Initiates the asynchronous provisioning task in IPAM.

```APIDOC
## POST /api/ipam/provision/async/start

### Description
Begins the asynchronous provisioning operation within IPAM.

### Method
POST

### Endpoint
/api/ipam/provision/async/start

### Parameters

#### Request Body
- **provisioningId** (string) - Required - The ID of the provisioning process to start.

### Request Example
```json
{
  "provisioningId": "async-prov-123"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that provisioning has started.
```

--------------------------------

### Get Station Split Screen Information

Source: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rsmc/272976f1-abd8-471b-b4fd-9f6b891e02fd

Retrieves information about the split-screen configuration of a station.

```APIDOC
## GET /api/stations/{stationId}/splitScreenInfo

### Description
Retrieves information about the split-screen configuration of a specific station.

### Method
GET

### Endpoint
/api/stations/{stationId}/splitScreenInfo

### Parameters
#### Path Parameters
- **stationId** (string) - Required - The unique identifier of the station.

### Response
#### Success Response (200)
- **splitScreenInfo** (object) - Information about the station's split-screen setup.

#### Response Example
```json
{
  "splitScreenInfo": {
    "isEnabled": true,
    "layout": "4x1"
  }
}
```
```

--------------------------------

### AddView Web Method

Source: https://learn.microsoft.com/en-us/openspecs/sharepoint_protocols/ms-viewss/7c480a61-1a94-48b4-88e3-17fe73077f9a

Demonstrates the creation of a list view using the AddView Web method. Includes request and response structures.

```APIDOC
## AddView Web Method

### Description
This endpoint is used to create a new list view within a SharePoint list.

### Method
SOAP POST

### Endpoint
/Lists/ListA

### Parameters
#### Request Body
- **listName** (string) - Required - The GUID of the list where the view will be created.
- **viewName** (string) - Required - The name for the new view.
- **viewFields** (object) - Required - Specifies the fields to be included in the view.
  - **FieldRef** (object) - Represents a field to include.
    - **Name** (string) - Required - The name of the field.
- **query** (object) - Optional - Defines the query to filter and sort the view's data.
  - **Query** (object)
    - **OrderBy** (object) - Specifies the sorting order.
      - **FieldRef** (object)
        - **Name** (string) - Required - The name of the field to sort by.
- **rowLimit** (object) - Optional - Sets the row limit for the view.
  - **RowLimit** (object)
    - **Paged** (boolean) - Required - Indicates if pagination is enabled.
    - (text content) - The maximum number of rows.
- **type** (string) - Required - The type of the view (e.g., 'HTML').
- **makeViewDefault** (boolean) - Required - Whether to make this view the default view.

### Request Example
```xml
<AddView xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  <listName>{C2294E28-05B6-4486-804A-80F0189B992B}</listName>
  <viewName>ViewA</viewName>
  <viewFields>
    <ViewFields>
      <FieldRef Name='ID'/>
      <FieldRef Name='Title'/>
    </ViewFields>
  </viewFields>
  <query>
    <Query>
      <OrderBy>
        <FieldRef Name='ID'/>
      </OrderBy>
    </Query>
  </query>
  <rowLimit>
    <RowLimit Paged='TRUE'>100</RowLimit>
  </rowLimit>
  <type>HTML</type>
  <makeViewDefault>false</makeViewDefault>
</AddView>
```

### Response
#### Success Response (200)
- **AddViewResult** (object) - Contains the details of the newly created view.
  - **View** (object) - Represents the created view.
    - **Type** (string) - The type of the view.
    - **Url** (string) - The URL of the view.
    - **Personal** (string) - Indicates if the view is personal.
    - **DisplayName** (string) - The display name of the view.
    - **DefaultView** (string) - Indicates if this is the default view.
    - **Name** (string) - The internal name (GUID) of the view.
    - **Query** (object) - The query associated with the view.
    - **ViewFields** (object) - The fields included in the view.
    - **RowLimit** (object) - The row limit configuration.

#### Response Example
```xml
<AddViewResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  <AddViewResult>
    <View 
      Type='HTML' 
      Url='/Lists/ListA/ViewA.aspx' 
      Personal='FALSE' 
      DisplayName='ViewA' 
      DefaultView='FALSE' 
      Name='{4807AA00-190A-47CB-B2E0-8C13C04149BD}'>
      <Query>
        <OrderBy>
          <FieldRef Name='ID'/>
        </OrderBy>
      </Query>
      <ViewFields>
        <FieldRef Name='ID'/>
        <FieldRef Name='Title'/>
      </ViewFields>
      <RowLimit Paged='TRUE'>100</RowLimit>
    </View>
  </AddViewResult>
</AddViewResponse>
```
```
Tokens:
Raw