Save Data | Elements Manual

Creates a save data document.

Gets a single save data document.

POSThttp://localhost:8080/api/rest/save_data

Body

slot*any

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

userIdany

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.

profileIdany

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.

contents*any

The contents of the save data.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Search Save Data Documents

Gets all save data documents available to the user.

GEThttp://localhost:8080/api/rest/save_data

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Creates a save data document.

Gets a single save data document.

PUThttp://localhost:8080/api/rest/save_data/{saveDataDocumentId}

Path parameters

saveDataDocumentId*any

Body

forceany

versionany

contents*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data/{saveDataDocumentId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Deletes a save data document

DELETEhttp://localhost:8080/api/rest/save_data/{saveDataDocumentId}

Path parameters

saveDataDocumentId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data/{saveDataDocumentId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

Get save data document.

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.

GEThttp://localhost:8080/api/rest/save_data/profile/{profileId}/{slot}

Path parameters

profileId*any

slot*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data/profile/{profileId}/{slot}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get save data document.

Gets a single save data document

GEThttp://localhost:8080/api/rest/save_data/{id}

Path parameters

id*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get save data document.

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.

GEThttp://localhost:8080/api/rest/save_data/user/{userId}/{slot}

Path parameters

userId*any

slot*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/save_data/user/{userId}/{slot}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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