/session/player/join

PUT https://api.sandbox-gameye.gameye.net/session/player/join

Request Body

Field	Type	Required	Description	Example
session	string	Yes	The ID of the session.	""
players	array	Yes	The list of player ID’s to join this session.	""

Code Examples

cURL

curl --location --request PUT 'https://api.sandbox-gameye.gameye.net/session/player/join' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "session": "",
  "players": []
}'

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "session": "",
   "players": []
});

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sandbox-gameye.gameye.net/session/player/join", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox-gameye.gameye.net/session/player/join")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "session": "",
   "players": []
})

response = https.request(request)
puts response.read_body

Python

import requests
import json

url = "https://api.sandbox-gameye.gameye.net/session/player/join"

payload = json.dumps({
   "session": "",
   "players": []
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

Responses

200

One or more player IDs have been registered as having joined this session.

Field	Type	Required
count	integer	Yes
players	array	Yes

// One or more player IDs have been registered as having joined this session.

{
  "count": 0,
  "players": [
    ""
  ]
}

401

You are not authorized to start a session. Please make sure that the included bearer token is correct.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// You are not authorized to start a session. Please make sure that the included bearer token is correct.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}

404

The provided session does not exist.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// The provided session does not exist.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}

422

Bad request. This may imply that the given request has invalid syntax.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// Bad request. This may imply that the given request has invalid syntax.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}