Persons

A Person is a human being involved (playing in, organizing, officiating or in some other way) with the organization.

A person belongs to only one organization. While logically a person could be involved over the course of their career in multiple organizations, in most cases (for the purpose of this API) they are treated as a different person.

A person belongs in teams, matches, competitions etc by virtue of their season rosters, fixture rosters or roles.

Get a list of persons

get
/basketball33/o/{organizationId}/persons

Return a list of available persons

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
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)]
genderstring · enumOptional

The gender of the person

  • FEMALE Female
  • MALE Male
  • UNKNOWN Unknown
Example: MALEPossible values:
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
nameFamilyLatinStartsWithstring · max: 50Optional

Family latin name starts with

nameFamilyLocalStartsWithstring · max: 50Optional

Family local name starts with

nameFullLatinstring · max: 50Optional

The full name of the person in latin characters

nameFullLatinContainsstring · 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: nameFullLatin=David Johnson nameFullLatinContains=Dav will match nameFullLatinContains=John will match nameFullLatinContains=son will not match

Example: Dav and nameFullLatin='David Johnson'
nameFullLocalstring · max: 50Optional

The full name of the person

nameFullLocalContainsstring · 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: nameFullLocal=David Johnson nameFullLocalContains=Dav will match nameFullLocalContains=John will match nameFullLocalContains=son will not match

Example: Dav and nameFullLocal='David Johnson'
nationalitystring · min: 3 · max: 3Optional

A 3 letter nationality code

Example: AUS
offsetinteger · int32Optional

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

Example: 10
personIdsstring · uuidOptional

The unique identifiers of the persons (comma-delimited).

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005
representingstring · max: 100Optional

Who the person was representing

Example: AUSTRALIA
representingCountrystring · enumOptional

What country representation is used

  • ANY Any country
  • NONE No country
Possible 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: -nameFullLocal,nameFullLatinPattern: ^(\-?nameFullLocal|\-?nameFullLatin|,)*$
statusstring · enumOptional

Status

  • ACTIVE Active
  • DECEASED Deceased
  • INACTIVE Inactive
  • PENDING Pending
  • UNREGISTERED UnRegistered
Example: ACTIVEPossible values:
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
/basketball33/o/{organizationId}/persons

Create a person

post
/basketball33/o/{organizationId}/persons

Insert a new person

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

The unique identifier of the person

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

Status

  • ACTIVE Active
  • DECEASED Deceased
  • INACTIVE Inactive
  • PENDING Pending
  • UNREGISTERED UnRegistered
Default: ACTIVEExample: ACTIVEPossible values:
genderstring · enumRequired

The gender of the person

  • FEMALE Female
  • MALE Male
  • UNKNOWN Unknown
Example: MALEPossible values:
nameFullLocalstring · max: 200Required

The full name of the person in local language

Example: John Smith
nameAbbreviatedstring | nullableOptional

An abbreviated name for a person

Example: Pat
languageLocalstring | nullableOptional

The language code of the full name in local language. This code is a two letter (lower-case) ISO 639-1 language code.

Example: en
nameGivenLocalstring | nullableOptional

Given name of the person in local language

Example: John
nameFamilyLocalstring | nullableOptional

Family name of the person in local language

Example: Smith
nameFullLatinstring | nullableOptional

The full name of the person in latin characters

Example: John Smith
nameGivenLatinstring | nullableOptional

Given name of the person in latin characters

Example: John
nameFamilyLatinstring | nullableOptional

Family name of the person in latin characters

Example: Smith
dobstring · date | nullableOptional

Date of Birth

Example: 1978-08-24
nationalitystring | nullableOptional

A 3 letter nationality code. We recommend you use ISO-3166 where available.

Example: AUS
deceasedstring · date | nullableOptional

Date deceased

Example: 2016-09-08
representingstring | nullableOptional

Who the person or team was representing

Example: AUSTRALIA
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
/basketball33/o/{organizationId}/persons

