judobase.schemas.Event

pydantic model judobase.schemas.Event

Represents the data about contest events by the Judobase API.

Each event includes data about the time, participants, type of event, and tags that describe specific actions or referee decisions.

Provided by the contest.fnd method of Judobase API with events in part param.

Show JSON schema

{
   "title": "Event",
   "description": "Represents the data about contest events by the Judobase API.\n\nEach event includes data about the time, participants, type of event,\nand tags that describe specific actions or referee decisions.\n\nProvided by the ``contest.fnd`` method of Judobase API with ``events`` in ``part`` param.",
   "type": "object",
   "properties": {
      "id_event": {
         "description": "The unique identifier for the event.",
         "title": "Event ID",
         "type": "string"
      },
      "contest_code_long": {
         "description": "The long contest code representing the event.",
         "title": "Contest Code",
         "type": "string"
      },
      "time_real": {
         "description": "The actual time in the match when the event occurred.",
         "title": "Real Time",
         "type": "number"
      },
      "time_sc": {
         "description": "The official match clock time at the event moment.",
         "title": "Sport Clock Time",
         "type": "number"
      },
      "tags": {
         "default": null,
         "description": "A list of tags describing the nature of the event.",
         "items": {
            "$ref": "#/$defs/EventTag"
         },
         "title": "Tags",
         "type": "array"
      },
      "actors": {
         "default": null,
         "description": "A list of participants involved in the event.",
         "items": {
            "$ref": "#/$defs/EventActor"
         },
         "title": "Actors",
         "type": "array"
      },
      "video_offset": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The time offset in the match video where the event appears.",
         "title": "Video Offset"
      },
      "rating": {
         "default": 0,
         "description": "A rating assigned to the event (if applicable).",
         "title": "Rating",
         "type": "integer"
      },
      "id_contest_event_type": {
         "description": "The identifier for the type of event that occurred.",
         "title": "Event Type ID",
         "type": "integer"
      },
      "public": {
         "default": true,
         "description": "Indicates if the event is publicly accessible.",
         "title": "Public",
         "type": "boolean"
      },
      "official": {
         "default": true,
         "description": "Indicates if the event is officially recognized.",
         "title": "Official",
         "type": "boolean"
      }
   },
   "$defs": {
      "EventActor": {
         "description": "Represents the data about event actors.",
         "properties": {
            "actor_type": {
               "description": "The actor type.",
               "title": "Actor Type",
               "type": "string"
            },
            "id_event": {
               "description": "The unique identifier for the event.",
               "title": "Event ID",
               "type": "string"
            },
            "id_actor": {
               "description": "The unique identifier for the tag actor.",
               "title": "Actor ID",
               "type": "string"
            },
            "family_name": {
               "description": "Family name of the competitor.",
               "title": "Family Name",
               "type": "string"
            },
            "given_name": {
               "description": "Given name of the competitor.",
               "title": "Given Name",
               "type": "string"
            },
            "id_person": {
               "description": "The unique identifier for the competitor.",
               "title": "Person ID",
               "type": "string"
            },
            "country_short": {
               "description": "Short country code for the competitor.",
               "title": "Country Short",
               "type": "string"
            }
         },
         "required": [
            "actor_type",
            "id_event",
            "id_actor",
            "family_name",
            "given_name",
            "id_person",
            "country_short"
         ],
         "title": "EventActor",
         "type": "object"
      },
      "EventTag": {
         "description": "Represents the data about event tags.",
         "properties": {
            "name": {
               "description": "The name of happened event.",
               "title": "Event name",
               "type": "string"
            },
            "id_tag": {
               "description": "The unique identifier for the tag.",
               "title": "Tag ID",
               "type": "string"
            },
            "id_event": {
               "description": "The unique identifier for the event.",
               "title": "Event ID",
               "type": "number"
            },
            "id_group": {
               "description": "The unique identifier for the tag main group.",
               "title": "Tag group ID",
               "type": "number"
            },
            "group_name": {
               "description": "The name of the tag main group.",
               "title": "Tag group name",
               "type": "string"
            },
            "code_short": {
               "description": "The short code for the tag.",
               "title": "Short Tag code",
               "type": "string"
            },
            "public": {
               "description": "Indicates if the tag is publicly available.",
               "title": "Public Available",
               "type": "integer"
            },
            "id_groups": {
               "description": "The unique identifier for the tag groups.",
               "title": "Tag groups id",
               "type": "string"
            }
         },
         "required": [
            "name",
            "id_tag",
            "id_event",
            "id_group",
            "group_name",
            "code_short",
            "public",
            "id_groups"
         ],
         "title": "EventTag",
         "type": "object"
      }
   },
   "required": [
      "id_event",
      "contest_code_long",
      "time_real",
      "time_sc",
      "id_contest_event_type"
   ]
}

Fields:

• actors (list[judobase.schemas.EventActor])

• contest_code_long (str)

• id_contest_event_type (int)

• id_event (str)

• official (bool)

• public (bool)

• rating (int)

• tags (list[judobase.schemas.EventTag])

• time_real (float)

• time_sc (float)

• video_offset (float | None)

field actors: list[EventActor] = None

A list of participants involved in the event.

field contest_code_long: str [Required]

The long contest code representing the event.

field id_contest_event_type: int [Required]

The identifier for the type of event that occurred.

field id_event: str [Required]

The unique identifier for the event.

field official: bool = True

Indicates if the event is officially recognized.

field public: bool = True

Indicates if the event is publicly accessible.

field rating: int = 0

A rating assigned to the event (if applicable).

field tags: list[EventTag] = None

A list of tags describing the nature of the event.

field time_real: float [Required]

The actual time in the match when the event occurred.

field time_sc: float [Required]

The official match clock time at the event moment.

field video_offset: float | None = None

The time offset in the match video where the event appears.