mlbstats/api/docs/BroadcastApi.md

3.0 KiB

{{classname}}

All URIs are relative to https://statsapi.mlb.com

Method HTTP request Description
GetAllBroadcasters Get /api/v1/broadcasters Get All Active Broadcasters
GetBroadcasts Get /api/v1/broadcast Get Broadcasters

GetAllBroadcasters

[]BroadcasterRestObject GetAllBroadcasters(ctx, optional) Get All Active Broadcasters

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *BroadcastApiGetAllBroadcastersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BroadcastApiGetAllBroadcastersOpts struct

Name Type Description Notes
activeStatus optional.Interface of BroadcasterActiveStatusEnum Current status of the broadcaster. Format: Active = y, inactive = n, both = b
fields **optional.Interface of []string** Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute

Return type

**[]BroadcasterRestObject**

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]

GetBroadcasts

[]BroadcasterRestObject GetBroadcasts(ctx, broadcasterIds, optional) Get Broadcasters

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
broadcasterIds **[]int32** All of the broadcast details
optional *BroadcastApiGetBroadcastsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BroadcastApiGetBroadcastsOpts struct

Name Type Description Notes

fields | **optional.Interface of []string**| Comma delimited list of specific fields to be returned. Format: topLevelNode, childNode, attribute |

Return type

**[]BroadcasterRestObject**

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]