mlbstats/api/docs/HomerunDerbyAPI.md

577 lines
16 KiB
Markdown
Raw Normal View History

2025-04-06 23:39:04 +00:00
# \HomerunDerbyAPI
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**HomeRunDerbyBracket**](HomerunDerbyAPI.md#HomeRunDerbyBracket) | **Get** /api/v1/homeRunDerby/{gamePk} | View a home run derby object
[**HomeRunDerbyBracket1**](HomerunDerbyAPI.md#HomeRunDerbyBracket1) | **Get** /api/v1/homeRunDerby | View a home run derby object
[**HomeRunDerbyBracket2**](HomerunDerbyAPI.md#HomeRunDerbyBracket2) | **Get** /api/v1/homeRunDerby/{gamePk}/bracket | View a home run derby object
[**HomeRunDerbyBracket3**](HomerunDerbyAPI.md#HomeRunDerbyBracket3) | **Get** /api/v1/homeRunDerby/bracket | View a home run derby object
[**HomeRunDerbyMixedMode**](HomerunDerbyAPI.md#HomeRunDerbyMixedMode) | **Get** /api/v1/homeRunDerby/{gamePk}/mixed | View home run derby mixed mode (Bracket/Pool combo)
[**HomeRunDerbyMixedMode1**](HomerunDerbyAPI.md#HomeRunDerbyMixedMode1) | **Get** /api/v1/homeRunDerby/mixed | View home run derby mixed mode (Bracket/Pool combo)
[**HomeRunDerbyPool**](HomerunDerbyAPI.md#HomeRunDerbyPool) | **Get** /api/v1/homeRunDerby/{gamePk}/pool | View home run derby pool
[**HomeRunDerbyPool1**](HomerunDerbyAPI.md#HomeRunDerbyPool1) | **Get** /api/v1/homeRunDerby/pool | View home run derby pool
## HomeRunDerbyBracket
> HomeRunDerbyBracket(ctx, gamePk).Fields(fields).Execute()
View a home run derby object
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyBracket(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyBracket``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyBracketRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyBracket1
> HomeRunDerbyBracket1(ctx, gamePk).Fields(fields).Execute()
View a home run derby object
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyBracket1(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyBracket1``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyBracket1Request struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyBracket2
> HomeRunDerbyBracket2(ctx, gamePk).Fields(fields).Execute()
View a home run derby object
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyBracket2(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyBracket2``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyBracket2Request struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyBracket3
> HomeRunDerbyBracket3(ctx, gamePk).Fields(fields).Execute()
View a home run derby object
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyBracket3(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyBracket3``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyBracket3Request struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyMixedMode
> HomeRunDerbyMixedMode(ctx, gamePk).Fields(fields).Execute()
View home run derby mixed mode (Bracket/Pool combo)
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyMixedMode(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyMixedMode``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyMixedModeRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyMixedMode1
> HomeRunDerbyMixedMode1(ctx, gamePk).Fields(fields).Execute()
View home run derby mixed mode (Bracket/Pool combo)
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyMixedMode1(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyMixedMode1``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyMixedMode1Request struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyPool
> HomeRunDerbyPool(ctx, gamePk).Fields(fields).Execute()
View home run derby pool
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyPool(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyPool``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyPoolRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)
## HomeRunDerbyPool1
> HomeRunDerbyPool1(ctx, gamePk).Fields(fields).Execute()
View home run derby pool
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "//"
)
func main() {
gamePk := TODO // interface{} | Unique Primary Key Representing a Game
fields := TODO // interface{} | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.HomerunDerbyAPI.HomeRunDerbyPool1(context.Background(), gamePk).Fields(fields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `HomerunDerbyAPI.HomeRunDerbyPool1``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
```
### Path Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**gamePk** | [**interface{}**](.md) | Unique Primary Key Representing a Game |
### Other Parameters
Other parameters are passed through a pointer to a apiHomeRunDerbyPool1Request struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**interface{}**](interface{}.md) | Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)