Save Data

Creates a save data document.

post

Gets a single save data document.

Authorizations

auth_bearersession_secret

Body

Used to create a save data document on the remote.

slotanyRequired

The slot of the property. Must be unique for user or profile.

userIdanyOptional

The id of the user which owns the save data. If specified, the user will own this save data and the profileId must be null or be owned by the user specified.

profileIdanyOptional

The id of the profile which owns the save data. If specified, the profile will own this save data and the userId must be null or be owned by the user specified.

contentsanyRequired

The contents of the save data.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/save_data HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "slot": null,
  "userId": null,
  "profileId": null,
  "contents": null
}

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

Search Save Data Documents

get

Gets all save data documents available to the user.

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptionalDefault: ""

profileIdanyOptionalDefault: ""

searchanyOptionalDefault: ""

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/save_data HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a save data document.

put

Gets a single save data document.

Authorizations

auth_bearersession_secret

Path parameters

saveDataDocumentIdanyRequired

Body

Updates a save data document. This accepts the contents of the document as well as the versioning information required to take the update properly.

forceanyOptional

versionanyOptional

contentsanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/save_data/{saveDataDocumentId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "force": null,
  "version": null,
  "contents": null
}

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

Deletes a save data document

delete

Authorizations

auth_bearersession_secret

Path parameters

saveDataDocumentIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

*/*

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/save_data/{saveDataDocumentId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Get save data document.

get

Gets a single save data document based on Profile ID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an profile id.

Authorizations

auth_bearersession_secret

Path parameters

profileIdanyRequired

slotanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/save_data/profile/{profileId}/{slot} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Get save data document.

get

Gets a single save data document

Authorizations

auth_bearersession_secret

Path parameters

idanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/save_data/{id} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Get save data document.

get

Gets a single save data document based on UserID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an user id.

Authorizations

auth_bearersession_secret

Path parameters

userIdanyRequired

slotanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/save_data/user/{userId}/{slot} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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