Venues

The Venue is the physical location where a match occurs. Every match can have only one venue. The organization has many venues.

Get a list of venues in the season

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

Return a list of venues 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
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
nameLatinstring · max: 50Optional

The full name in latin characters

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'
nameLocalstring · max: 50Optional

The full name

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
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: -nameLocal,nameLatinPattern: ^(\-?nameLocal|\-?nameLatin|,)*$
venueIdstringOptional

The unique identifier of the venue. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

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

Get a list of venues

get
/baseball/o/{organizationId}/venues

Return a list of available venues

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
Query parameters
addedstring · date-timeOptional

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

Example: 2018-08-16T02:10:48
countryCodestring · min: 3 · max: 3Optional

Country code

Example: USA
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
nameLatinstring · max: 50Optional

The full name in latin characters

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'
nameLocalstring · max: 50Optional

The full name

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
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: -nameLocal,nameLatinPattern: ^(\-?nameLocal|\-?nameLatin|,)*$
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
updatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
venueIdstringOptional

The unique identifier of the venue. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/venues

Create a venue

post
/baseball/o/{organizationId}/venues

Add a new venue

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
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
venueIdstring · uuidOptional

The unique identifier of the venue

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

The site that this venue belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
abbreviationLocalstring | nullableOptional

An abbreviation/short name in the local language

Example: NFA
nameLocalstring · max: 150Required

The name of the venue in the local language

Example: Test name local
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Default: ACTIVEExample: ACTIVEPossible values:
alternateNameLocalstring | nullableOptional

The alternate name of the venue, in Local Language

Example: Test venue
abbreviationLatinstring | nullableOptional

An abbreviation/short name in latin characters

Example: NFA
nameLatinstring | nullableOptional

The name of the venue in latin characters

Example: Test name latin
alternateNameLatinstring | nullableOptional

The alternate name of the venue, in Latin characters

Example: Test venue
countryCodestring | nullableOptional

Country code of the venue. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.

Example: USA
timezonestring · max: 150Required

Timezone of the venue. The name of the zone as defined by the IANA TZ database. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: Australia/Sydney
capacityinteger · int32 | nullableOptional

This is the maximum number of people allowed for the venue in normal use. Certain events/configurations of the venue may cause this capacity to be increased/decreased - this is not reflected in this value.

Example: 12300
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}/venues

Get a list of venues by site

get
/baseball/o/{organizationId}/sites/{siteId}/venues

Return a list of available venues

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
siteIdstring · uuidRequired

The unique identifier of the site

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
countryCodestring · min: 3 · max: 3Optional

Country code

Example: USA
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
nameLatinstring · max: 50Optional

The full name in latin characters

nameLocalstring · max: 50Optional

The full name

offsetinteger · int32Optional

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

Example: 10
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: -nameLocal,nameLatinPattern: ^(\-?nameLocal|\-?nameLatin|,)*$
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
updatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
venueIdstringOptional

The unique identifier of the venue. Can specify multiple, delimited by comma.

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/baseball/o/{organizationId}/sites/{siteId}/venues

Get a venue

get
/baseball/o/{organizationId}/venues/{venueId}

Return detailed information about a specific venue

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
venueIdstring · uuidRequired

The unique identifier of the venue

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
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}/venues/{venueId}

Update a venue

put
/baseball/o/{organizationId}/venues/{venueId}

Change the information of a specific venue

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
venueIdstring · uuidRequired

The unique identifier of the venue

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
siteIdstring · uuid | nullableOptional

The site that this venue belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
abbreviationLocalstring | nullableOptional

An abbreviation/short name in the local language

Example: NFA
nameLocalstring · max: 150Optional

The name of the venue in the local language

Example: Test name local
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Default: ACTIVEExample: ACTIVEPossible values:
alternateNameLocalstring | nullableOptional

The alternate name of the venue, in Local Language

Example: Test venue
abbreviationLatinstring | nullableOptional

An abbreviation/short name in latin characters

Example: NFA
nameLatinstring | nullableOptional

The name of the venue in latin characters

Example: Test name latin
alternateNameLatinstring | nullableOptional

The alternate name of the venue, in Latin characters

Example: Test venue
countryCodestring | nullableOptional

Country code of the venue. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.

Example: USA
timezonestring · max: 150Optional

Timezone of the venue. The name of the zone as defined by the IANA TZ database. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example: Australia/Sydney
capacityinteger · int32 | nullableOptional

This is the maximum number of people allowed for the venue in normal use. Certain events/configurations of the venue may cause this capacity to be increased/decreased - this is not reflected in this value.

Example: 12300
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}/venues/{venueId}

Delete a venue

delete
/baseball/o/{organizationId}/venues/{venueId}

Delete a specific venue

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
venueIdstring · uuidRequired

The unique identifier of the venue

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)]
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}/venues/{venueId}

Last updated

Was this helpful?