Season Series

A series is a collection of matches inside a season where specific teams play each other multiple times. A series for example can be a Best-Of 7.

Get a list of series

get
/baseball/o/{organizationId}/seasons/{seasonId}/series

Return a list of series for a season

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
nameLatinContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLatin=David Johnson nameLatinContains=Dav will match nameLatinContains=John will match nameLatinContains=son will not match

Example: Dav and nameLatin='David Johnson'
nameLocalContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLocal=David Johnson nameLocalContains=Dav will match nameLocalContains=John will match nameLocalContains=son will not match

Example: Dav and nameLocal='David Johnson'
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
seriesCodeContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: seriesCode=Series 001seriesCodeContains=Ser will match seriesCodeContains=001 will match seriesCodeContains=ies will not match

Example: SER and seriesCode='SERIES1'
seriesTypestring · enum · max: 50Optional

The type of series. Multiple allowed (comma-delimited).

  • BEST_OF Best of
  • HOME_AND_AWAY Home and Away
  • KNOCKOUT Knockout
Example: BEST_OFPossible values:
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: nameLocalPattern: ^(\-?nameLocal|\-?nameLatin|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/seasons/{seasonId}/series

Create a series

post
/baseball/o/{organizationId}/seasons/{seasonId}/series

Add a new series in a season

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
seriesCodestring · max: 30Required

A unique code for the season series. (Unique for season)

Example: ST1
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
conferenceIdstring · uuid | nullableOptional

The unique identifier of the conference

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
divisionIdstring · uuid | nullableOptional

The unique identifier of the division

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
nameLocalstring · max: 150Required

The name of the series in the local language

Example: Test name local
abbreviationLocalstring | nullableOptional

An abbreviation/short name in the local language

Example: NFA
nameLatinstring | nullableOptional

The name of the series in latin characters

Example: Test name latin
abbreviationLatinstring | nullableOptional

An abbreviation/short name in latin characters

Example: NFA
statusstring · enum · max: 30Required

Status

  • ACTIVE Active
  • COMPLETE Complete
  • NOT_STARTED Not Started
Example: COMPLETEPossible values:
seriesTypestring · enum · max: 50Required

The type of series

  • BEST_OF Best of
  • HOME_AND_AWAY Home and Away
  • KNOCKOUT Knockout
Example: BEST_OFPossible values:
autoCalculatedbooleanOptional

Is the winner auto calculated?

Example: true
bestOfinteger · int32 | nullableOptional

Best of number

Example: 1
seriesNumberinteger · int32 | nullableOptional

User defined series number

Example: 1
maxFixturesNumberinteger · int32 | nullableOptional

The maximum number of games within a playoff series

Example: 1
winnerstring · uuid | nullableOptional

The unique identifier of the winner, person or entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seriesOrderinteger · int32 | nullableOptional

User defined sort order of the series

Example: 1
stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
startDatestring · date | nullableOptional

Series start date

Example: 2016-09-08
endDatestring · date | nullableOptional

Series end date

Example: 2016-09-08
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
Responses
200

Successful operation

application/json
post
/baseball/o/{organizationId}/seasons/{seasonId}/series

Get a series

get
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}

Return detailed information about a specific season series

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seriesCodestring · max: 30Required

The series identifier within a season

Example: WC1
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}

Update a series

put
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}

Change the information of a specific season series

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seriesCodestring · max: 30Required

The series identifier within a season

Example: WC1
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
conferenceIdstring · uuid | nullableOptional

The unique identifier of the conference

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
divisionIdstring · uuid | nullableOptional

The unique identifier of the division

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
nameLocalstring · max: 150Optional

The name of the series in the local language

Example: Test name local
abbreviationLocalstring | nullableOptional

An abbreviation/short name in the local language

Example: NFA
nameLatinstring | nullableOptional

The name of the series in latin characters

Example: Test name latin
abbreviationLatinstring | nullableOptional

An abbreviation/short name in latin characters

Example: NFA
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • COMPLETE Complete
  • NOT_STARTED Not Started
Example: COMPLETEPossible values:
seriesTypestring · enum · max: 50Optional

The type of series

  • BEST_OF Best of
  • HOME_AND_AWAY Home and Away
  • KNOCKOUT Knockout
Example: BEST_OFPossible values:
autoCalculatedbooleanOptional

Is the winner auto calculated?

Example: true
bestOfinteger · int32 | nullableOptional

Best of number

Example: 1
seriesNumberinteger · int32 | nullableOptional

User defined series number

Example: 1
maxFixturesNumberinteger · int32 | nullableOptional

The maximum number of games within a playoff series

Example: 1
winnerstring · uuid | nullableOptional

The unique identifier of the winner, person or entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seriesOrderinteger · int32 | nullableOptional

User defined sort order of the series

Example: 1
stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
startDatestring · date | nullableOptional

Series start date

Example: 2016-09-08
endDatestring · date | nullableOptional

Series end date

Example: 2016-09-08
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
Responses
200

Successful operation

application/json
put
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}

Delete a series

delete
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}

Delete a specific series

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seriesCodestring · max: 30Required

The series identifier within a season

Example: WC1
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}

Calculate season series competitors score related fields

post
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}/calculate

Calculate season series competitors score related fields

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seriesCodestring · max: 30Required

The series identifier within a season

Example: WC1
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
post
/baseball/o/{organizationId}/seasons/{seasonId}/series/{seriesCode}/calculate

Last updated

Was this helpful?