Match

Describes a group of players that have been successfully matched.

The following is the list of all members included in the data model.

Member Description Type Format / Schema Default Value Identifier Unique Required
uid The universally unique identifier of the match. string uuid "" true true true
dateCreated The date and time that the match was created. string date-time now() false false true
dateModified The date and time tha tthe match was last modified. string date-time now() false false true
version The optimistic lock version. integer 0 false false true
criteria The list of criteria to use when filtering other tickets while searching for a match. array `` false false true
hostUid The UUID of the host user that made the match. string uuid "" false false true
numTeams The total number of teams represented in the match. number 0 false false true
serverUid The universally unique identifier of the session server associated with the match. string uuid "" false false true
teams The list of teams, containing player assignments, for the match. array `` false false true
teamSize The maximum number of players allowed per team. integer 0 false false true
users The list of UUIDs for each user involved in the match. array uuid `` false false true

Examples

Request

{
    "criteria": [
        "Criteria"
    ],
    "numTeams": 0,
    "teams": [
        "Team"
    ],
    "teamSize": 0,
    "users": [
        "string"
    ]
}

Response

{
    "uid": "5e6a53e6-4fcf-4bdb-a214-55fa61568fe7",
    "dateCreated": "2019-03-18T23:09:31.101Z",
    "dateModified": "2019-03-18T23:09:31.101Z",
    "version": 0,
    "criteria": [
        "Criteria"
    ],
    "hostUid": "37cb0de2-17fb-4ff6-81b5-f40d52222dd1",
    "numTeams": 0,
    "serverUid": "b12fa850-2635-4eae-9a88-580f2aa675ae",
    "teams": [
        "Team"
    ],
    "teamSize": 0,
    "users": [
        "string"
    ]
}

Members

uid

Type: string

Default Value: ""

Required: true

Unique Identifier

The universally unique identifier of the match.

dateCreated

Type: string

Default Value: now()

Required: true

The date and time that the match was created.

dateModified

Type: string

Default Value: now()

Required: true

The date and time tha tthe match was last modified.

version

Type: integer

Default Value: 0

Required: true

The optimistic lock version.

criteria

Type: array

Default Value: ``

Required: true

The list of criteria to use when filtering other tickets while searching for a match.

hostUid

Type: string

Default Value: ""

Required: true

The UUID of the host user that made the match.

numTeams

Type: number

Default Value: 0

Required: true

The total number of teams represented in the match.

serverUid

Type: string

Default Value: ""

Required: true

The universally unique identifier of the session server associated with the match.

teams

Type: array

Default Value: ``

Required: true

The list of teams, containing player assignments, for the match.

teamSize

Type: integer

Default Value: 0

Required: true

The maximum number of players allowed per team.

users

Type: array

Default Value: ``

Required: true

The list of UUIDs for each user involved in the match.

References

This data model is referenced in the following endpoints.

// TODO