### Movement Functions

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

This section details the API endpoints related to controlling character movement within the game environment. These functions allow for actions such as stopping, starting, jumping, and steering.

```APIDOC
## Movement Functions API

### Description
Provides endpoints for controlling character movement.

### Endpoints

#### AscendStop

*   **Description**: Stops movement initiated by `JumpOrAscendStart`.
*   **Method**: Protected

#### DescendStop

*   **Description**: Stops movement initiated by `SitStandOrDescendStart`.
*   **Method**: Protected

#### FollowUnit

*   **Description**: Causes the player character to automatically follow another unit.
*   **Method**: Public

#### InteractUnit

*   **Description**: Interacts with a unit (similar to right-clicking).
*   **Method**: Protected

#### JumpOrAscendStart

*   **Description**: Causes the player character to jump or begin ascent (if swimming or flying).
*   **Method**: Protected

#### MoveAndSteerStart

*   **Description**: Begins moving the player character forward while steering with the mouse.
*   **Method**: Protected

#### MoveAndSteerStop

*   **Description**: Ends movement initiated by `MoveAndSteerStart`.
*   **Method**: Protected

#### MoveBackwardStart

*   **Description**: Begins moving the player character backward.
*   **Method**: Protected

#### MoveBackwardStop

*   **Description**: Ends movement initiated by `MoveBackwardStart`.
*   **Method**: Protected

#### MoveForwardStart

*   **Description**: Begins moving the player character forward.
*   **Method**: Protected

#### MoveForwardStop

*   **Description**: Ends movement initiated by `MoveForwardStart`.
*   **Method**: Protected

#### PitchDownStart

*   **Description**: Begins adjusting the player character's angle of vertical movement downward.
*   **Method**: Protected

#### PitchDownStop

*   **Description**: Ends movement initiated by `PitchDownStart`.
*   **Method**: Protected

#### PitchUpStart

*   **Description**: Begins adjusting the player character's angle of vertical movement upward.
*   **Method**: Protected

#### PitchUpStop

*   **Description**: Ends movement initiated by `PitchUpStart`.
*   **Method**: Protected

#### SitStandOrDescendStart

*   **Description**: Causes the player character to sit down if standing, stand up if sitting, or begin descent if swimming or flying.
*   **Method**: Public

#### StrafeLeftStart

*   **Description**: Begins moving the player character sideways to the left.
*   **Method**: Protected

#### StrafeLeftStop

*   **Description**: Ends movement initiated by `StrafeLeftStart`.
*   **Method**: Protected

#### StrafeRightStart

*   **Description**: Begins moving the player character sideways to the right.
*   **Method**: Protected

#### StrafeRightStop

*   **Description**: Ends movement initiated by `StrafeRightStart`.
*   **Method**: Protected

#### ToggleAutoRun

*   **Description**: Starts or stops the player character automatically moving forward.
*   **Method**: Protected

#### ToggleRun

*   **Description**: Switches the character's ground movement mode between running and walking.
*   **Method**: Protected

#### TurnLeftStart

*   **Description**: Begins turning the player character to the left.
*   **Method**: Protected

#### TurnLeftStop

*   **Description**: Ends movement initiated by `TurnLeftStart`.
*   **Method**: Protected

#### TurnOrActionStart

*   **Description**: Begins character steering or interaction (equivalent to right-clicking).
*   **Method**: Protected

#### TurnOrActionStop

*   **Description**: Ends action initiated by `TurnOrActionStart`.
*   **Method**: Protected

#### TurnRightStart

*   **Description**: Begins turning the player character to the right.
*   **Method**: Protected

#### TurnRightStop

*   **Description**: Ends movement initiated by `TurnRightStart`.
*   **Method**: Protected
```

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

### Get Available Roles

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Retrieves information about the roles a player can queue into the Looking For Dungeon (LFD) system as.

```APIDOC
## GetAvailableRoles

### Description
Returns what roles the player is able to queue into the LFD system as.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/GetAvailableRoles

### Parameters
#### Query Parameters
- **playerID** (integer) - Required - The ID of the player.

### Response
#### Success Response (200)
- **roles** (array) - A list of available roles (e.g., "Tank", "Healer", "DPS").
```

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

### Instance Functions API

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Provides functions to manage and query information about game instances, including dungeons and raids.

