From 60288df53fa727724f0a7e58909a4bf04c17baf5 Mon Sep 17 00:00:00 2001
From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com>
Date: Mon, 28 Oct 2024 14:31:32 -1000
Subject: [PATCH] Update api.md
---
content/en-us/projects/assets/api.md | 128 +++++----------------------
1 file changed, 21 insertions(+), 107 deletions(-)
diff --git a/content/en-us/projects/assets/api.md b/content/en-us/projects/assets/api.md
index d9936a2d9..92d517773 100644
--- a/content/en-us/projects/assets/api.md
+++ b/content/en-us/projects/assets/api.md
@@ -18,19 +18,17 @@ You can query items from the Creator Store catalog using the following URL:
You can replace `[categoryId]` and `[params]` with the appropriate [query parameters](#query-parameters) to customize your search.
-### CategoryId
-
-Valid categoryIds are:
-
-Audio = 3
-Model = 10
-Decal = 13
-Animation = 24
-Plugin = 38
-MeshPart = 40
-Video = 62
-FontFamily = 73
-Music = 300
+Valid category IDs are:
+
+- Audio = `3`
+- Model = `10`
+- Decal = `13`
+- Animation = `24`
+- Plugin = `38`
+- MeshPart = `40`
+- Video = `62`
+- FontFamily = `73`
+- Music = `300`
### Query Parameters
@@ -50,29 +48,12 @@ Use the following parameters to query the Creator Store:
| categoryId (path) |
int |
-
- Audio = 3
- Model = 10
- Decal = 13
- Animation = 24
- Plugin = 38
- MeshPart = 40
- Video = 62
- FontFamily = 73
- Music = 300
- SoundEffect = 301
- UnknownAudio = 302
- Package = 1001
- SharedPackage = 1002
- |
+ `3` = Audio
`10` = Model
`13` = Decal
`24` = Animation
`38` = Plugin
`40` = MeshPart
`62` = Video
`73` = FontFamily
`300` = Music
`301` = SoundEffect
`302` = UnknownAudio
`1001` = Package
`1002` = SharedPackage |
| sortOrder |
int |
-
- Asc = 1
- Desc = 2
- |
+ `1` = Asc
`2` = Desc |
| limit |
@@ -107,10 +88,7 @@ Use the following parameters to query the Creator Store:
| creatorType |
int |
-
- 1 = User
- 2 = Group
- |
+ `1` = User
`2` = Group |
| creatorTargetId |
@@ -130,11 +108,7 @@ Use the following parameters to query the Creator Store:
| sortDirection |
int |
-
- None = 0
- Ascending = 1
- Descending = 2
- |
+ `0` = None
`1` = Ascending
`2` = Descending |
| artist |
@@ -149,23 +123,12 @@ Use the following parameters to query the Creator Store:
| audioTypes |
array[int] |
- Music = 0SoundEffect = 1 |
+ `0` = Music
`1` = SoundEffect |
| uiSortIntent |
int |
-
- Relevance = 1
- Trending = 6
- AllTime = 7
- Top = 8
- Duration = 9
- DateCreated = 10
- DateModified = 11
- Creator = 12
- Name = 13
- What sort order to rank the results by
- |
+ What sort order to rank the results by
`1` = Relevance
`6` = Trending
`7` = AllTime
`8` = Top
`9` = Duration
`10` = DateCreated
`11` = DateModified
`12` = Creator
`13` = Name |
| includeOnlyVerifiedCreators |
@@ -348,7 +311,7 @@ Use the following parameters to query the Marketplace:
| CreatorType |
byte |
- `1` = User or `2` = Group. |
+ `1` = User
`2` = Group |
| CreatorName |
@@ -368,7 +331,7 @@ Use the following parameters to query the Marketplace:
| Genres |
byte |
- Specifies the genre for the search. The recommended approach to filtering on genres is to match the URL of a catalog page.
`1` = TownAndCity
`2` = Medieval
`3` = SciFi
`4` = Fighting
`5` = Horror
`6` = Naval
`7` = Adventure
`8` = Sports
`9` = Comedy
`10` = Western
`11` = Military
`13` = Building
`14` = FPS
`15` = RPG |
+ Specifies the genre for the search. The recommended approach to filtering on genres is to match the URL of a catalog page.
`1` = TownAndCity
`2` = Medieval
`3` = SciFi
`4` = Fighting
`5` = Horror
`6` = Naval
`7` = Adventure
`8` = Sports
`9` = Comedy
`10` = Western
`11` = Military
`13` = Building
`14` = FPS
`15` = RPG |
| Keyword |
@@ -403,56 +366,7 @@ Use the following parameters to query the Marketplace:
| Subcategory |
byte |
-
- `0` = Featured
- `1` = All
- `2` = Collectibles
- `3` = Clothing
- `4` = BodyParts
- `5` = Gear
- `9` = Hats
- `10` = Faces
- `12` = Shirts
- `13` = TShirts
- `14` = Pants
- `15` = Heads
- `19` = Accessories
- `20` = HairAccessories
- `21` = FaceAccessories
- `22` = NeckAccessories
- `23` = ShoulderAccessories
- `24` = FrontAccessories
- `25` = BackAccessories
- `26` = WaistAccessories
- `27` = AvatarAnimations
- `37` = Bundles
- `38` = AnimationBundles
- `39` = EmoteAnimations
- `40` = CommunityCreations
- `41` = Melee
- `42` = Ranged
- `43` = Explosive
- `44` = PowerUp
- `45` = Navigation
- `46` = Musical
- `47` = Social
- `48` = Building
- `49` = Transport
- `54` = HeadAccessories
- `55` = ClassicTShirts
- `56` = ClassicShirts
- `57` = ClassicPants
- `58` = TShirtAccessories
- `59` = ShirtAccessories
- `60` = PantsAccessories
- `61` = JacketAccessories
- `62` = SweaterAccessories
- `63` = ShortsAccessories
- `64` = ShoesBundles
- `65` = DressSkirtAccessories
- `66` = DynamicHeads
- |
-
+ `0` = Featured
`1` = All
`2` = Collectibles
`3` = Clothing
`4` = BodyParts
`5` = Gear
`9` = Hats
`10` = Faces
`12` = Shirts
`13` = TShirts
`14` = Pants
`15` = Heads
`19` = Accessories
`20` = HairAccessories
`21` = FaceAccessories
`22` = NeckAccessories
`23` = ShoulderAccessories
`24` = FrontAccessories
`25` = BackAccessories
`26` = WaistAccessories
`27` = AvatarAnimations
`37` = Bundles
`38` = AnimationBundles
`39` = EmoteAnimations
`40` = CommunityCreations
`41` = Melee
`42` = Ranged
`43` = Explosive
`44` = PowerUp
`45` = Navigation
`46` = Musical
`47` = Social
`48` = Building
`49` = Transport
`54` = HeadAccessories
`55` = ClassicTShirts
`56` = ClassicShirts
`57` = ClassicPants
`58` = TShirtAccessories
`59` = ShirtAccessories
`60` = PantsAccessories
`61` = JacketAccessories
`62` = SweaterAccessories
`63` = ShortsAccessories
`64` = ShoesBundles
`65` = DressSkirtAccessories
`66` = DynamicHeads |
@@ -475,7 +389,7 @@ API responses return in a JSON format. The response provides asset details in th
| assetType |
- One of the following asset type values (only returned if the item is an asset).
`2` = T-Shirt
`8` = Hat
`11` = Shirt
`12` = Pants
`17` = Head
`18` = Face
`19` = Gear
`25` = Arms
`26` = Legs
`27` = Torso
`28` = RightArm
`29` = LeftArm
`30` = LeftLeg
`31` = RightLeg
`41` = HairAccessory
`42` = FaceAccessory
`43` = NeckAccessory
`44` = ShoulderAccessory
`45` = FrontAccessory
`46` = BackAccessory
`47` = WaistAccessory
`48` = ClimbAnimation
`49` = DeathAnimation
`50` = FallAnimation
`51` = IdleAnimation
`52` = JumpAnimation
`53` = RunAnimation
`54` = SwimAnimation
`55` = WalkAnimation
`56` = PoseAnimation
`61` = EmoteAnimation |
+ One of the following asset type values (only returned if the item is an asset).
`2` = T-Shirt
`8` = Hat
`11` = Shirt
`12` = Pants
`17` = Head
`18` = Face
`19` = Gear
`25` = Arms
`26` = Legs
`27` = Torso
`28` = RightArm
`29` = LeftArm
`30` = LeftLeg
`31` = RightLeg
`41` = HairAccessory
`42` = FaceAccessory
`43` = NeckAccessory
`44` = ShoulderAccessory
`45` = FrontAccessory
`46` = BackAccessory
`47` = WaistAccessory
`48` = ClimbAnimation
`49` = DeathAnimation
`50` = FallAnimation
`51` = IdleAnimation
`52` = JumpAnimation
`53` = RunAnimation
`54` = SwimAnimation
`55` = WalkAnimation
`56` = PoseAnimation
`61` = EmoteAnimation |
| bundleType |