Unregistered Persons

Request: GET

Returns a list of people who participated in the match, yet were unknown to the system.

HTTP Request

GET /v1/{sport}/matches/{matchId}/persons/unregistered
GET /v1/{sport}/leagues/{leagueId}/persons/unregistered

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
Optional Parameters
matchId integer Unique identifier for the match.
leagueId integer Unique identifier for the league.
personType string What type of person to return data for. If not provided, defaults to PLAYER. Options are:
  • PLAYER
  • STAFF
  • ALL All types
useExternalForLeague integer If this value is set to the leagueId, then the URL parameter competitionId will instead refer to the externalId field of the competition entity in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns an array of Unregistered Person resources.

Request: POST

Resolve an unkown person in a match into a registered person.

When executed this method changes all records for the unkown person so they match the registered person. Note: This operation is not reversible.

HTTP Request

POST /v1/{sport}/matches/{matchId}/persons/unregistered/resolve

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
matchId integer Unique identifier for the match.
Optional Parameters
bulk integer Resolve multiple records.
useExternalForLeague integer If this value is set to the leagueId, then the content of the request body is interpreted differently. See the Request Body section for more information.

Request Body

In the request body supply a Unregistered Persons - Resolve resource. If the bulk parameter is specified then an array of resources is expected.

If the useExternalForLeague parameter is specified, then the following fields in the resource will be interpreted as the externalId of the specific entity instead of the unique identifier.

Response

Successful this method returns SUCCESS.