mlbstats/api/docs/SkeletalAPI.md

\SkeletalAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
SkeletalChunked	Get /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/chunked	View Skeletal Data by playId and gameId chunked
SkeletalDataFileNames	Get /api/v1/game/{gamePk}/{playId}/analytics/skeletalData/files	View Skeletal Data by playId and gameId files

SkeletalChunked

SkeletalChunked(ctx, gamePk, playId).FileName(fileName).Fields(fields).Execute()

View Skeletal Data by playId and gameId chunked

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "//"
)

func main() {
	gamePk := TODO // interface{} | Unique Primary Key Representing a Game
	playId := TODO // interface{} | Unique play identifier
	fileName := TODO // interface{} | Skeletal chunked file name
	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.SkeletalAPI.SkeletalChunked(context.Background(), gamePk, playId).FileName(fileName).Fields(fields).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SkeletalAPI.SkeletalChunked``: %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{}	Unique Primary Key Representing a Game
playId	interface{}	Unique play identifier

Other Parameters

Other parameters are passed through a pointer to a apiSkeletalChunkedRequest struct via the builder pattern

Name	Type	Description	Notes

fileName | interface{} | Skeletal chunked file name | fields | interface{} | 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] [Back to Model list] [Back to README]

SkeletalDataFileNames

SkeletalDataFileNames(ctx, gamePk, playId).Fields(fields).Execute()

View Skeletal Data by playId and gameId files

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "//"
)

func main() {
	gamePk := TODO // interface{} | Unique Primary Key Representing a Game
	playId := TODO // interface{} | Unique play identifier
	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.SkeletalAPI.SkeletalDataFileNames(context.Background(), gamePk, playId).Fields(fields).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SkeletalAPI.SkeletalDataFileNames``: %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{}	Unique Primary Key Representing a Game
playId	interface{}	Unique play identifier

Other Parameters

Other parameters are passed through a pointer to a apiSkeletalDataFileNamesRequest struct via the builder pattern

Name	Type	Description	Notes

fields | interface{} | 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] [Back to Model list] [Back to README]