```APIDOC
## Instance Functions

### CanShowResetInstances

**Description**: Returns whether the player can reset instances.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetDungeonDifficulty

**Description**: Returns the 5 player selected dungeon difficulty.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetInstanceBootTimeRemaining

**Description**: Returns the amount of time left until the player is removed from the current instance.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetInstanceDifficulty

**Description**: Returns difficulty setting for the current dungeon/raid instance.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetInstanceInfo

**Description**: Returns instance information about the current area.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetInstanceLockTimeRemaining

**Description**: Returns time remaining before the player is saved to a recently entered instance.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetNumSavedInstances

**Description**: Returns the number of instances to which the player is saved.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetNumWorldStateUI

**Description**: Returns the number of world state UI elements.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetSavedInstanceInfo

**Description**: Returns information on a specific instance to which the player is saved.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### GetWorldStateUIInfo

**Description**: Returns information about a world state UI element.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### IsInInstance

**Description**: Returns whether the player is in an instance (and its type if applicable).

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### LFGTeleport

**Description**: Teleports the player to or from their current LFG dungeon.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### RequestRaidInfo

**Description**: Requests information about saved instances from the server.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### ResetInstances

**Description**: Resets all non-saved instances associated with the player.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### RespondInstanceLock

**Description**: Allows leaving a recently entered instance to which the player would otherwise be saved.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### SetDungeonDifficulty

**Description**: Sets the player's 5 player dungeon difficulty preference.

**Method**: N/A (Instance Function)

**Endpoint**: N/A

### SetRaidDifficulty

**Description**: Sets the player's raid dungeon difficulty preference.

**Method**: N/A (Instance Function)

**Endpoint**: N/A
```

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

### Get Faction Info By ID

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Retrieves information about a specific faction or header listing based on its ID.

```APIDOC
## GetFactionInfoByID

### Description
Returns information about a faction or header listing.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/GetFactionInfoByID

### Parameters
#### Query Parameters
- **factionID** (integer) - Required - The ID of the faction.

### Response
#### Success Response (200)
- **factionName** (string) - The name of the faction.
- **isHeader** (boolean) - Indicates if this entry is a header.
```

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

### Mounts, Cinematics, and Visuals

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Functions for player movement, visual settings, and cinematic playback.

```APIDOC
## Mounts, Cinematics, and Visuals Functions

### Description
Provides functionality related to player mounts, visual equipment toggles, and cinematic playback.

### Endpoints

#### Dismount Player

##### Method
POST

##### Endpoint
`/player/mount/dismount`

##### Description
Dismounts the player from their summoned mount.

##### Response

*   **success** (boolean) - Indicates if the player was successfully dismounted.

#### Display Opening Cinematic

##### Method
POST

##### Endpoint
`/player/cinematic/opening`

##### Description
Displays the introductory cinematic for the player's race.

##### Response

*   **success** (boolean) - Indicates if the cinematic was displayed.

#### Toggle Cloak Display

##### Method
POST

##### Endpoint
`/player/visual/cloak/toggle`

##### Description
Enables or disables the display of the player's cloak.

##### Parameters

*   **Request Body**
    *   **show** (boolean) - Required - True to show cloak, false to hide.

##### Response

*   **success** (boolean) - Indicates if the cloak display state was changed.

#### Check if Cloak is Displayed

##### Method
GET

##### Endpoint
`/player/visual/cloak/showing`

##### Description
Returns whether the player's cloak is currently displayed.

##### Response

*   **is_showing** (boolean) - True if the cloak is displayed, false otherwise.

#### Toggle Helm Display

##### Method
POST

##### Endpoint
`/player/visual/helm/toggle`

##### Description
Enables or disables the display of the player's headgear (helm).

##### Parameters

*   **Request Body**
    *   **show** (boolean) - Required - True to show helm, false to hide.

##### Response

*   **success** (boolean) - Indicates if the helm display state was changed.

#### Check if Helm is Displayed

##### Method
GET

##### Endpoint
`/player/visual/helm/showing`

##### Description
Returns whether the player's headgear (helm) is currently displayed.

##### Response

*   **is_showing** (boolean) - True if the helm is displayed, false otherwise.

#### Toggle Sheath

##### Method
POST

##### Endpoint
`/player/equipment/toggle_sheath`

##### Description
Sheathes or unsheathes the player character's hand-held items.

##### Parameters

*   **Request Body**
    *   **sheathed** (boolean) - Required - True to sheath, false to unsheathe.

##### Response

*   **success** (boolean) - Indicates if the sheath state was changed.

```

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