Get a person

get
/basketball33/o/{organizationId}/persons/{personId}

Return detailed information about a specific person

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

The unique identifier of the person

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
/basketball33/o/{organizationId}/persons/{personId}

Update a person

put
/basketball33/o/{organizationId}/persons/{personId}

Change the information of a specific person

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

The unique identifier of the person

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
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • DECEASED Deceased
  • INACTIVE Inactive
  • PENDING Pending
  • UNREGISTERED UnRegistered
Default: ACTIVEExample: ACTIVEPossible values:
genderstring · enumOptional

The gender of the person

  • FEMALE Female
  • MALE Male
  • UNKNOWN Unknown
Example: MALEPossible values:
nameFullLocalstring · max: 200Optional

The full name of the person in local language

Example: John Smith
nameAbbreviatedstring | nullableOptional

An abbreviated name for a person

Example: Pat
languageLocalstring | nullableOptional

The language code of the full name in local language. This code is a two letter (lower-case) ISO 639-1 language code.

Example: en
nameGivenLocalstring | nullableOptional

Given name of the person in local language

Example: John
nameFamilyLocalstring | nullableOptional

Family name of the person in local language

Example: Smith
nameFullLatinstring | nullableOptional

The full name of the person in latin characters

Example: John Smith
nameGivenLatinstring | nullableOptional

Given name of the person in latin characters

Example: John
nameFamilyLatinstring | nullableOptional

Family name of the person in latin characters

Example: Smith
dobstring · date | nullableOptional

Date of Birth

Example: 1978-08-24
nationalitystring | nullableOptional

A 3 letter nationality code. We recommend you use ISO-3166 where available.

Example: AUS
deceasedstring · date | nullableOptional

Date deceased

Example: 2016-09-08
representingstring | nullableOptional

Who the person or team was representing

Example: AUSTRALIA
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
/basketball33/o/{organizationId}/persons/{personId}

Delete a person

delete
/basketball33/o/{organizationId}/persons/{personId}

Delete a specific person

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

The unique identifier of the person

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
/basketball33/o/{organizationId}/persons/{personId}

Create/Update a person

post
/basketball33/o/{organizationId}/persons/force

Depending on data, Add a new person or update an existing one

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

The unique identifier of the person

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

Status

  • ACTIVE Active
  • DECEASED Deceased
  • INACTIVE Inactive
  • PENDING Pending
  • UNREGISTERED UnRegistered
Default: ACTIVEExample: ACTIVEPossible values:
genderstring · enumRequired

The gender of the person

  • FEMALE Female
  • MALE Male
  • UNKNOWN Unknown
Example: MALEPossible values:
nameFullLocalstring · max: 200Required

The full name of the person in local language

Example: John Smith
nameAbbreviatedstring | nullableOptional

An abbreviated name for a person

Example: Pat
languageLocalstring | nullableOptional

The language code of the full name in local language. This code is a two letter (lower-case) ISO 639-1 language code.

Example: en
nameGivenLocalstring | nullableOptional

Given name of the person in local language

Example: John
nameFamilyLocalstring | nullableOptional

Family name of the person in local language

Example: Smith
nameFullLatinstring | nullableOptional

The full name of the person in latin characters

Example: John Smith
nameGivenLatinstring | nullableOptional

Given name of the person in latin characters

Example: John
nameFamilyLatinstring | nullableOptional

Family name of the person in latin characters

Example: Smith
dobstring · date | nullableOptional

Date of Birth

Example: 1978-08-24
nationalitystring | nullableOptional

A 3 letter nationality code. We recommend you use ISO-3166 where available.

Example: AUS
deceasedstring · date | nullableOptional

Date deceased

Example: 2016-09-08
representingstring | nullableOptional

Who the person or team was representing

Example: AUSTRALIA
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
/basketball33/o/{organizationId}/persons/force

Last updated

Was this helpful?