Uniform Items

Manage Uniform Items data

Get a list of Uniform Items

get
/baseball/o/{organizationId}/uniforms/{uniformId}/items

Return a list of Uniform Items

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

The unique identifier of the uniform

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
itemTypestring · enum · max: 100Optional

The type of Uniform Item

  • BOTTOM Bottom
  • GOALKEEPER_BOTTOM Goal Keeper Bottom
  • GOALKEEPER_TOP Goal Keeper Top
  • HELMET Helmet
  • SOCKS Socks
  • TOP Top
  • WARMUP_BOTTOM Warmup Bottom
  • WARMUP_TOP Warmup Top
Example: JERSEYPossible values:
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
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|,)*$
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}/uniforms/{uniformId}/items

Create a new Uniform Item

post
/baseball/o/{organizationId}/uniforms/{uniformId}/items

Insert a new Uniform Item

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

The unique identifier of the uniform

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

The unique identifier of the Uniform Item

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
uniformIdstring · uuidRequired

The unique identifier of the uniform

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
itemTypestring · enum · max: 100Required

The type of Uniform Item

  • BOTTOM Bottom
  • GOALKEEPER_BOTTOM Goal Keeper Bottom
  • GOALKEEPER_TOP Goal Keeper Top
  • HELMET Helmet
  • SOCKS Socks
  • TOP Top
  • WARMUP_BOTTOM Warmup Bottom
  • WARMUP_TOP Warmup Top
Example: TOPPossible values:
nameLocalstring · max: 150Optional

The name of the uniform_items in the local language

Example: Test name local
nameLatinstring | nullableOptional

The name of the uniform_items in latin characters

Example: Test uniform
Responses
200

Successful operation

application/json
post
/baseball/o/{organizationId}/uniforms/{uniformId}/items

Get a list of Uniform Items for a season

get
/baseball/o/{organizationId}/seasons/{seasonId}/uniforms/items

Return a list of Uniform Items 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
dateFromEndstring · dateOptional

Where dateFrom <= this value

Example: 2018-08-16
dateFromStartstring · dateOptional

Where dateFrom >= this value

Example: 2018-08-16
dateToEndstring · dateOptional

Where dateTo <= this value

Example: 2018-08-16
dateToStartstring · dateOptional

Where dateTo >= this value

Example: 2018-08-16
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
itemTypestring · enum · max: 100Optional

The type of Uniform Item

  • BOTTOM Bottom
  • GOALKEEPER_BOTTOM Goal Keeper Bottom
  • GOALKEEPER_TOP Goal Keeper Top
  • HELMET Helmet
  • SOCKS Socks
  • TOP Top
  • WARMUP_BOTTOM Warmup Bottom
  • WARMUP_TOP Warmup Top
Example: JERSEYPossible values:
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
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|,)*$
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}/uniforms/items

Get Uniform Item data

get
/baseball/o/{organizationId}/uniforms/items/{uniformItemId}

Return detailed information about a specific Uniform Item

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

The unique identifier of the uniform item

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}/uniforms/items/{uniformItemId}

Update Uniform Item

put
/baseball/o/{organizationId}/uniforms/items/{uniformItemId}

Change the information of a specific Uniform Item

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

The unique identifier of the uniform item

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

The unique identifier of the uniform

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
itemTypestring · enum · max: 100Optional

The type of Uniform Item

  • BOTTOM Bottom
  • GOALKEEPER_BOTTOM Goal Keeper Bottom
  • GOALKEEPER_TOP Goal Keeper Top
  • HELMET Helmet
  • SOCKS Socks
  • TOP Top
  • WARMUP_BOTTOM Warmup Bottom
  • WARMUP_TOP Warmup Top
Example: TOPPossible values:
nameLocalstring · max: 150Optional

The name of the uniform_items in the local language

Example: Test name local
nameLatinstring | nullableOptional

The name of the uniform_items in latin characters

Example: Test uniform
Responses
200

Successful operation

application/json
put
/baseball/o/{organizationId}/uniforms/items/{uniformItemId}

Delete Uniform Item

delete
/baseball/o/{organizationId}/uniforms/items/{uniformItemId}

Delete a specific Uniform Item

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

The unique identifier of the uniform item

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}/uniforms/items/{uniformItemId}

Create a new Uniform Item base route

post
/baseball/o/{organizationId}/uniforms/items

Insert a new Uniform Item allowing uniformId to be in payload

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

The unique identifier of the Uniform Item

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
uniformIdstring · uuidRequired

The unique identifier of the uniform

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
itemTypestring · enum · max: 100Required

The type of Uniform Item

  • BOTTOM Bottom
  • GOALKEEPER_BOTTOM Goal Keeper Bottom
  • GOALKEEPER_TOP Goal Keeper Top
  • HELMET Helmet
  • SOCKS Socks
  • TOP Top
  • WARMUP_BOTTOM Warmup Bottom
  • WARMUP_TOP Warmup Top
Example: TOPPossible values:
nameLocalstring · max: 150Optional

The name of the uniform_items in the local language

Example: Test name local
nameLatinstring | nullableOptional

The name of the uniform_items in latin characters

Example: Test uniform
Responses
200

Successful operation

application/json
post
/baseball/o/{organizationId}/uniforms/items

Last updated

Was this helpful?