### Macro Functions API

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

This section details functions for creating, managing, and executing macros within the game.

```APIDOC
## CreateMacro

### Description
Creates a new macro.

### Method
POST

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/create

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new macro.
- **icon** (string) - Optional - The icon identifier for the macro.
- **body** (string) - Required - The sequence of commands for the macro.

### Request Example
```json
{
  "name": "MyHealMacro",
  "icon": "spell_holy_flashheal",
  "body": "/cast Heal"
}
```

### Response
#### Success Response (200)
- **macroID** (integer) - The unique identifier of the newly created macro.

#### Response Example
```json
{
  "macroID": 123
}
```
```

```APIDOC
## CursorHasMacro

### Description
Returns whether a macro is on the cursor.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/cursorHasMacro

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **hasMacro** (boolean) - True if a macro is currently on the cursor, false otherwise.

#### Response Example
```json
{
  "hasMacro": true
}
```
```

```APIDOC
## DeleteMacro

### Description
Deletes a macro.

### Method
DELETE

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/delete

### Parameters
#### Query Parameters
- **macroID** (integer) - Required - The ID of the macro to delete.

### Request Example
None

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the deletion was successful.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## EditMacro

### Description
Changes the name, icon, and/or body of a macro.

### Method
PUT

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/edit

### Parameters
#### Request Body
- **macroID** (integer) - Required - The ID of the macro to edit.
- **newName** (string) - Optional - The new name for the macro.
- **newIcon** (string) - Optional - The new icon identifier for the macro.
- **newBody** (string) - Optional - The new sequence of commands for the macro.

### Request Example
```json
{
  "macroID": 123,
  "newName": "UpdatedHealMacro",
  "newBody": "/cast Greater Heal"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the edit operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

```APIDOC
## GetMacroBody

### Description
Returns the body text of a macro.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/getBody

### Parameters
#### Query Parameters
- **macroID** (integer) - Required - The ID of the macro.

### Request Example
None

### Response
#### Success Response (200)
- **macroBody** (string) - The command text of the macro.

#### Response Example
```json
{
  "macroBody": "/cast Heal"
}
```
```

```APIDOC
## GetMacroIconInfo

### Description
Returns the texture for a macro icon option.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/getIconInfo

### Parameters
#### Query Parameters
- **iconName** (string) - Required - The name or identifier of the macro icon.

### Request Example
None

### Response
#### Success Response (200)
- **iconTexturePath** (string) - The file path or identifier for the icon's texture.

#### Response Example
```json
{
  "iconTexturePath": "Interface\Icons\spell_holy_flashheal"
}
```
```

```APIDOC
## GetMacroIndexByName

### Description
Returns the index of a macro specified by name.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/getIndexByName

### Parameters
#### Query Parameters
- **macroName** (string) - Required - The name of the macro to find.

### Request Example
None

### Response
#### Success Response (200)
- **macroID** (integer) - The ID of the macro matching the given name.

#### Response Example
```json
{
  "macroID": 123
}
```
```

```APIDOC
## GetMacroInfo

### Description
Returns information about a macro.

### Method
GET

### Endpoint
/websites/web_archive_web_20100726112636_http_wowprogramming_com/api/macros/getInfo

### Parameters
#### Query Parameters
- **macroID** (integer) - Required - The ID of the macro.

### Request Example
None

### Response
#### Success Response (200)
- **macroInfo** (object) - An object containing details about the macro.
  - **name** (string) - The name of the macro.
  - **icon** (string) - The icon identifier of the macro.
  - **body** (string) - The command body of the macro.

#### Response Example
```json
{
  "macroInfo": {
    "name": "MyHealMacro",
    "icon": "spell_holy_flashheal",
    "body": "/cast Heal"
  }
}
```
```

```APIDOC
## GetMacroItem

### Description
Returns information about the item used by a macro.

### Method
GET
```

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

### Hearthstone and Zone Information

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Functions for managing Hearthstone location and checking zone-specific conditions.

```APIDOC
## Hearthstone and Zone Information Functions

### Description
Manages Hearthstone location settings and provides information about the player's current zone and its properties.

### Endpoints

#### Set Hearthstone Location

##### Method
POST

##### Endpoint
`/player/hearthstone/confirm_bind`

##### Description
Sets the player's Hearthstone location to the current location. This function should be called after checking proximity to a binder NPC.

##### Response

*   **success** (boolean) - Indicates if the Hearthstone location was successfully set.

#### Get Hearthstone Location Name

##### Method
GET

##### Endpoint
`/player/hearthstone/location_name`

##### Description
Returns the name of the player's current Hearthstone location.

##### Response

*   **location_name** (string) - The name of the Hearthstone location.

#### Check Binder Proximity

##### Method
GET

##### Endpoint
`/player/binder/in_range`

##### Description
Returns whether the player is in range of an NPC that can set the Hearthstone location.

##### Response

*   **in_range** (boolean) - True if in range of a binder NPC, false otherwise.

#### Check World PvP Zone Exit Option

##### Method
GET

##### Endpoint
`/player/world_pvp/can_hearth_and_resurrect`

##### Description
Returns whether the player is in a world PvP zone offering an exit option (like Hearthstone or resurrection).

##### Response

*   **can_exit** (boolean) - True if an exit option is available in the zone, false otherwise.

```

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

### Utility Functions

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

General utility functions for creating UI elements, managing frames, handling input, and performing string/table operations.

```APIDOC
## Utility Functions

### Description
Provides a range of utility functions for UI creation, frame management, event handling, and data manipulation.

### Functions
*   **CreateFont** - Creates a new Font object.
*   **CreateFrame** - Creates a new Frame object.
*   **EnumerateFrames** - Returns the next frame following the frame passed, or nil if no more frames exist.
*   **GetAutoCompleteResults** - Returns a list of character names which complete a given partial name prefix.
*   **GetClickFrame** - Returns the Frame object associated with the given name.
*   **GetCurrentKeyBoardFocus** - Returns the frame currently handling keyboard input.
*   **GetFramesRegisteredForEvent** - Returns all frames registered for a given event.
*   **GetMirrorTimerInfo** - Returns information about special countdown timers.
*   **GetMirrorTimerProgress** - Returns a high-resolution value for a special countdown timer.
*   **GetMouseButtonClicked** - Returns which mouse button triggered the current script.
*   **GetMouseButtonName** - Returns the name for a mouse button specified by number.
*   **GetMouseFocus** - Returns the frame that is currently under the mouse, and has mouse input enabled.
*   **GetMuteName** - Returns the name of a character on the mute list.
*   **GetNumFrames** - Returns the number of existing Frame objects (and derivatives).
*   **GetText** - Returns a localized string according to given parameters.
*   **GetTime** - Returns a number representing the current time (with millisecond precision).
*   **IsLoggedIn** - Returns whether the login process has completed.
*   **IsMouseButtonDown** - Returns whether a given mouse button is held down.
*   **RegisterForSave** - Enables a global variable for automatic saving upon logout & UI reload (internal, protected).
*   **RegisterForSavePerCharacter** - Enables a global variable for automatic saving (on a per-character basis) upon logout & UI reload (internal, protected).
*   **RequestTimePlayed** - Requests information from the server about the player character's total time spent online (server).
*   **RunScript** - Runs a string as a Lua script.
*   **SecondsToTime** - Returns a description of an amount of time in appropriate units (blizzardui).
*   **SetPortraitToTexture** - Sets a Texture object to display an arbitrary texture, altering it to fit a circular frame.
*   **debuglocals** - Returns information about the local variables at a given stack depth.
*   **getglobal** - Returns the value of a global variable.
*   **scrub** - Replaces non-simple values in a list with nil.
*   **setglobal** - Sets a global variable to a specified value.
*   **strconcat** - Joins a list of strings (with no separator).
*   **strjoin** - Joins a list of strings together with a given separator.
*   **strlenutf8** - Returns the length of a string, taking UTF-8 multi-byte characters into account.
*   **strreplace** - Fast simple substring substitution.
*   **strsplit** - Splits a string based on another separator string.
*   **strtrim** - Trims leading and trailing characters (whitespace by default) from a string.
*   **wipe** - Removes all entries from a table.
```

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

### Battle.net Settings and Customization

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Functions to manage RealID settings, including mature language filters and custom messages.

```APIDOC
## Battle.net Settings Functions

### BNGetInfo

#### Description
Returns information about the player's RealID settings.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
BNGetInfo()
```

### Response
#### Success Response
- **realIDInfo** (object) - Information about RealID settings.

#### Response Example
```json
{
  "realIDInfo": {
    "isAvailable": true,
    "privacySettings": "Friends Only"
  }
}
```

### BNGetMatureLanguageFilter

#### Description
Returns the boolean state of the Mature Language Filter option.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
BNGetMatureLanguageFilter()
```

### Response
#### Success Response
- **filterEnabled** (boolean) - True if the filter is enabled, false otherwise.

#### Response Example
```json
{
  "filterEnabled": true
}
```

### BNSetCustomMessage

#### Description
Sets the player's current RealID broadcast message.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
BNSetCustomMessage("Having fun playing!")
```

### Response
#### Success Response
- **success** (boolean) - Indicates if the message was set successfully.

#### Response Example
```json
{
  "success": true
}
```

### BNSetFriendNote

#### Description
Changes the private note for a RealID friend.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
BNSetFriendNote(friendIndex, "Good player")
```

### Response
#### Success Response
- **success** (boolean) - Indicates if the note was set successfully.

#### Response Example
```json
{
  "success": true
}
```

### BNSetMatureLanguageFilter

#### Description
Sets the Mature Language Filter option.

### Method
N/A (Function Call)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
BNSetMatureLanguageFilter(true)
```

### Response
#### Success Response
- **success** (boolean) - Indicates if the filter state was set successfully.

#### Response Example
```json
{
  "success": true
}
```
```

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

### Rune Information

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Provides information about the player's rune resources.

```APIDOC
## Rune Information Functions

### Description
Provides access to information about the player's rune resources, including cooldowns and types.

### Endpoints

#### Get Rune Cooldown

##### Method
GET

##### Endpoint
`/player/rune/cooldown/{rune_index}`

##### Description
Returns cooldown information about a specific rune resource.

##### Parameters

*   **Path Parameters**
    *   **rune_index** (integer) - Required - The index of the rune to check (e.g., 0, 1, 2).

##### Response

*   **cooldown_seconds** (integer) - The remaining cooldown time in seconds for the rune.
*   **is_ready** (boolean) - Whether the rune is off cooldown and ready to use.

#### Get Rune Count

##### Method
GET

##### Endpoint
`/player/rune/count/{rune_slot}`

##### Description
Returns the number of available rune resources in a specific rune slot.

##### Parameters

*   **Path Parameters**
    *   **rune_slot** (integer) - Required - The index of the rune slot (e.g., 0, 1, 2).

##### Response

*   **rune_count** (integer) - The number of available runes in the specified slot.

#### Get Rune Type

##### Method
GET

##### Endpoint
`/player/rune/type/{rune_index}`

##### Description
Returns the type of a specific rune resource.

##### Parameters

*   **Path Parameters**
    *   **rune_index** (integer) - Required - The index of the rune to check (e.g., 0, 1, 2).

##### Response

*   **rune_type** (string) - The type of the rune (e.g., "Blood", "Frost", "Unholy").

#### Get Time To Well Rested

##### Method
GET

##### Endpoint
`/player/time_to_well_rested`

##### Description
Returns the time remaining until the player achieves the "Well Rested" buff. Note: This function is deprecated and should no longer be used.

##### Response

*   **time_remaining_seconds** (integer) - The time in seconds until well rested. (Deprecated)

```

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

### Calendar Event Signup and Sorting API

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Endpoints for player actions related to calendar events, including signing up, and sorting invites.

```APIDOC
## POST /CalendarEventSignUp

### Description
Signs the player up for the selected calendar event.

### Method
POST

### Endpoint
/CalendarEventSignUp

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **eventGuid** (string) - Required - The unique identifier of the event.
- **status** (string) - Required - The status to sign up with (e.g., "SignedUp").

### Request Example
```json
{
  "eventGuid": "<event_guid>",
  "status": "SignedUp"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

## POST /CalendarEventSortInvites

### Description
Sorts the event invite/signup list.

### Method
POST

### Endpoint
/CalendarEventSortInvites

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **eventGuid** (string) - Required - The unique identifier of the event.
- **sortOrder** (string) - Required - The desired sort order (e.g., "Ascending", "Descending").

### Request Example
```json
{
  "eventGuid": "<event_guid>",
  "sortOrder": "Ascending"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

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

### Battleground Functions

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Functions related to managing and interacting with battlegrounds.

```APIDOC
## SetSelectedBattlefield

### Description
Selects a battleground instance in the queueing list.

### Method
Not specified (likely an internal function call).

### Endpoint
Not applicable.

### Parameters
None specified.

### Request Example
```json
{}
```

### Response
None specified.
```

```APIDOC
## ShowMiniWorldMapArrowFrame

### Description
Shows or hides the battlefield minimap's player arrow.

### Method
Not specified (likely an internal function call).

### Endpoint
Not applicable.

### Parameters
None specified.

### Request Example
```json
{}
```

### Response
None specified.
```

```APIDOC
## SortBattlefieldScoreData

### Description
Sorts the battleground scoreboard.

### Method
Not specified (likely an internal function call).

### Endpoint
Not applicable.

### Parameters
None specified.

### Request Example
```json
{}
```

### Response
None specified.
```

```APIDOC
## UnitInBattleground

### Description
Returns whether a unit is in the same battleground instance as the player.

### Method
Not specified (likely an internal function call).

### Endpoint
Not applicable.

### Parameters
None specified.

### Request Example
```json
{}
```

### Response
None specified.
```

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

### Inventory Functions API

Source: https://web.archive.org/web/20100726112636/http://wowprogramming.com/docs/api_categories

Contains functions for managing player inventory, including equipping items, checking item status, and manipulating inventory slots.

```APIDOC
## Inventory Functions

### AutoEquipCursorItem

**Description**: Equips the item on the cursor.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### BankButtonIDToInvSlotID

**Description**: Returns the `inventoryID` corresponding to a bank item or bag slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### CancelPendingEquip

**Description**: Cancels equipping a bind-on-equip item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### ContainerIDToInventoryID

**Description**: Returns the `inventoryID` corresponding to a given `containerID`.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### CursorCanGoInSlot

**Description**: Returns whether the item on the cursor can be equipped in an inventory slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### EquipCursorItem

**Description**: Puts the item on the cursor into a specific equipment slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### EquipItemByName

**Description**: Attempts to equip an arbitrary item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### EquipPendingItem

**Description**: Confirms equipping a bind-on-equip item.

**Parameters**:
  * confirmation (type) - Required/Optional - Description

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### EquipmentManager_UnpackLocation

**Description**: Unpacks an inventory location bitfield into usable components.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryAlertStatus

**Description**: Returns the durability warning status of an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemBroken

**Description**: Returns whether an equipped item is broken.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemCooldown

**Description**: Returns cooldown information about an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemCount

**Description**: Returns the number of items stacked in an inventory slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemDurability

**Description**: Returns the current durability level of an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemGems

**Description**: Returns the gems socketed in an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemID

**Description**: Returns the item ID of an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemLink

**Description**: Returns an item link for an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemQuality

**Description**: Returns the quality level of an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemTexture

**Description**: Returns the icon texture for an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventoryItemsForSlot

**Description**: Returns a list of items that can be equipped in a given inventory slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### GetInventorySlotInfo

**Description**: Returns information about an inventory slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### IsEquippedItem

**Description**: Returns whether an item is currently equipped.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### IsEquippedItemType

**Description**: Returns whether any items of a given type are currently equipped.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### IsInventoryItemLocked

**Description**: Returns whether an inventory slot is locked.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### KeyRingButtonIDToInvSlotID

**Description**: Returns the `inventoryID` corresponding to a slot in the keyring.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### PickupInventoryItem

**Description**: Picks up an item from or puts an item into an equipment slot.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### SetInventoryPortraitTexture

**Description**: Sets a Texture object to display the icon of an equipped item.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### SocketInventoryItem

**Description**: Opens an equipped item for socketing.

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### UpdateInventoryAlertStatus

**Description**: _This is a Blizzard internal function_

**Parameters**:
  * internal (type) - Required/Optional - Description

**Method**: N/A (Inventory Function)

**Endpoint**: N/A

### UseInventoryItem

**Description**: Activate (as with right-clicking) an equipped item.

**Parameters**:
  * protected (type) - Required/Optional - Description

**Method**: N/A (Inventory Function)

**Endpoint**: N/A
```