/match

List Matches

Lists all matches available. Under most circumstances, this will requires that a profile be made available to the request. The server may choose to return an error if no suitable profile can be determined.

get

/match

Authorizations

auth_bearersession_secret

Query parameters

offsetany · default: 0

countany · default: 20

searchany

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:8080/api/rest/match' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Creates a Match

This method accepts an instance of Match, effectively requesting that the server find a suitable opponent for a game. As other suitable players create matches the created match object may be updated as a suitable opponent is found. The client must poll matches for updates and react accordingly.

post

/match

Authorizations

auth_bearersession_secret

Body

idany

The unique ID of the match.

schemeanyrequired

The scheme to use when matching with other players.

scopeany

An optional scope for the match. For example, if the match were part of a tournament, it could be scoped to the unique ID of the tournament.

playerobjectrequired

opponentobject

lastUpdatedTimestampany

The time of the last modification of the match.

gameIdany

The system-assigned game ID of the match. Null until the match is successfully made.

metadataany

Additional arbitrary metadata that is attached to the match.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/match' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "scheme": null,
    "scope": null,
    "player": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "name": null,
        "description": null,
        "gitBranch": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": "[Circular Reference]"
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "state": "EMPTY",
        "lastModified": null
      },
      "displayName": null,
      "metadata": null,
      "lastLogin": null
    },
    "opponent": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "name": null,
        "description": null,
        "gitBranch": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": "[Circular Reference]"
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "state": "EMPTY",
        "lastModified": null
      },
      "displayName": null,
      "metadata": null,
      "lastLogin": null
    },
    "lastUpdatedTimestamp": null,
    "gameId": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Gets a Specific Match

Gets a specific match given the match's unique ID. Additionally, it is possible to instruct the API to wait for a period of time before sending the response. The request will intentionally hang until the requested Match with ID has been updated in the database.

get

/match/{matchId}

Authorizations

auth_bearersession_secret

Path parameters

matchIdanyrequired

Header parameters

SocialEngine-LongPoll-Timeoutany

The maximum amount time the server will wait until a request returns a default set of data for long polling. Specifying a zero will request that the server wait indefinitely until responding. Though, the server may enforce a practical upper limit on the amount of time it takes to return. Omitting this header will prompt the server to treat the request as a normal request.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:8080/api/rest/match/{matchId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Deletes a Match

Deletes and permanently removes the Match fromt he server. This effectively will cancel any pending request for a match. If a game is currently being played agaist the match, the server may reject the request to delete the match until the game concludes.

delete

/match/{matchId}

Authorizations

auth_bearersession_secret

Path parameters

matchIdanyrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/match/{matchId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}