Skip to content

Commit

Permalink
Add Locker Service to EOS-Services. (#366)
Browse files Browse the repository at this point in the history
## PR Checklist

- [x] I have properly named the PR
- [x] I have described why this change should be merged (why is this
change useful/good)
- [x] I have followed the [Contribution Guide /
Formatting](https://github.com/LeleDerGrasshalmi/FortniteEndpointsDocumentation/blob/main/CONTRIBUTING.md)

## Change Description

Added the new Locker EOS Service starting with `/items`.
  • Loading branch information
LeleDerGrasshalmi authored Dec 25, 2024
2 parents 66eabc5 + b2256ab commit 886a9b9
Show file tree
Hide file tree
Showing 3 changed files with 294 additions and 0 deletions.
180 changes: 180 additions & 0 deletions EpicGames/FN-Service/EOS-Services/Locker/ActiveLoadoutGroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
# FN EOS Locker Service: Locker Active Loadout Group

URL: https://fngw-svc-gc-livefn.ol.epicgames.com/api/locker/v4/:deploymentId/account/:accountId/active-loadout-group \
Method: PUT \
Auth Required: Yes (`locker:{accountId} UPDATE`)

```json
{
"loadouts": {
"CosmeticLoadout:LoadoutSchema_Character": {
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Character",
"equippedItemId": "AthenaCharacter:character_rosedepth_seed",
"itemCustomizations": [{
"channelTag": "Progressive",
"variantTag": "Stage2",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Backpack",
"equippedItemId": "AthenaBackpack:backpack_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Pickaxe",
"equippedItemId": "AthenaPickaxe:pickaxe_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Glider",
"equippedItemId": "AthenaGlider:glider_id_379_gloomfemale",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Contrails",
"equippedItemId": "AthenaSkyDiveContrail:contrail_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Shoes",
"equippedItemId": "CosmeticShoes:shoes_breathtalepeony",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Aura",
"equippedItemId": "SparksAura:sparksaura_default",
"itemCustomizations": []
}
],
"shuffleType": "DISABLED"
},
"CosmeticLoadout:LoadoutSchema_Vehicle_SUV": {
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Body_SUV",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Skin_SUV",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Wheel_SUV",
"equippedItemId": "VehicleCosmetics_Wheel:wheel_rl152sport",
"itemCustomizations": [{
"channelTag": "Vehicle.Painted",
"variantTag": "Vehicle.Painted.Cobalt",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_DriftSmoke_SUV",
"equippedItemId": "VehicleCosmetics_DriftTrail:id_drifttrail_standard",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Booster_SUV",
"equippedItemId": "VehicleCosmetics_Booster:id_booster_standard",
"itemCustomizations": []
}
],
"shuffleType": "DISABLED"
}
}
}
```

## Path Parameters
`deploymentId`: The Deployment Id from env configuration, for `live-fn` it is `62a9473a2dca46b29ccf17577fcf42d7` <br/>
`accountId`: Your Account Id

---

_Example Response_
```json
{
"deploymentId": "62a9473a2dca46b29ccf17577fcf42d7",
"accountId": "b1c60df4f45a4b51b763eac539326664",
"athenaItemId": "d4a6db65-c223-4358-a67e-f0c519094b6b",
"creationTime": "2024-11-02T15:30:13.693713773Z",
"updatedTime": "2024-12-17T19:46:25.946968957Z",
"loadouts": {
"CosmeticLoadout:LoadoutSchema_Vehicle_SUV": {
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Body_SUV",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Skin_SUV",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Wheel_SUV",
"equippedItemId": "VehicleCosmetics_Wheel:wheel_rl152sport",
"itemCustomizations": [{
"channelTag": "Vehicle.Painted",
"variantTag": "Vehicle.Painted.Cobalt",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_DriftSmoke_SUV",
"equippedItemId": "VehicleCosmetics_DriftTrail:id_drifttrail_standard",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Vehicle_Booster_SUV",
"equippedItemId": "VehicleCosmetics_Booster:id_booster_standard",
"itemCustomizations": []
}
],
"shuffleType": "DISABLED"
},
"CosmeticLoadout:LoadoutSchema_Character": {
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Character",
"equippedItemId": "AthenaCharacter:character_rosedepth_seed",
"itemCustomizations": [{
"channelTag": "Progressive",
"variantTag": "Stage2",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Backpack",
"equippedItemId": "AthenaBackpack:backpack_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Pickaxe",
"equippedItemId": "AthenaPickaxe:pickaxe_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Glider",
"equippedItemId": "AthenaGlider:glider_id_379_gloomfemale",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Contrails",
"equippedItemId": "AthenaSkyDiveContrail:contrail_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Shoes",
"equippedItemId": "CosmeticShoes:shoes_breathtalepeony",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Aura",
"equippedItemId": "SparksAura:sparksaura_default",
"itemCustomizations": []
}
],
"shuffleType": "DISABLED"
}
},
"shuffleType": "DISABLED"
}
```
111 changes: 111 additions & 0 deletions EpicGames/FN-Service/EOS-Services/Locker/PlayerLocker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# FN EOS Locker Service: Locker Items

URL: https://fngw-svc-gc-livefn.ol.epicgames.com/api/locker/v4/:deploymentId/account/:accountId/items \
Method: GET \
Auth Required: Yes (`locker:items`)

## Path Parameters

`deploymentId`: The Deployment Id from env configuration, for `live-fn` it is `62a9473a2dca46b29ccf17577fcf42d7` <br/>
`accountId`: Your Account Id

---

_Example Response (shortened)_
```json
{
"activeLoadoutGroup": {
"deploymentId": "62a9473a2dca46b29ccf17577fcf42d7",
"accountId": "b1c60df4f45a4b51b763eac539326664",
"athenaItemId": "d4a6db65-c223-4358-a67e-f0c519094b6b",
"creationTime": "2024-11-02T15:30:13.693713773Z",
"updatedTime": "2024-12-15T20:19:12.879908946Z",
"loadouts": {
"CosmeticLoadout:LoadoutSchema_Emotes": {
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Emote_3",
"equippedItemId": "AthenaDance:eid_enrapture",
"itemCustomizations": [{
"channelTag": "TagDriven",
"variantTag": "Stage1",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Emote_4",
"equippedItemId": "AthenaDance:eid_guitar_shakecrunch",
"itemCustomizations": [{
"channelTag": "ProfileLoadout",
"variantTag": "ProfileLoadout",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Emote_5",
"equippedItemId": "AthenaDance:eid_laugh",
"itemCustomizations": []
}
],
"shuffleType": "DISABLED"
},
"CosmeticLoadout:LoadoutSchema_Character": {
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Character",
"equippedItemId": "AthenaCharacter:character_rosedepth_seed",
"itemCustomizations": [{
"channelTag": "Progressive",
"variantTag": "Stage2",
"additionalData": ""
}]
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Backpack",
"equippedItemId": "AthenaBackpack:backpack_blazerveil",
"itemCustomizations": []
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Pickaxe",
"equippedItemId": "AthenaPickaxe:pickaxe_blazerveil",
"itemCustomizations": []
}
],
"shuffleType": "DISABLED"
}
},
"shuffleType": "DISABLED"
},
"loadoutGroupPresets": [],
"loadoutPresets": [{
"deploymentId": "62a9473a2dca46b29ccf17577fcf42d7",
"accountId": "b1c60df4f45a4b51b763eac539326664",
"loadoutType": "CosmeticLoadout:LoadoutSchema_Character",
"presetId": "0001",
"presetIndex": 1,
"athenaItemId": "b4224ae3-69b6-4bc0-9f75-3ecbfb0568d0",
"creationTime": "2024-08-24T12:12:06.974010475Z",
"updatedTime": "2024-08-24T12:12:06.974010475Z",
"loadoutSlots": [{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Character",
"equippedItemId": "AthenaCharacter:cid_313_athena_commando_m_kpopfashion"
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Backpack",
"equippedItemId": "AthenaBackpack:bid_430_galileospeedboat_9rxe3"
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Pickaxe",
"equippedItemId": "AthenaPickaxe:pickaxe_id_315_banefemale1h"
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Glider",
"equippedItemId": "AthenaGlider:glider_id_146_masako"
},
{
"slotTemplate": "CosmeticLoadoutSlotTemplate:LoadoutSlot_Contrails",
"equippedItemId": "AthenaSkyDiveContrail:trails_id_037_glyphs"
}
],
"displayName": "Ikonik"
}]
}
```
3 changes: 3 additions & 0 deletions EpicGames/FN-Service/EOS-Services/Locker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FN EOS Locker Service

This service requires [fortnite eos connect authentication](../README.md)

0 comments on commit 886a9b9

Please sign in to comment.