145 lines
3.7 KiB
Markdown
145 lines
3.7 KiB
Markdown
|
# \UniformsAPI
|
||
|
|
|
||
|
|
All URIs are relative to *http://localhost*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**UniformsByGame**](UniformsAPI.md#UniformsByGame) | **Get** /api/v1/uniforms/game | View Game Uniform info
|
||
|
|
[**UniformsByTeam**](UniformsAPI.md#UniformsByTeam) | **Get** /api/v1/uniforms/team | View Team Uniform info
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## UniformsByGame
|
||
|
|
|
||
|
|
> UniformsByGame(ctx).GamePks(gamePks).Fields(fields).Execute()
|
||
|
|
|
||
|
|
View Game Uniform info
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
```go
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
"context"
|
||
|
|
"fmt"
|
||
|
|
"os"
|
||
|
|
openapiclient "//"
|
||
|
|
)
|
||
|
|
|
||
|
|
func main() {
|
||
|
|
gamePks := TODO // interface{} | Comma delimited list of unique primary keys
|
||
|
|
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.UniformsAPI.UniformsByGame(context.Background()).GamePks(gamePks).Fields(fields).Execute()
|
||
|
|
if err != nil {
|
||
|
|
fmt.Fprintf(os.Stderr, "Error when calling `UniformsAPI.UniformsByGame``: %v\n", err)
|
||
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Path Parameters
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Other Parameters
|
||
|
|
|
||
|
|
Other parameters are passed through a pointer to a apiUniformsByGameRequest struct via the builder pattern
|
||
|
|
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**gamePks** | [**interface{}**](interface{}.md) | Comma delimited list of unique primary keys |
|
||
|
|
**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)
|
||
|
|
|
||
|
|
|
||
|
|
## UniformsByTeam
|
||
|
|
|
||
|
|
> UniformsByTeam(ctx).TeamIds(teamIds).Season(season).Fields(fields).Execute()
|
||
|
|
|
||
|
|
View Team Uniform info
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Example
|
||
|
|
|
||
|
|
```go
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
"context"
|
||
|
|
"fmt"
|
||
|
|
"os"
|
||
|
|
openapiclient "//"
|
||
|
|
)
|
||
|
|
|
||
|
|
func main() {
|
||
|
|
teamIds := TODO // interface{} |
|
||
|
|
season := TODO // interface{} | Season of play (optional)
|
||
|
|
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.UniformsAPI.UniformsByTeam(context.Background()).TeamIds(teamIds).Season(season).Fields(fields).Execute()
|
||
|
|
if err != nil {
|
||
|
|
fmt.Fprintf(os.Stderr, "Error when calling `UniformsAPI.UniformsByTeam``: %v\n", err)
|
||
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Path Parameters
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Other Parameters
|
||
|
|
|
||
|
|
Other parameters are passed through a pointer to a apiUniformsByTeamRequest struct via the builder pattern
|
||
|
|
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**teamIds** | [**interface{}**](interface{}.md) | |
|
||
|
|
**season** | [**interface{}**](interface{}.md) | Season of play |
|
||
|
|
**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)
|
||
|
|
|