Table Of Contents

Person

What is a Person? Person is a representation of a real-life person which can be used in specific context:

• For Competitors of type Player it is the person behind the player.

• For Competitors of type Team it is part of their squad, or is the coach, or the owner.

• For Competitors of type Doubles Partnership it is the persons behind the Doubles Partnership or their coach.

• For Competitors of type Dog and Horse it is the trainer, the owner or the breeder.
  - For Competitors of type Horses it could also be its Jockey

• For FixtureOfficials either Official Referee or Assistant Referee

Person relation with Competitors of different types is called Contract for simplicity

A Person will be considered duplicate when all of the following is the same: FirstName, LastName, DateOfBirth, GSS Locality Id, GenderType and NickName

When to use

The Person entity is needed in cases when you want to add Person to the Squad of the Team Competitor or when you want to create a Player for specific sport.

How to use

The Person entity can be used by getting its GSS Id from the Fixtures API v2 on endpoint /v2/persons. And then set the received GSS Id to the request which is going to be made to Fixtures API v2 when it is needed.

Example workflow

1. GET GSS Persons from Fixtures API v2

   curl --location --request GET 'https://ci.fixtures.api.geniussports.com/v2/persons' \ --header 'x-api-key: <<api_key>>' \ --header 'Content-Type: application/json' \ --header 'Authorization: <<id_token>>' \ --data-raw ''

   The successful response would be with status code 200 and JSON data in the format:

   { "page": 0, "pageSize": 0, "totalItems": 0, "items": [ { "id": 0, // The GSS Id of the person "fullName": "string", // The Full Name of the Person (combination between FirstName + ' ' + LastName) "firstName": "string", // The First Name of the Person "lastName": "string", // The Last Name of the Person "genderType": "string", // The Gender of the Person Defines in which Teams it can take part and the Gender of the real-life person "dateOfBirth": "2022-06-23T10:34:52.745Z", // The Date of birth of the Person (if available) "isActive": true, // Whether the Person can be used in Contracts or in Fixture Officials "nickName": "string", // The Nickname of the Person (if available) "useNickname": true, // Whether the Person will be displayed with its Nickname when used in Players/Doubles Partnership names "locality": { "id": 0, // The GSS Id of the Country from where the Person comes from, aka Nationality of the Person "name": "string", "ref": "/localities/{id}" // Endpoint on which the Locality is available }, "sports": [ { "id": 0, // The GSS Ids of the sports in which the Person can be used for Contracts or for FixtureOfficials "name": "string", "ref": "/sports/{id}" // Endpoint on which Sport is available } ], "createdOn": "2022-06-23T10:34:52.745Z", // When was the Person created "modifiedOn": "2022-06-23T10:34:52.745Z", // When was the Person last updated "updatesCount": 0 // How many times the Person changed } ], "self": "string", "previous": "string", "next": "string", "first": "string", "last": "string" }

    

2. POST Fixture Official with any of the received GSS Person Ids

   curl --location --request POST 'https://ci.fixtures.api.geniussports.com/v2/fixtures/{gssFixtureId}/officials' \ --header 'x-api-key: <<api_key>>' \ --header 'Content-Type: application/json' \ --header 'Authorization: <<id_token>>' \ --data-raw '{ "personId": 0, // GSS Person Id "personRole": 0 // Whether the Person is Official Referee or Assistant Referee (the 0 is Official Referee) } '

    

Important

Read Data Points

Create/ Update Data Points

Validations