Lobby - Leave Lobby As Server
Preview: Request for server to leave a lobby. This is restricted to client owned lobbies which are using connections.
POST https://titleId.playfabapi.com/Lobby/LeaveLobbyAsServerRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| LobbyId | True |
string |
The id of the lobby. |
| ServerEntity | True |
The game_server entity leaving the lobby. If the game_server was subscribed to notifications, it will be unsubscribed. If a the given game_server entity is not in the lobby, it will fail. |
|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Leave |
Preview: Request for server to leave a lobby. Only a game_server entity can leave and this is restricted to client owned lobbies which are using connections. |
|
Lobby |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
LeaveLobbyAsServerRequest
Preview: Request for server to leave a lobby. Only a game_server entity can leave and this is restricted to client owned lobbies which are using connections.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| LobbyId |
string |
The id of the lobby. |
| ServerEntity |
The game_server entity leaving the lobby. If the game_server was subscribed to notifications, it will be unsubscribed. If a the given game_server entity is not in the lobby, it will fail. |
LobbyEmptyResult
Error Codes
| Name | Code |
|---|---|
| LobbyBadRequest | 13007 |
| LobbyDoesNotExist | 13000 |
| LobbyDoesNotUseConnections | 13017 |
| LobbyIsNotClientOwned | 13016 |
| LobbyRateLimitExceeded | 13001 |
| LobbyServerMismatch | 13012 |
| LobbyServerNotFound | 13013 |