Applications

Searches application profiles

Searches all instances of ApplicationProfiles associated with the application. The search query may be a full text search.

GEThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration

Path parameters

applicationNameOrId*any

Query parameters

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Updates the ProductBundle

Updates the ProductBundle for the given ApplicationConfiguration

PUThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/{applicationConfigurationId}

Path parameters

applicationNameOrId*any

applicationConfigurationId*any

Body

*/*

any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/{applicationConfigurationId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
});
const data = await response.json();

Response

400401403404409500501503default

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

Search Applications

Performs a full-text search of all applications known to the server. As with other full-text endpoints this allows for pagination and offset.

GEThttp://localhost:8080/api/rest/application

Query parameters

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Creates a New Application

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

POSThttp://localhost:8080/api/rest/application

Body

application/json

name*any

Pattern: [^_]\w+

descriptionany

attributesany

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Get an Application

Gets the metadata for a single application. This may include more specific details not availble in the bulk-get or fetch operation.

GEThttp://localhost:8080/api/rest/application/{nameOrId}

Path parameters

nameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Updates an Application

Performs an update to an existing application known to the server.

PUThttp://localhost:8080/api/rest/application/{nameOrId}

Path parameters

nameOrId*any

Body

application/json

name*any

Pattern: [^_]\w+

descriptionany

attributesany

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Deletes an Application

Deletes a specific application known to the server.

DELETEhttp://localhost:8080/api/rest/application/{nameOrId}

Path parameters

nameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503

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

Creates a new Facebook ApplicationConfiguration

Creates a new Facebook ApplicationConfiguration with the specific ID or application.

POSThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook

Path parameters

applicationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationId*any

The AppID as it appears in the Facebook Developer Console

applicationSecret*any

The App Secret as it appears in the Facebook Developer Console

builtinApplicationPermissionsany

The set of built-in permissions connected clients will need to request.

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Gets a Facebook Application Configuration

Gets a single Facebook application based on unique name or ID.

GEThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Updates a Facebook ApplicationConfiguration

Updates an existing Facebook Application profile if it is known to the server.

PUThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationId*any

The AppID as it appears in the Facebook Developer Console

applicationSecret*any

The App Secret as it appears in the Facebook Developer Console

builtinApplicationPermissionsany

The set of built-in permissions connected clients will need to request.

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "category": "MATCHMAKING",
      "parent": {}
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes a Facebook ApplicationConfiguration

Deletes an existing Facebook Application profile if it is known to the server.

DELETEhttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/facebook/{applicationConfigurationNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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

Creates a new Firebase ApplicationConfiguration

Creates a new Firebase ApplicationConfiguration with the specific ID or application.

POSThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase

Path parameters

applicationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

projectId*any

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentials*any

The contents of the serviceAccountCredentials.json file.

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Gets a Firebase Application Configuration

Gets a single Firebase application based on unique name or ID.

GEThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Updates a Firebase ApplicationConfiguration

Updates an existing Firebase Application profile if it is known to the server.

PUThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

projectId*any

The contents of the serviceAccountCredentials.json file.

serviceAccountCredentials*any

The contents of the serviceAccountCredentials.json file.

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "category": "MATCHMAKING",
      "parent": {}
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes a Firebase ApplicationConfiguration

Deletes an existing Firebase Application profile if it is known to the server.

DELETEhttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/firebase/{applicationConfigurationNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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

Creates a new Google Play ApplicationConfiguration

Creates a new GooglePlay ApplicationConfiguration with the specific ID or application.

POSThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play

Path parameters

applicationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdany

jsonKeyany

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Gets a Google Play Application Configuration

Gets a single Google Play application based on unique name or ID.

GEThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Updates a Google Play ApplicationConfiguration

Updates an existing Google Play Application profile if it is known to the server.

PUThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationIdany

jsonKeyany

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "category": "MATCHMAKING",
      "parent": {}
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes a Google Play ApplicationConfiguration

Deletes an existing Google Play Application profile if it is known to the server.

DELETEhttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/google_play/{applicationConfigurationNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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

Creates a new iOS ApplicationConfiguration

Creates a new iOS ApplicationConfiguration with the specific ID or application.

POSThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios

Path parameters

applicationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Gets a iOS Application Configuration

Gets a single iOS application based on unique name or ID.

GEThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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

Updates a iOS ApplicationConfiguration

Updates an existing iOS Application profile if it is known to the server.

PUThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

applicationId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "category": "MATCHMAKING",
      "parent": {}
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes a iOS ApplicationConfiguration

Deletes an existing iOS Application profile if it is known to the server.

DELETEhttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/ios/{applicationConfigurationNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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

Creates a new iOS ApplicationConfiguration

Creates a new iOS ApplicationConfiguration with the specific ID or application.

POSThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking

Path parameters

applicationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

scheme*any

A user-sepecified unqiue identifier for the matching scheme. It is possible to specify multiple schemes per application, but each must be uniquely named. Each scheme allows for the specification of different scripts to handle the successful match. When requesting matchmaking services clients will specify the scheme to be used.

Pattern: [^_]\w+

algorithm*enum

Specifies the matching algorithm to use. Algorithms are builtin and implemented by the API services. Currently, only FIFO is supported.

FIFO

success*CallbackDefinition (object)

Defines a script method and a module to invoke.

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "algorithm": "FIFO",
      "category": "MATCHMAKING",
      "parent": {},
      "success": {}
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes a iOS ApplicationConfiguration

Deletes an existing iOS Application profile if it is known to the server.

DELETEhttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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

Updates a iOS ApplicationConfiguration

Updates an existing iOS Application profile if it is known to the server.

PUThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Body

*/*

idany

The database assigned ID for the application configuration.

category*enum

The category for the application configuration.

MATCHMAKINGPSN_PS4PSN_VITAIOS_APP_STOREANDROID_GOOGLE_PLAYFACEBOOKFIREBASEGOOGLE_SIGN_IN

uniqueIdentifierany

The application-configuration specific unique ID. (Varies by ConfigurationCategory)

parent*Application (object)

productBundlesany

The list of product bundles that may be rewarded upon successful IAP transactions.

scheme*any

A user-sepecified unqiue identifier for the matching scheme. It is possible to specify multiple schemes per application, but each must be uniquely named. Each scheme allows for the specification of different scripts to handle the successful match. When requesting matchmaking services clients will specify the scheme to be used.

Pattern: [^_]\w+

algorithm*enum

Specifies the matching algorithm to use. Algorithms are builtin and implemented by the API services. Currently, only FIFO is supported.

FIFO

success*CallbackDefinition (object)

Defines a script method and a module to invoke.

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "algorithm": "FIFO",
      "category": "MATCHMAKING",
      "parent": {},
      "success": {}
    }),
});
const data = await response.json();

Response

400401403404409500501503default

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

Gets a iOS Application Configuration

Gets a single iOS application based on unique name or ID.

GEThttp://localhost:8080/api/rest/application/{applicationNameOrId}/configuration/matchmaking/{applicationConfigurationNameOrId}

Path parameters

applicationNameOrId*any

applicationConfigurationNameOrId*any

Response

400401403404409500501503default

Body

application/json

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

JavaScriptCurlPython

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

Response

400401403404409500501503default

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