Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
get /pioneer/battlepass/list-battlepasses
GET list-battlepasses (pioneerBattlepassListBattlepassesGet)

Return type

inline_response_200_11

Example data

Content-Type: application/json
{
  "battlePassStates" : [ {
    "battlePassId" : 0.8008281904610115,
    "isOwned" : true,
    "claimedEntries" : [ 6.027456183070403, 6.027456183070403 ],
    "claimedPages" : [ 1.4658129805029452, 1.4658129805029452 ]
  }, {
    "battlePassId" : 0.8008281904610115,
    "isOwned" : true,
    "claimedEntries" : [ 6.027456183070403, 6.027456183070403 ],
    "claimedPages" : [ 1.4658129805029452, 1.4658129805029452 ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_11

Up
get /pioneer/bonuses
GET bonuses (pioneerBonusesGet)

Return type

inline_response_200_31

Example data

Content-Type: application/json
{
  "effects" : [ "", "" ],
  "items" : [ "", "" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_31

Up
get /pioneer/codex/entries/list
GET list (pioneerCodexEntriesListGet)

Return type

inline_response_200_34

Example data

Content-Type: application/json
{
  "entries" : [ {
    "entryAssetId" : 0.8008281904610115,
    "unlocked" : true
  }, {
    "entryAssetId" : 0.8008281904610115,
    "unlocked" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_34

Up
get /pioneer/community-event
GET community-event (pioneerCommunityEventGet)

Return type

inline_response_200_3

Example data

Content-Type: application/json
{
  "events" : [ {
    "topContributors" : [ {
      "tenancyUserExternalId" : 7.061401241503109,
      "contribution" : 5.637376656633329,
      "rank" : 2.3021358869347655
    }, {
      "tenancyUserExternalId" : 7.061401241503109,
      "contribution" : 5.637376656633329,
      "rank" : 2.3021358869347655
    } ],
    "totalContribution" : 9.301444243932576,
    "communityEventId" : 0.8008281904610115,
    "nearContributors" : [ {
      "tenancyUserExternalId" : 5.962133916683182,
      "contribution" : 6.027456183070403,
      "rank" : 1.4658129805029452
    }, {
      "tenancyUserExternalId" : 5.962133916683182,
      "contribution" : 6.027456183070403,
      "rank" : 1.4658129805029452
    } ]
  }, {
    "topContributors" : [ {
      "tenancyUserExternalId" : 7.061401241503109,
      "contribution" : 5.637376656633329,
      "rank" : 2.3021358869347655
    }, {
      "tenancyUserExternalId" : 7.061401241503109,
      "contribution" : 5.637376656633329,
      "rank" : 2.3021358869347655
    } ],
    "totalContribution" : 9.301444243932576,
    "communityEventId" : 0.8008281904610115,
    "nearContributors" : [ {
      "tenancyUserExternalId" : 5.962133916683182,
      "contribution" : 6.027456183070403,
      "rank" : 1.4658129805029452
    }, {
      "tenancyUserExternalId" : 5.962133916683182,
      "contribution" : 6.027456183070403,
      "rank" : 1.4658129805029452
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_3

Up
get /pioneer/compensations
GET compensations (pioneerCompensationsGet)

Return type

inline_response_200_30

Example data

Content-Type: application/json
{
  "compensations" : [ {
    "createdAt" : 1.4658129805029452,
    "sourceType" : "sourceType",
    "claimed" : true,
    "id" : "id",
    "source" : "source",
    "content" : {
      "items" : [ {
        "gameAssetId" : 6.027456183070403,
        "amount" : 0.8008281904610115,
        "subItems" : [ "", "" ]
      }, {
        "gameAssetId" : 6.027456183070403,
        "amount" : 0.8008281904610115,
        "subItems" : [ "", "" ]
      } ]
    },
    "updatedAt" : 5.962133916683182
  }, {
    "createdAt" : 1.4658129805029452,
    "sourceType" : "sourceType",
    "claimed" : true,
    "id" : "id",
    "source" : "source",
    "content" : {
      "items" : [ {
        "gameAssetId" : 6.027456183070403,
        "amount" : 0.8008281904610115,
        "subItems" : [ "", "" ]
      }, {
        "gameAssetId" : 6.027456183070403,
        "amount" : 0.8008281904610115,
        "subItems" : [ "", "" ]
      } ]
    },
    "updatedAt" : 5.962133916683182
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_30

Up
get /pioneer/expeditions
GET expeditions (pioneerExpeditionsGet)

Return type

inline_response_200_23

Example data

Content-Type: application/json
{
  "status" : {
    "raiderJoinedAt" : 5.962133916683182,
    "raiderId" : "raiderId",
    "nextTier" : 1.4658129805029452,
    "completedExpeditions" : 0.8008281904610115,
    "state" : "state",
    "currentTier" : 6.027456183070403
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_23

Up
post /pioneer/game-data/store
POST store (pioneerGameDataStorePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body gamedata_store_body (optional)
Body Parameter

Return type

inline_response_200_13

Example data

Content-Type: application/json
{
  "store-views" : {
    "views" : [ {
      "viewId" : 7.457744773683766,
      "sections" : [ {
        "entries" : [ {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        }, {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        } ],
        "sectionId" : 6.84685269835264
      }, {
        "entries" : [ {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        }, {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        } ],
        "sectionId" : 6.84685269835264
      } ]
    }, {
      "viewId" : 7.457744773683766,
      "sections" : [ {
        "entries" : [ {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        }, {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        } ],
        "sectionId" : 6.84685269835264
      }, {
        "entries" : [ {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        }, {
          "productId" : 1.0246457001441578,
          "storeProvider" : "storeProvider",
          "endDate" : 7.386281948385884,
          "startDate" : 1.4894159098541704,
          "entryId" : 1.2315135367772556
        } ],
        "sectionId" : 6.84685269835264
      } ]
    } ]
  },
  "products" : {
    "products" : [ {
      "reward" : {
        "rewardedItems" : [ {
          "gameAssetId" : 2.027123023002322,
          "amount" : 9.301444243932576,
          "slots" : [ "", "" ],
          "aliasInstanceId" : "aliasInstanceId",
          "hideInUi" : true,
          "durability" : 3.616076749251911,
          "maxAmount" : 4.145608029883936
        }, {
          "gameAssetId" : 2.027123023002322,
          "amount" : 9.301444243932576,
          "slots" : [ "", "" ],
          "aliasInstanceId" : "aliasInstanceId",
          "hideInUi" : true,
          "durability" : 3.616076749251911,
          "maxAmount" : 4.145608029883936
        } ],
        "randomRewards" : {
          "pools" : { },
          "maxAmount" : 7.061401241503109
        }
      },
      "gameAssetId" : 5.637376656633329,
      "childProductIds" : [ 0.8008281904610115, 0.8008281904610115 ],
      "cost" : {
        "costItems" : [ {
          "gameAssetId" : 5.962133916683182,
          "amount" : 6.027456183070403,
          "durability" : 1.4658129805029452
        }, {
          "gameAssetId" : 5.962133916683182,
          "amount" : 6.027456183070403,
          "durability" : 1.4658129805029452
        } ]
      },
      "productId" : 2.3021358869347655,
      "discriminator" : "discriminator"
    }, {
      "reward" : {
        "rewardedItems" : [ {
          "gameAssetId" : 2.027123023002322,
          "amount" : 9.301444243932576,
          "slots" : [ "", "" ],
          "aliasInstanceId" : "aliasInstanceId",
          "hideInUi" : true,
          "durability" : 3.616076749251911,
          "maxAmount" : 4.145608029883936
        }, {
          "gameAssetId" : 2.027123023002322,
          "amount" : 9.301444243932576,
          "slots" : [ "", "" ],
          "aliasInstanceId" : "aliasInstanceId",
          "hideInUi" : true,
          "durability" : 3.616076749251911,
          "maxAmount" : 4.145608029883936
        } ],
        "randomRewards" : {
          "pools" : { },
          "maxAmount" : 7.061401241503109
        }
      },
      "gameAssetId" : 5.637376656633329,
      "childProductIds" : [ 0.8008281904610115, 0.8008281904610115 ],
      "cost" : {
        "costItems" : [ {
          "gameAssetId" : 5.962133916683182,
          "amount" : 6.027456183070403,
          "durability" : 1.4658129805029452
        }, {
          "gameAssetId" : 5.962133916683182,
          "amount" : 6.027456183070403,
          "durability" : 1.4658129805029452
        } ]
      },
      "productId" : 2.3021358869347655,
      "discriminator" : "discriminator"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_13

Up
get /pioneer/inventory
GET inventory (pioneerInventoryGet)

Return type

inline_response_200_5

Example data

Content-Type: application/json
{
  "items" : [ {
    "maxDurability" : 5.962133916683182,
    "gameAssetId" : 1.4658129805029452,
    "amount" : 0.8008281904610115,
    "slots" : { },
    "instanceId" : "instanceId",
    "durability" : 6.027456183070403,
    "etag" : "etag",
    "updatedAt" : 5.637376656633329
  }, {
    "maxDurability" : 5.962133916683182,
    "gameAssetId" : 1.4658129805029452,
    "amount" : 0.8008281904610115,
    "slots" : { },
    "instanceId" : "instanceId",
    "durability" : 6.027456183070403,
    "etag" : "etag",
    "updatedAt" : 5.637376656633329
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_5

Up
post /pioneer/inventory/v1/mutate
POST mutate (pioneerInventoryV1MutatePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body v1_mutate_body (optional)
Body Parameter

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "changeset" : {
    "quests" : {
      "created" : { },
      "updatedObjectives" : [ "", "" ],
      "updated" : { },
      "createdObjectives" : [ "", "" ]
    },
    "stats" : {
      "scopedPlayerStats" : { }
    },
    "items" : {
      "deleted" : { },
      "created" : [ "", "" ],
      "updated" : [ {
        "maxDurability" : 5.962133916683182,
        "gameAssetId" : 1.4658129805029452,
        "amount" : 0.8008281904610115,
        "slots" : [ "slots", "slots" ],
        "instanceId" : "instanceId",
        "durability" : 6.027456183070403,
        "etag" : "etag",
        "updatedAt" : 5.637376656633329
      }, {
        "maxDurability" : 5.962133916683182,
        "gameAssetId" : 1.4658129805029452,
        "amount" : 0.8008281904610115,
        "slots" : [ "slots", "slots" ],
        "instanceId" : "instanceId",
        "durability" : 6.027456183070403,
        "etag" : "etag",
        "updatedAt" : 5.637376656633329
      } ]
    },
    "notifications" : [ "", "" ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200

400

Bad Request inline_response_400

404

Not Found inline_response_400

500

Internal Server Error inline_response_400

Up
get /pioneer/league
GET league (pioneerLeagueGet)

Return type

inline_response_200_4

Example data

Content-Type: application/json
{
  "rankId" : 5.637376656633329,
  "members" : [ {
    "tenancyUserExternalId" : 1.4658129805029452,
    "position" : 6.027456183070403,
    "transition" : 5.962133916683182,
    "points" : 0.8008281904610115
  }, {
    "tenancyUserExternalId" : 1.4658129805029452,
    "position" : 6.027456183070403,
    "transition" : 5.962133916683182,
    "points" : 0.8008281904610115
  } ],
  "rankWindowId" : 2.3021358869347655
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_4

Up
post /pioneer/levels/auto-claim
POST auto-claim (pioneerLevelsAutoClaimPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body levels_autoclaim_body (optional)
Body Parameter

Return type

inline_response_200_22

Example data

Content-Type: application/json
{
  "levels" : [ {
    "currentLevel" : 0.8008281904610115,
    "currentXp" : 6.027456183070403,
    "groupId" : 1.4658129805029452,
    "unclaimedRewards" : [ "", "" ]
  }, {
    "currentLevel" : 0.8008281904610115,
    "currentXp" : 6.027456183070403,
    "groupId" : 1.4658129805029452,
    "unclaimedRewards" : [ "", "" ]
  } ],
  "changeset" : {
    "quests" : {
      "created" : { },
      "updatedObjectives" : [ "", "" ],
      "updated" : { },
      "createdObjectives" : [ "", "" ]
    },
    "stats" : {
      "scopedPlayerStats" : { }
    },
    "items" : {
      "deleted" : { },
      "created" : [ "", "" ],
      "updated" : [ "", "" ]
    },
    "notifications" : [ "", "" ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_22

Up
get /pioneer/levels/list
GET list (pioneerLevelsListGet)

Return type

inline_response_200_33

Example data

Content-Type: application/json
{
  "levels" : [ {
    "currentLevel" : 0.8008281904610115,
    "currentXp" : 6.027456183070403,
    "groupId" : 1.4658129805029452,
    "unclaimedRewards" : [ "", "" ]
  }, {
    "currentLevel" : 0.8008281904610115,
    "currentXp" : 6.027456183070403,
    "groupId" : 1.4658129805029452,
    "unclaimedRewards" : [ "", "" ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_33

Up
get /pioneer/mastery/objectives
GET objectives (pioneerMasteryObjectivesGet)

Return type

inline_response_200_27

Example data

Content-Type: application/json
{
  "objectives" : [ {
    "amount" : 0.8008281904610115,
    "milestoneRewardStates" : [ "milestoneRewardStates", "milestoneRewardStates" ],
    "objectiveId" : 6.027456183070403,
    "rankWindowId" : 1.4658129805029452
  }, {
    "amount" : 0.8008281904610115,
    "milestoneRewardStates" : [ "milestoneRewardStates", "milestoneRewardStates" ],
    "objectiveId" : 6.027456183070403,
    "rankWindowId" : 1.4658129805029452
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_27

Up
post /pioneer/projects/list
POST list (pioneerProjectsListPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body projects_list_body (optional)
Body Parameter

Return type

inline_response_200_25

Example data

Content-Type: application/json
{
  "projects" : [ {
    "projectAssetId" : 0.8008281904610115,
    "state" : "state",
    "projectId" : "projectId",
    "goals" : [ "", "" ]
  }, {
    "projectAssetId" : 0.8008281904610115,
    "state" : "state",
    "projectId" : "projectId",
    "goals" : [ "", "" ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_25

Up
get /pioneer/quests
GET quests (pioneerQuestsGet)

Return type

inline_response_200_20

Example data

Content-Type: application/json
{
  "quests" : [ {
    "gameAssetId" : 6.027456183070403,
    "instanceId" : "instanceId",
    "edges" : [ {
      "questInstanceId" : "questInstanceId",
      "requiredState" : "requiredState"
    }, {
      "questInstanceId" : "questInstanceId",
      "requiredState" : "requiredState"
    } ],
    "etag" : "etag",
    "objectives" : [ "", "" ],
    "state" : "state",
    "expiresAt" : 0.8008281904610115,
    "updatedAt" : 1.4658129805029452
  }, {
    "gameAssetId" : 6.027456183070403,
    "instanceId" : "instanceId",
    "edges" : [ {
      "questInstanceId" : "questInstanceId",
      "requiredState" : "requiredState"
    }, {
      "questInstanceId" : "questInstanceId",
      "requiredState" : "requiredState"
    } ],
    "etag" : "etag",
    "objectives" : [ "", "" ],
    "state" : "state",
    "expiresAt" : 0.8008281904610115,
    "updatedAt" : 1.4658129805029452
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_20

Up
post /pioneer/quests/reconcile
POST reconcile (pioneerQuestsReconcilePost)

Return type

inline_response_200_35

Example data

Content-Type: application/json
{
  "changeset" : {
    "quests" : {
      "created" : { },
      "updatedObjectives" : [ "", "" ],
      "updated" : { },
      "createdObjectives" : [ "", "" ]
    },
    "stats" : {
      "scopedPlayerStats" : { }
    },
    "items" : {
      "deleted" : { },
      "created" : [ "", "" ],
      "updated" : [ "", "" ]
    },
    "notifications" : [ "", "" ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_35

Up
get /pioneer/quests/reroll-cost
GET reroll-cost (pioneerQuestsRerollCostGet)

Return type

inline_response_200_17

Example data

Content-Type: application/json
{
  "rerollsRemainingToday" : 1.4658129805029452,
  "costAmount" : 0.8008281904610115,
  "costGameAssetId" : 6.027456183070403
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_17

Up
get /pioneer/raiders
GET raiders (pioneerRaidersGet)

Return type

inline_response_200_26

Example data

Content-Type: application/json
{
  "raiders" : [ {
    "createdAt" : 0.8008281904610115,
    "raiderId" : "raiderId",
    "state" : "state"
  }, {
    "createdAt" : 0.8008281904610115,
    "raiderId" : "raiderId",
    "state" : "state"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_26

Up
post /pioneer/rank/list
POST list (pioneerRankListPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body rank_list_body (optional)
Body Parameter

Return type

inline_response_200_7

Example data

Content-Type: application/json
{
  "userRanks" : [ {
    "tenancyUserExternalId" : 1.4658129805029452,
    "rankId" : 6.027456183070403
  }, {
    "tenancyUserExternalId" : 1.4658129805029452,
    "rankId" : 6.027456183070403
  } ],
  "rankWindowId" : 0.8008281904610115
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_7

Up
get /pioneer/seasonal-rewards
GET seasonal-rewards (pioneerSeasonalRewardsGet)

Return type

inline_response_200_10

Example data

Content-Type: application/json
{
  "states" : [ {
    "rankId" : 0.8008281904610115,
    "rankSeasonId" : 6.027456183070403,
    "state" : "state"
  }, {
    "rankId" : 0.8008281904610115,
    "rankSeasonId" : 6.027456183070403,
    "state" : "state"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_10

Up
post /pioneer/stats/player-v2
POST player-v2 (pioneerStatsPlayerV2Post)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body stats_playerv2_body (optional)
Body Parameter

Return type

inline_response_200_24

Example data

Content-Type: application/json
{
  "scopedPlayerStats" : [ {
    "playerStats" : [ {
      "eventId" : 6.027456183070403,
      "amount" : 0.8008281904610115,
      "targetId" : 1.4658129805029452
    }, {
      "eventId" : 6.027456183070403,
      "amount" : 0.8008281904610115,
      "targetId" : 1.4658129805029452
    } ],
    "scope" : {
      "discriminant" : "discriminant"
    }
  }, {
    "playerStats" : [ {
      "eventId" : 6.027456183070403,
      "amount" : 0.8008281904610115,
      "targetId" : 1.4658129805029452
    }, {
      "eventId" : 6.027456183070403,
      "amount" : 0.8008281904610115,
      "targetId" : 1.4658129805029452
    } ],
    "scope" : {
      "discriminant" : "discriminant"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_24

Up
get /pioneer/store/get-microsoft-store-access-token
GET get-microsoft-store-access-token (pioneerStoreGetMicrosoftStoreAccessTokenGet)

Return type

inline_response_200_21

Example data

Content-Type: application/json
{
  "expiresIn" : 0.8008281904610115,
  "raw" : "raw"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_21

Up
post /pioneer/store/reconcile
POST reconcile (pioneerStoreReconcilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body store_reconcile_body (optional)
Body Parameter

Return type

inline_response_200_40

Example data

Content-Type: application/json
{
  "productIds" : [ 0.8008281904610115, 0.8008281904610115 ],
  "changeset" : {
    "quests" : {
      "created" : { },
      "updatedObjectives" : [ "", "" ],
      "updated" : { },
      "createdObjectives" : [ "", "" ]
    },
    "stats" : {
      "scopedPlayerStats" : { }
    },
    "items" : {
      "deleted" : { },
      "created" : [ "", "" ],
      "updated" : [ "", "" ]
    },
    "notifications" : [ "", "" ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_40

Up
post /pioneer/tenancy-user/sync
POST sync (pioneerTenancyUserSyncPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter

Return type

Object

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

Up
get /pioneer/timed-offers/transactions
GET transactions (pioneerTimedOffersTransactionsGet)

Return type

inline_response_200_19

Example data

Content-Type: application/json
{
  "timedOfferTransactions" : [ {
    "amount" : 0.8008281904610115,
    "durationInSeconds" : 6.027456183070403,
    "offerId" : 1.4658129805029452,
    "startTime" : 5.962133916683182,
    "transactionId" : "transactionId",
    "ownerInstanceId" : "ownerInstanceId"
  }, {
    "amount" : 0.8008281904610115,
    "durationInSeconds" : 6.027456183070403,
    "offerId" : 1.4658129805029452,
    "startTime" : 5.962133916683182,
    "transactionId" : "transactionId",
    "ownerInstanceId" : "ownerInstanceId"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_19

Up
post /shared/announcements
POST announcements (sharedAnnouncementsPost)

Return type

inline_response_200_28

Example data

Content-Type: application/json
{
  "announcements" : [ {
    "viewId" : 5.637376656633329,
    "contents" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "hookId" : 0.8008281904610115,
    "active" : true,
    "id" : 6.027456183070403,
    "endAt" : "endAt",
    "templateId" : 5.962133916683182,
    "startAt" : "startAt",
    "order" : 1.4658129805029452
  }, {
    "viewId" : 5.637376656633329,
    "contents" : [ {
      "value" : "value",
      "key" : "key"
    }, {
      "value" : "value",
      "key" : "key"
    } ],
    "hookId" : 0.8008281904610115,
    "active" : true,
    "id" : 6.027456183070403,
    "endAt" : "endAt",
    "templateId" : 5.962133916683182,
    "startAt" : "startAt",
    "order" : 1.4658129805029452
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_28

Up
post /shared/anticheat/restrictions
POST restrictions (sharedAnticheatRestrictionsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

inline_response_200_2

Example data

Content-Type: application/json
{
  "isRestricted" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_2

Up
post /shared/distribution-platform-achievements/get
POST distribution-platform-achievements get (sharedDistributionPlatformAchievementsGetPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

inline_response_200_29

Example data

Content-Type: application/json
{
  "achievements" : [ {
    "completed_time" : "completed_time",
    "progress" : 0.8008281904610115,
    "etag" : "etag",
    "id" : "id",
    "platform" : "platform"
  }, {
    "completed_time" : "completed_time",
    "progress" : 0.8008281904610115,
    "etag" : "etag",
    "id" : "id",
    "platform" : "platform"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_29

Up
get /shared/game-settings
GET game-settings (sharedGameSettingsGet)

Return type

inline_response_200_16

Example data

Content-Type: application/json
{
  "entries" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_16

Up
post /shared/get-persistent-player-keys
POST get-persistent-player-keys (sharedGetPersistentPlayerKeysPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter

Return type

inline_response_200_6

Example data

Content-Type: application/json
{
  "persistentPlayerKeys" : [ {
    "etag" : "etag",
    "value" : "value",
    "key" : "key"
  }, {
    "etag" : "etag",
    "value" : "value",
    "key" : "key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_6

Up
post /shared/heartbeat
POST heartbeat (sharedHeartbeatPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter

Responses

200

OK

Up
post /shared/inbox/get-messages
POST get-messages (sharedInboxGetMessagesPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body inbox_getmessages_body (optional)
Body Parameter

Return type

inline_response_200_32

Example data

Content-Type: application/json
{
  "messages" : [ {
    "messageName" : "messageName",
    "payload" : {
      "sourceType" : "sourceType",
      "compensationId" : "compensationId",
      "userId" : 6.027456183070403,
      "discriminator" : "discriminator"
    },
    "messageId" : 0.8008281904610115,
    "sentAt" : "sentAt",
    "seen" : true,
    "favorited" : true
  }, {
    "messageName" : "messageName",
    "payload" : {
      "sourceType" : "sourceType",
      "compensationId" : "compensationId",
      "userId" : 6.027456183070403,
      "discriminator" : "discriminator"
    },
    "messageId" : 0.8008281904610115,
    "sentAt" : "sentAt",
    "seen" : true,
    "favorited" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_32

Up
post /shared/localizations
POST localizations (sharedLocalizationsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

inline_response_200_15

Example data

Content-Type: application/json
{
  "entries" : [ {
    "namespace" : "namespace",
    "source" : "source",
    "value" : "value",
    "key" : "key"
  }, {
    "namespace" : "namespace",
    "source" : "source",
    "value" : "value",
    "key" : "key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_15

Up
post /shared/manifest
POST manifest (sharedManifestPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body shared_manifest_body (optional)
Body Parameter

Return type

inline_response_200_8

Example data

Content-Type: application/json
{
  "partitioningHash" : "partitioningHash",
  "retrievedAt" : 6.027456183070403,
  "nonPartitioningHash" : "nonPartitioningHash",
  "validUntil" : 5.962133916683182,
  "buildId" : "buildId",
  "partitioningBody" : {
    "p2CharacterSkillItemsArtifact" : "p2CharacterSkillItemsArtifact",
    "serverBuildIdentifier" : "serverBuildIdentifier",
    "p2PlayerStatsEventTargetsArtifact" : "p2PlayerStatsEventTargetsArtifact",
    "itemRepairsArtifact" : "itemRepairsArtifact",
    "p2OffersArtifact" : "p2OffersArtifact",
    "gameflags.live_event_active" : "gameflags.live_event_active",
    "p2RankSeasonsArtifact" : "p2RankSeasonsArtifact",
    "gameflags.devmode" : "gameflags.devmode",
    "gameflags.enable_winter_event_theme_in_frontend" : "gameflags.enable_winter_event_theme_in_frontend",
    "p2ProjectsArtifact" : "p2ProjectsArtifact",
    "p2CommunityEventsArtifact" : "p2CommunityEventsArtifact",
    "p2XpLevelGroupsArtifact" : "p2XpLevelGroupsArtifact",
    "gameflags.disable_item_modification_RPCs" : "gameflags.disable_item_modification_RPCs",
    "p2ItemsArtifact" : "p2ItemsArtifact",
    "gameflags.enable_discord_social_integration" : "gameflags.enable_discord_social_integration",
    "announcementsArtifact" : "announcementsArtifact",
    "matchmakingScenariosArtifact" : "matchmakingScenariosArtifact",
    "p2ItemRecycleArtifact" : "p2ItemRecycleArtifact",
    "gameflags.anticheat_floating_memory" : "gameflags.anticheat_floating_memory",
    "gameflags.enable_onboarding" : "gameflags.enable_onboarding",
    "gameflags.enable_pendulum_ice_movement" : "gameflags.enable_pendulum_ice_movement",
    "p2ExpeditionRewardTiersArtifact" : "p2ExpeditionRewardTiersArtifact",
    "p2CodexCategoriesArtifact" : "p2CodexCategoriesArtifact",
    "p2QuestsV2Artifact" : "p2QuestsV2Artifact",
    "gameflags.constructable_clamp_destroyed_part_forces" : "gameflags.constructable_clamp_destroyed_part_forces",
    "p2RankWindowsArtifact" : "p2RankWindowsArtifact",
    "p2CratesArtifact" : "p2CratesArtifact",
    "p2BattlePassLayoutArtifact" : "p2BattlePassLayoutArtifact",
    "p2ItemEconomyArtifact" : "p2ItemEconomyArtifact",
    "gameSettingsArtifact" : "gameSettingsArtifact",
    "itemScrapsArtifact" : "itemScrapsArtifact",
    "gameflags.embark_ctrlrigpbd_validate" : "gameflags.embark_ctrlrigpbd_validate",
    "p2RandomItemPoolsArtifact" : "p2RandomItemPoolsArtifact",
    "gameflags.enable_voice_conversion" : "gameflags.enable_voice_conversion",
    "p2XpLevelsArtifact" : "p2XpLevelsArtifact",
    "gameflags.enable_raider_den_shelf_overflow" : "gameflags.enable_raider_den_shelf_overflow",
    "p2StoreViewV2Artifact" : "p2StoreViewV2Artifact",
    "p2ItemUpgradesArtifact" : "p2ItemUpgradesArtifact",
    "encryptedVideosArtifact" : "encryptedVideosArtifact",
    "p2QuestsConfigArtifact" : "p2QuestsConfigArtifact",
    "tweaksArtifact" : "tweaksArtifact",
    "gameflags.anticheat" : "gameflags.anticheat",
    "p2HierarchicalItemConfigArtifactKey" : "p2HierarchicalItemConfigArtifactKey",
    "gameflags.merge_weapon_parts" : "gameflags.merge_weapon_parts",
    "enemyGroupsArtifact" : "enemyGroupsArtifact",
    "gameflags.enable_lone_wolf" : "gameflags.enable_lone_wolf",
    "p2GeneratedLoadoutArtifact" : "p2GeneratedLoadoutArtifact",
    "gameflags.enable_static_jit_stack_trace_in_shipping" : "gameflags.enable_static_jit_stack_trace_in_shipping",
    "gameflags.no_free_ammo_when_starting" : "gameflags.no_free_ammo_when_starting",
    "p2PlayerStatsEventsArtifact" : "p2PlayerStatsEventsArtifact",
    "p2ProductArtifact" : "p2ProductArtifact",
    "gameflags.show_voip_errors" : "gameflags.show_voip_errors",
    "p2ProductsViewEntryV3Artifact" : "p2ProductsViewEntryV3Artifact",
    "gameflags.show_voip_errors_windows_mic_privacy" : "gameflags.show_voip_errors_windows_mic_privacy",
    "gameflags.enable_fe_graduation_logic" : "gameflags.enable_fe_graduation_logic",
    "p2DefaultInventoryArtifact" : "p2DefaultInventoryArtifact",
    "p2BattlePassV2Artifact" : "p2BattlePassV2Artifact",
    "p2SkillTreeNodesArtifact" : "p2SkillTreeNodesArtifact",
    "p2XpEventRewardsArtifact" : "p2XpEventRewardsArtifact",
    "eventsArtifact" : "eventsArtifact",
    "gameflags.microphone_test" : "gameflags.microphone_test",
    "p2PlaytestProfilesArtifact" : "p2PlaytestProfilesArtifact",
    "seasonArtifact" : "seasonArtifact",
    "gameflags.enable_new_spawn_system" : "gameflags.enable_new_spawn_system",
    "persistentPlayerKeyArtifact" : "persistentPlayerKeyArtifact",
    "gameflags.enable_ui_texture_new_streaming" : "gameflags.enable_ui_texture_new_streaming",
    "gameflags.anticheat_file_integrity" : "gameflags.anticheat_file_integrity",
    "gameflags.show_voip_errors_overlay" : "gameflags.show_voip_errors_overlay",
    "localizationArtifact" : "localizationArtifact",
    "p2MasteryObjectivesArtifact" : "p2MasteryObjectivesArtifact",
    "p2RanksArtifact" : "p2RanksArtifact"
  },
  "id" : 0.8008281904610115,
  "validFrom" : 1.4658129805029452,
  "nonPartitioningBody" : {
    "buildMode" : "buildMode"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_8

Up
post /shared/notifications
POST notifications (sharedNotificationsPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

inline_response_200_1

Example data

Content-Type: application/json
{
  "nextFromNotificationId" : "nextFromNotificationId",
  "notifications" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_1

Up
post /shared/player/activity
POST activity (sharedPlayerActivityPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (optional)
Body Parameter

Return type

inline_response_200_36

Example data

Content-Type: application/json
{
  "match_id" : "match_id",
  "scenarioMetadata" : {
    "allowReconnects" : true,
    "scenarioName" : "scenarioName"
  },
  "etag" : "etag",
  "state" : 0.8008281904610115,
  "currentState" : "currentState",
  "ticket_id" : "ticket_id",
  "lobby_id" : "lobby_id",
  "tournament_id" : "tournament_id"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_36

Up
post /shared/profile/by-thirdparty-userid
POST by-thirdparty-userid (sharedProfileByThirdpartyUseridPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

inline_response_200_42

Example data

Content-Type: application/json
{
  "profiles" : { }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_42

Up
get /shared/proxy
GET proxy (sharedProxyGet)

Return type

inline_response_200_14

Example data

Content-Type: application/json
{
  "endpoints" : [ {
    "trafficPort" : 6.027456183070403,
    "host" : "host",
    "qcmpPort" : 0.8008281904610115,
    "region" : "region"
  }, {
    "trafficPort" : 6.027456183070403,
    "host" : "host",
    "qcmpPort" : 0.8008281904610115,
    "region" : "region"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_14

Up
get /shared/quilkin
GET quilkin (sharedQuilkinGet)

Return type

inline_response_200_12

Example data

Content-Type: application/json
{
  "packet_loss_threshold_duration_secs" : 5.962133916683182,
  "packet_loss_threshold_percent" : 5.637376656633329,
  "packet_jitter_threshold_duration_secs" : 1.4658129805029452,
  "initial_cooldown_duration_secs" : 6.027456183070403,
  "failover_cooldown_duration_secs" : 0.8008281904610115,
  "proxy_failover" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_12

Up
post /shared/scenarios
POST scenarios (sharedScenariosPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body shared_scenarios_body (optional)
Body Parameter

Return type

inline_response_200_18

Example data

Content-Type: application/json
{
  "matchmakingScenarios" : [ {
    "UISettings" : {
      "activePeriods" : { },
      "visible" : true,
      "active" : true,
      "visiblePeriods" : { },
      "disabled" : true
    },
    "name" : "name",
    "pioneerSettings" : {
      "mapConditions" : {
        "isOptIn" : true,
        "conditionSettings" : [ {
          "condition" : "condition",
          "durationInSecond" : 5.637376656633329,
          "conditionAssetId" : 5.962133916683182,
          "startTime" : 2.3021358869347655
        }, {
          "condition" : "condition",
          "durationInSecond" : 5.637376656633329,
          "conditionAssetId" : 5.962133916683182,
          "startTime" : 2.3021358869347655
        } ]
      }
    },
    "parameters" : {
      "characterLevelRequiredToPlay" : 0.8008281904610115,
      "maxSquadSize" : 6.027456183070403,
      "roundsRequiredToPlay" : 1.4658129805029452,
      "mapName" : "mapName",
      "gameMode" : "gameMode",
      "featureFlags" : { }
    }
  }, {
    "UISettings" : {
      "activePeriods" : { },
      "visible" : true,
      "active" : true,
      "visiblePeriods" : { },
      "disabled" : true
    },
    "name" : "name",
    "pioneerSettings" : {
      "mapConditions" : {
        "isOptIn" : true,
        "conditionSettings" : [ {
          "condition" : "condition",
          "durationInSecond" : 5.637376656633329,
          "conditionAssetId" : 5.962133916683182,
          "startTime" : 2.3021358869347655
        }, {
          "condition" : "condition",
          "durationInSecond" : 5.637376656633329,
          "conditionAssetId" : 5.962133916683182,
          "startTime" : 2.3021358869347655
        } ]
      }
    },
    "parameters" : {
      "characterLevelRequiredToPlay" : 0.8008281904610115,
      "maxSquadSize" : 6.027456183070403,
      "roundsRequiredToPlay" : 1.4658129805029452,
      "mapName" : "mapName",
      "gameMode" : "gameMode",
      "featureFlags" : { }
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_18

Up
post /shared/set-persistent-player-keys
POST set-persistent-player-keys (sharedSetPersistentPlayerKeysPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

inline_response_200_6

Example data

Content-Type: application/json
{
  "persistentPlayerKeys" : [ {
    "etag" : "etag",
    "value" : "value",
    "key" : "key"
  }, {
    "etag" : "etag",
    "value" : "value",
    "key" : "key"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_6

Up
get /shared/social/block-players/blocked-players
GET blocked-players (sharedSocialBlockPlayersBlockedPlayersGet)

Return type

inline_response_200_9

Example data

Content-Type: application/json
{
  "maxNumBlockedUsers" : 0.8008281904610115,
  "profiles" : [ {
    "accountId" : 1.4658129805029452,
    "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
    "thirdPartyUserId" : "thirdPartyUserId",
    "displayName" : {
      "name" : "name",
      "discriminator" : "discriminator"
    },
    "emailIsVerified" : true,
    "tos_version_seen" : "tos_version_seen",
    "tenancyUserId" : 5.962133916683182,
    "email" : "email",
    "voiceChatModerationConsent" : true
  }, {
    "accountId" : 1.4658129805029452,
    "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
    "thirdPartyUserId" : "thirdPartyUserId",
    "displayName" : {
      "name" : "name",
      "discriminator" : "discriminator"
    },
    "emailIsVerified" : true,
    "tos_version_seen" : "tos_version_seen",
    "tenancyUserId" : 5.962133916683182,
    "email" : "email",
    "voiceChatModerationConsent" : true
  } ],
  "playerIds" : [ 6.027456183070403, 6.027456183070403 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_9

Up
get /shared/social/friends/get-friends
GET get-friends (sharedSocialFriendsGetFriendsGet)

Return type

inline_response_200_38

Example data

Content-Type: application/json
{
  "friends" : [ {
    "friendship_type" : "friendship_type",
    "createdAt" : 0.8008281904610115,
    "discord_user_id" : "discord_user_id",
    "profile" : {
      "accountId" : 6.027456183070403,
      "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
      "thirdPartyUserId" : "thirdPartyUserId",
      "displayName" : {
        "name" : "name",
        "discriminator" : "discriminator"
      },
      "emailIsVerified" : true,
      "tos_version_seen" : "tos_version_seen",
      "tenancyUserId" : 1.4658129805029452,
      "email" : "email",
      "voiceChatModerationConsent" : true
    }
  }, {
    "friendship_type" : "friendship_type",
    "createdAt" : 0.8008281904610115,
    "discord_user_id" : "discord_user_id",
    "profile" : {
      "accountId" : 6.027456183070403,
      "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
      "thirdPartyUserId" : "thirdPartyUserId",
      "displayName" : {
        "name" : "name",
        "discriminator" : "discriminator"
      },
      "emailIsVerified" : true,
      "tos_version_seen" : "tos_version_seen",
      "tenancyUserId" : 1.4658129805029452,
      "email" : "email",
      "voiceChatModerationConsent" : true
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_38

Up
get /shared/social/party/get
GET party get (sharedSocialPartyGetGet)

Return type

inline_response_200_39

Example data

Content-Type: application/json
{
  "max_party_size" : 0.8008281904610115,
  "party" : {
    "party_privacy" : "party_privacy",
    "party_id" : "party_id",
    "invite_permission" : "invite_permission",
    "party_members" : [ {
      "profile" : {
        "accountId" : 5.962133916683182,
        "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
        "thirdPartyUserId" : "thirdPartyUserId",
        "displayName" : {
          "name" : "name",
          "discriminator" : "discriminator"
        },
        "emailIsVerified" : true,
        "tos_version_seen" : "tos_version_seen",
        "tenancyUserId" : 5.637376656633329,
        "email" : "email",
        "voiceChatModerationConsent" : true
      }
    }, {
      "profile" : {
        "accountId" : 5.962133916683182,
        "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
        "thirdPartyUserId" : "thirdPartyUserId",
        "displayName" : {
          "name" : "name",
          "discriminator" : "discriminator"
        },
        "emailIsVerified" : true,
        "tos_version_seen" : "tos_version_seen",
        "tenancyUserId" : 5.637376656633329,
        "email" : "email",
        "voiceChatModerationConsent" : true
      }
    } ],
    "members_data" : [ {
      "crossplay_enabled" : true,
      "platform_provider" : "platform_provider",
      "tenancy_user_id" : 1.4658129805029452,
      "platform_session_id" : "platform_session_id",
      "ready_for_matchmaking" : true
    }, {
      "crossplay_enabled" : true,
      "platform_provider" : "platform_provider",
      "tenancy_user_id" : 1.4658129805029452,
      "platform_session_id" : "platform_session_id",
      "ready_for_matchmaking" : true
    } ],
    "attributes" : {
      "destination" : "destination"
    },
    "leader_tenancy_user_id" : 6.027456183070403,
    "join_secret" : "join_secret"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_39

Up
post /shared/social/party/v2/update-party-member-data
POST update-party-member-data (sharedSocialPartyV2UpdatePartyMemberDataPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Object

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

Up
post /shared/social/presence/get
POST presence get (sharedSocialPresenceGetPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body presence_get_body (optional)
Body Parameter

Return type

inline_response_200_41

Example data

Content-Type: application/json
{
  "usersRichPresence" : [ {
    "embarkUserId" : 0.8008281904610115,
    "richPresence" : "richPresence",
    "attributes" : { },
    "isOnline" : true,
    "tenancyUserId" : 6.027456183070403,
    "platform" : "platform",
    "updatedAt" : 1.4658129805029452
  }, {
    "embarkUserId" : 0.8008281904610115,
    "richPresence" : "richPresence",
    "attributes" : { },
    "isOnline" : true,
    "tenancyUserId" : 6.027456183070403,
    "platform" : "platform",
    "updatedAt" : 1.4658129805029452
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_41

Up
post /shared/social/presence/set-rich-presence
POST set-rich-presence (sharedSocialPresenceSetRichPresencePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

Object

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

Up
get /shared/social/recently-played-with
GET recently-played-with (sharedSocialRecentlyPlayedWithGet)

Return type

inline_response_200_37

Example data

Content-Type: application/json
{
  "recentlyPlayedWith" : [ {
    "playedAt" : "playedAt",
    "profile" : {
      "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
      "embarkAccountId" : 0.8008281904610115,
      "thirdPartyUserId" : "thirdPartyUserId",
      "displayName" : {
        "name" : "name",
        "discriminator" : "discriminator"
      },
      "tenancyUserId" : 6.027456183070403
    },
    "tenancyUserId" : 1.4658129805029452
  }, {
    "playedAt" : "playedAt",
    "profile" : {
      "thirdPartyLastSeenAccountName" : "thirdPartyLastSeenAccountName",
      "embarkAccountId" : 0.8008281904610115,
      "thirdPartyUserId" : "thirdPartyUserId",
      "displayName" : {
        "name" : "name",
        "discriminator" : "discriminator"
      },
      "tenancyUserId" : 6.027456183070403
    },
    "tenancyUserId" : 1.4658129805029452
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200_37

Models

[ Jump to Methods ]

Table of Contents

  1. anticheat_restrictions_body
  2. distributionplatformachievements_get_body
  3. gamedata_store_body
  4. inbox_getmessages_body
  5. inline_response_200
  6. inline_response_200_1
  7. inline_response_200_10
  8. inline_response_200_11
  9. inline_response_200_12
  10. inline_response_200_13
  11. inline_response_200_14
  12. inline_response_200_15
  13. inline_response_200_16
  14. inline_response_200_17
  15. inline_response_200_18
  16. inline_response_200_19
  17. inline_response_200_2
  18. inline_response_200_20
  19. inline_response_200_21
  20. inline_response_200_22
  21. inline_response_200_23
  22. inline_response_200_24
  23. inline_response_200_25
  24. inline_response_200_26
  25. inline_response_200_27
  26. inline_response_200_28
  27. inline_response_200_29
  28. inline_response_200_3
  29. inline_response_200_30
  30. inline_response_200_31
  31. inline_response_200_32
  32. inline_response_200_33
  33. inline_response_200_34
  34. inline_response_200_35
  35. inline_response_200_36
  36. inline_response_200_37
  37. inline_response_200_38
  38. inline_response_200_39
  39. inline_response_200_4
  40. inline_response_200_40
  41. inline_response_200_41
  42. inline_response_200_42
  43. inline_response_200_5
  44. inline_response_200_6
  45. inline_response_200_7
  46. inline_response_200_8
  47. inline_response_200_9
  48. inline_response_400
  49. levels_autoclaim_body
  50. pioneerinventoryv1mutate_mutations
  51. pioneerstorereconcile_purchaseOrigin
  52. presence_get_body
  53. presence_setrichpresence_body
  54. profile_bythirdpartyuserid_body
  55. projects_list_body
  56. rank_list_body
  57. shared_localizations_body
  58. shared_manifest_body
  59. shared_notifications_body
  60. shared_scenarios_body
  61. shared_setpersistentplayerkeys_body
  62. sharedanticheatrestrictions_hardware
  63. sharedsetpersistentplayerkeys_persistentPlayerKeys
  64. sharedsocialpresencesetrichpresence_attributes
  65. stats_playerv2_body
  66. store_reconcile_body
  67. v1_mutate_body
  68. v2_updatepartymemberdata_body

anticheat_restrictions_body Up

hardware (optional)

distributionplatformachievements_get_body Up

platform (optional)

gamedata_store_body Up

platform (optional)

inbox_getmessages_body Up

sessionID (optional)
includeSeenMessages (optional)

inline_response_200 Up

changeset (optional)

inline_response_200_1 Up

nextFromNotificationId (optional)
notifications (optional)

inline_response_200_10 Up

states (optional)

inline_response_200_11 Up

battlePassStates (optional)

inline_response_200_12 Up

failover_cooldown_duration_secs (optional)
initial_cooldown_duration_secs (optional)
packet_jitter_threshold_duration_secs (optional)
packet_loss_threshold_duration_secs (optional)
packet_loss_threshold_percent (optional)
proxy_failover (optional)

inline_response_200_13 Up

products (optional)
store-views (optional)

inline_response_200_14 Up

endpoints (optional)

inline_response_200_15 Up

entries (optional)

inline_response_200_16 Up

entries (optional)

inline_response_200_17 Up

costAmount (optional)
costGameAssetId (optional)
rerollsRemainingToday (optional)

inline_response_200_18 Up

matchmakingScenarios (optional)

inline_response_200_19 Up

timedOfferTransactions (optional)

inline_response_200_2 Up

isRestricted (optional)

inline_response_200_20 Up

quests (optional)

inline_response_200_21 Up

expiresIn (optional)
raw (optional)

inline_response_200_22 Up

changeset (optional)
levels (optional)

inline_response_200_23 Up

status (optional)

inline_response_200_24 Up

scopedPlayerStats (optional)

inline_response_200_25 Up

projects (optional)

inline_response_200_26 Up

raiders (optional)

inline_response_200_27 Up

objectives (optional)

inline_response_200_28 Up

announcements (optional)

inline_response_200_29 Up

achievements (optional)

inline_response_200_3 Up

events (optional)

inline_response_200_30 Up

compensations (optional)

inline_response_200_31 Up

effects (optional)
items (optional)

inline_response_200_32 Up

messages (optional)

inline_response_200_33 Up

levels (optional)

inline_response_200_34 Up

entries (optional)

inline_response_200_35 Up

changeset (optional)

inline_response_200_36 Up

currentState (optional)
etag (optional)
lobby_id (optional)
match_id (optional)
scenarioMetadata (optional)
state (optional)
ticket_id (optional)
tournament_id (optional)

inline_response_200_37 Up

recentlyPlayedWith (optional)

inline_response_200_38 Up

friends (optional)

inline_response_200_39 Up

max_party_size (optional)
party (optional)

inline_response_200_4 Up

members (optional)
rankId (optional)
rankWindowId (optional)

inline_response_200_40 Up

changeset (optional)
productIds (optional)

inline_response_200_41 Up

usersRichPresence (optional)

inline_response_200_42 Up

profiles (optional)

inline_response_200_5 Up

items (optional)

inline_response_200_6 Up

persistentPlayerKeys (optional)

inline_response_200_7 Up

rankWindowId (optional)
userRanks (optional)

inline_response_200_8 Up

buildId (optional)
id (optional)
nonPartitioningBody (optional)
nonPartitioningHash (optional)
partitioningBody (optional)
partitioningHash (optional)
retrievedAt (optional)
validFrom (optional)
validUntil (optional)

inline_response_200_9 Up

maxNumBlockedUsers (optional)
playerIds (optional)
profiles (optional)

inline_response_400 Up

message (optional)
reason (optional)

levels_autoclaim_body Up

groupIds (optional)

pioneerinventoryv1mutate_mutations Up

discriminator (optional)
instanceId (optional)
amount (optional)
slots (optional)
etag (optional)

pioneerstorereconcile_purchaseOrigin Up

productId (optional)
country (optional)
currencyCode (optional)
localizedPrice (optional)

presence_get_body Up

tenancyUserIds (optional)

presence_setrichpresence_body Up

richPresence (optional)
platform (optional)
additionalRecipients (optional)
attributes (optional)
hideEmbarkPresence (optional)

profile_bythirdpartyuserid_body Up

provider (optional)
ids (optional)

projects_list_body Up

states (optional)

rank_list_body Up

tenancyUserExternalIds (optional)

shared_localizations_body Up

locale (optional)

shared_manifest_body Up

build_id (optional)
playtest_id (optional)
artifact_id (optional)
store_deployment_target (optional)
manifest_id (optional)
app_id (optional)

shared_notifications_body Up

fromNotificationId (optional)

shared_scenarios_body Up

region (optional)

shared_setpersistentplayerkeys_body Up

persistentPlayerKeys (optional)

sharedanticheatrestrictions_hardware Up

hardwareType (optional)
hardwareId (optional)

sharedsetpersistentplayerkeys_persistentPlayerKeys Up

key (optional)
value (optional)
etag (optional)

sharedsocialpresencesetrichpresence_attributes Up

PartyID (optional)
PartySize (optional)
CurrentScreen (optional)
StartedPlayingAt (optional)
PartyIsOpen (optional)
PartyIsJoinable (optional)
Platform (optional)

stats_playerv2_body Up

scopes (optional)

store_reconcile_body Up

platform (optional)
platformData (optional)
purchaseOrigin (optional)

v1_mutate_body Up

mutations (optional)
requestId (optional)

v2_updatepartymemberdata_body Up

party_id (optional)
updated_member_tenancy_user_id (optional)
platform_session_id (optional)
crossplay_enabled (optional)