mlbstats/api/docs/UniformsApi.md

3.0 KiB

{{classname}}

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

Method HTTP request Description
UniformsByGame Get /api/v1/uniforms/game View Game Uniform info
UniformsByTeam Get /api/v1/uniforms/team View Team Uniform info

UniformsByGame

UniformsGamesRestObject UniformsByGame(ctx, gamePks, optional) View Game Uniform info

This endpoint allows you to pull team uniform data for a game

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
gamePks **[]int32** Comma delimited list of unique primary keys
optional *UniformsApiUniformsByGameOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UniformsApiUniformsByGameOpts 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

UniformsGamesRestObject

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]

UniformsByTeam

UniformsTeamsRestObject UniformsByTeam(ctx, teamIds, optional) View Team Uniform info

This endpoint allows you to pull team uniform data for a season

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
teamIds **[]int32**
optional *UniformsApiUniformsByTeamOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UniformsApiUniformsByTeamOpts struct

Name Type Description Notes

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

Return type

UniformsTeamsRestObject

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]