4.5 KiB
{{classname}}
All URIs are relative to https://statsapi.mlb.com
| Method | HTTP request | Description |
|---|---|---|
| AwardRecipients | Get /api/v1/awards/{awardId}/recipients | View recipients of an award |
| Awards | Get /api/v1/awards | View awards info |
| Awards1 | Get /api/v1/awards/{awardId} | View awards info |
AwardRecipients
AwardsRestObject AwardRecipients(ctx, awardId, optional) View recipients of an award
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| awardId | string | Unique Award Identifier. Available awards in /api/v1/awards | |
| optional | *AwardsApiAwardRecipientsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a AwardsApiAwardRecipientsOpts struct
| Name | Type | Description | Notes |
|---|
season | optional.String| Season of play | sportId | optional.Int32| Top level organization of a sport | leagueId | **optional.Interface of []int32**| Comma delimited list of Unique league identifiers | fields | **optional.Interface of []string**| |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Awards
AwardsRestObject Awards(ctx, awardId, optional) View awards info
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| awardId | string | Unique Award Identifier. Available awards in /api/v1/awards | |
| optional | *AwardsApiAwardsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a AwardsApiAwardsOpts struct
| Name | Type | Description | Notes |
|---|
orgId | **optional.Interface of []int32**| Comma delimited list of top level organizations of a sport | fields | **optional.Interface of []string**| Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Awards1
AwardsRestObject Awards1(ctx, awardId, optional) View awards info
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| awardId | string | Unique Award Identifier. Available awards in /api/v1/awards | |
| optional | *AwardsApiAwards1Opts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a AwardsApiAwards1Opts struct
| Name | Type | Description | Notes |
|---|
orgId | **optional.Interface of []int32**| Comma delimited list of top level organizations of a sport | fields | **optional.Interface of []string**| Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]