Skip to content

Commit 60288df

Browse files
authored
Update api.md
1 parent 26af989 commit 60288df

File tree

1 file changed

+21
-107
lines changed
  • content/en-us/projects/assets

1 file changed

+21
-107
lines changed

content/en-us/projects/assets/api.md

Lines changed: 21 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,17 @@ You can query items from the Creator Store catalog using the following URL:
1818

1919
You can replace `[categoryId]` and `[params]` with the appropriate [query parameters](#query-parameters) to customize your search.
2020

21-
### CategoryId
22-
23-
Valid categoryIds are:
24-
25-
Audio = 3
26-
Model = 10
27-
Decal = 13
28-
Animation = 24
29-
Plugin = 38
30-
MeshPart = 40
31-
Video = 62
32-
FontFamily = 73
33-
Music = 300
21+
Valid category IDs are:
22+
23+
- Audio = `3`
24+
- Model = `10`
25+
- Decal = `13`
26+
- Animation = `24`
27+
- Plugin = `38`
28+
- MeshPart = `40`
29+
- Video = `62`
30+
- FontFamily = `73`
31+
- Music = `300`
3432

3533
### Query Parameters
3634

@@ -50,29 +48,12 @@ Use the following parameters to query the Creator Store:
5048
<tr>
5149
<td>categoryId (path)</td>
5250
<td>int</td>
53-
<td>
54-
Audio = 3 </br>
55-
Model = 10 </br>
56-
Decal = 13 </br>
57-
Animation = 24 </br>
58-
Plugin = 38 </br>
59-
MeshPart = 40 </br>
60-
Video = 62 </br>
61-
FontFamily = 73 </br>
62-
Music = 300 </br>
63-
SoundEffect = 301 </br>
64-
UnknownAudio = 302 </br>
65-
Package = 1001 </br>
66-
SharedPackage = 1002
67-
</td>
51+
<td>`3` = Audio<br />`10` = Model<br />`13` = Decal<br />`24` = Animation<br />`38` = Plugin<br />`40` = MeshPart<br />`62` = Video<br />`73` = FontFamily<br />`300` = Music<br />`301` = SoundEffect<br />`302` = UnknownAudio<br />`1001` = Package<br />`1002` = SharedPackage</td>
6852
</tr>
6953
<tr>
7054
<td>sortOrder</td>
7155
<td>int</td>
72-
<td>
73-
Asc = 1</br>
74-
Desc = 2
75-
</td>
56+
<td>`1` = Asc<br />`2` = Desc</td>
7657
</tr>
7758
<tr>
7859
<td>limit</td>
@@ -107,10 +88,7 @@ Use the following parameters to query the Creator Store:
10788
<tr>
10889
<td>creatorType</td>
10990
<td>int</td>
110-
<td>
111-
1 = User</br>
112-
2 = Group
113-
</td>
91+
<td>`1` = User<br />`2` = Group</td>
11492
</tr>
11593
<tr>
11694
<td>creatorTargetId</td>
@@ -130,11 +108,7 @@ Use the following parameters to query the Creator Store:
130108
<tr>
131109
<td>sortDirection</td>
132110
<td>int</td>
133-
<td>
134-
None = 0</br>
135-
Ascending = 1</br>
136-
Descending = 2
137-
</td>
111+
<td>`0` = None<br />`1` = Ascending<br />`2` = Descending</td>
138112
</tr>
139113
<tr>
140114
<td>artist</td>
@@ -149,23 +123,12 @@ Use the following parameters to query the Creator Store:
149123
<tr>
150124
<td>audioTypes</td>
151125
<td>array[int]</td>
152-
<td>Music = 0</br>SoundEffect = 1</td>
126+
<td>`0` = Music<br />`1` = SoundEffect</td>
153127
</tr>
154128
<tr>
155129
<td>uiSortIntent</td>
156130
<td>int</td>
157-
<td>
158-
Relevance = 1</br>
159-
Trending = 6</br>
160-
AllTime = 7</br>
161-
Top = 8</br>
162-
Duration = 9</br>
163-
DateCreated = 10</br>
164-
DateModified = 11</br>
165-
Creator = 12</br>
166-
Name = 13</br>
167-
What sort order to rank the results by
168-
</td>
131+
<td>What sort order to rank the results by<br /><br />`1` = Relevance<br />`6` = Trending<br />`7` = AllTime<br />`8` = Top<br />`9` = Duration<br />`10` = DateCreated<br />`11` = DateModified<br />`12` = Creator<br />`13` = Name</td>
169132
</tr>
170133
<tr>
171134
<td>includeOnlyVerifiedCreators</td>
@@ -348,7 +311,7 @@ Use the following parameters to query the Marketplace:
348311
<tr>
349312
<td>CreatorType</td>
350313
<td>byte</td>
351-
<td>`1` = User or `2` = Group.</td>
314+
<td>`1` = User<br />`2` = Group</td>
352315
</tr>
353316
<tr>
354317
<td>CreatorName</td>
@@ -368,7 +331,7 @@ Use the following parameters to query the Marketplace:
368331
<tr>
369332
<td>Genres</td>
370333
<td>byte</td>
371-
<td>Specifies the genre for the search. The recommended approach to filtering on genres is to match the URL of a catalog page. <br />`1` = TownAndCity<br />`2` = Medieval<br />`3` = SciFi<br />`4` = Fighting<br />`5` = Horror<br />`6` = Naval<br />`7` = Adventure<br />`8` = Sports<br />`9` = Comedy<br />`10` = Western<br />`11` = Military<br />`13` = Building<br />`14` = FPS<br />`15` = RPG</td>
334+
<td>Specifies the genre for the search. The recommended approach to filtering on genres is to match the URL of a catalog page.<br /><br />`1` = TownAndCity<br />`2` = Medieval<br />`3` = SciFi<br />`4` = Fighting<br />`5` = Horror<br />`6` = Naval<br />`7` = Adventure<br />`8` = Sports<br />`9` = Comedy<br />`10` = Western<br />`11` = Military<br />`13` = Building<br />`14` = FPS<br />`15` = RPG</td>
372335
</tr>
373336
<tr>
374337
<td>Keyword</td>
@@ -403,56 +366,7 @@ Use the following parameters to query the Marketplace:
403366
<tr>
404367
<td>Subcategory</td>
405368
<td>byte</td>
406-
<td>
407-
`0` = Featured<br />
408-
`1` = All<br />
409-
`2` = Collectibles<br />
410-
`3` = Clothing<br />
411-
`4` = BodyParts<br />
412-
`5` = Gear<br />
413-
`9` = Hats<br />
414-
`10` = Faces<br />
415-
`12` = Shirts<br />
416-
`13` = TShirts<br />
417-
`14` = Pants<br />
418-
`15` = Heads<br />
419-
`19` = Accessories<br />
420-
`20` = HairAccessories<br />
421-
`21` = FaceAccessories<br />
422-
`22` = NeckAccessories<br />
423-
`23` = ShoulderAccessories<br />
424-
`24` = FrontAccessories<br />
425-
`25` = BackAccessories<br />
426-
`26` = WaistAccessories<br />
427-
`27` = AvatarAnimations<br />
428-
`37` = Bundles<br />
429-
`38` = AnimationBundles <br />
430-
`39` = EmoteAnimations<br />
431-
`40` = CommunityCreations<br />
432-
`41` = Melee<br />
433-
`42` = Ranged<br />
434-
`43` = Explosive<br />
435-
`44` = PowerUp<br />
436-
`45` = Navigation<br />
437-
`46` = Musical<br />
438-
`47` = Social<br />
439-
`48` = Building<br />
440-
`49` = Transport<br />
441-
`54` = HeadAccessories<br />
442-
`55` = ClassicTShirts<br />
443-
`56` = ClassicShirts<br />
444-
`57` = ClassicPants<br />
445-
`58` = TShirtAccessories<br />
446-
`59` = ShirtAccessories<br />
447-
`60` = PantsAccessories<br />
448-
`61` = JacketAccessories<br />
449-
`62` = SweaterAccessories<br />
450-
`63` = ShortsAccessories<br />
451-
`64` = ShoesBundles<br />
452-
`65` = DressSkirtAccessories<br />
453-
`66` = DynamicHeads<br />
454-
</td>
455-
369+
<td>`0` = Featured<br />`1` = All<br />`2` = Collectibles<br />`3` = Clothing<br />`4` = BodyParts<br />`5` = Gear<br />`9` = Hats<br />`10` = Faces<br />`12` = Shirts<br />`13` = TShirts<br />`14` = Pants<br />`15` = Heads<br />`19` = Accessories<br />`20` = HairAccessories<br />`21` = FaceAccessories<br />`22` = NeckAccessories<br />`23` = ShoulderAccessories<br />`24` = FrontAccessories<br />`25` = BackAccessories<br />`26` = WaistAccessories<br />`27` = AvatarAnimations<br />`37` = Bundles<br />`38` = AnimationBundles <br />`39` = EmoteAnimations<br />`40` = CommunityCreations<br />`41` = Melee<br />`42` = Ranged<br />`43` = Explosive<br />`44` = PowerUp<br />`45` = Navigation<br />`46` = Musical<br />`47` = Social<br />`48` = Building<br />`49` = Transport<br />`54` = HeadAccessories<br />`55` = ClassicTShirts<br />`56` = ClassicShirts<br />`57` = ClassicPants<br />`58` = TShirtAccessories<br />`59` = ShirtAccessories<br />`60` = PantsAccessories<br />`61` = JacketAccessories<br />`62` = SweaterAccessories<br />`63` = ShortsAccessories<br />`64` = ShoesBundles<br />`65` = DressSkirtAccessories<br />`66` = DynamicHeads</td>
456370
</tr>
457371
</tbody>
458372
</table>
@@ -475,7 +389,7 @@ API responses return in a JSON format. The response provides asset details in th
475389
<tbody>
476390
<tr>
477391
<td>assetType</td>
478-
<td>One of the following asset type values (only returned if the item is an asset).<br />`2` = T-Shirt<br />`8` = Hat<br />`11` = Shirt<br />`12` = Pants<br />`17` = Head<br />`18` = Face<br />`19` = Gear<br />`25` = Arms<br />`26` = Legs<br />`27` = Torso<br />`28` = RightArm<br />`29` = LeftArm<br />`30` = LeftLeg<br />`31` = RightLeg<br />`41` = HairAccessory<br />`42` = FaceAccessory<br />`43` = NeckAccessory<br />`44` = ShoulderAccessory<br />`45` = FrontAccessory<br />`46` = BackAccessory<br />`47` = WaistAccessory<br />`48` = ClimbAnimation<br />`49` = DeathAnimation<br />`50` = FallAnimation<br />`51` = IdleAnimation<br />`52` = JumpAnimation<br />`53` = RunAnimation<br />`54` = SwimAnimation<br />`55` = WalkAnimation<br />`56` = PoseAnimation<br />`61` = EmoteAnimation</td>
392+
<td>One of the following asset type values (only returned if the item is an asset).<br /><br />`2` = T-Shirt<br />`8` = Hat<br />`11` = Shirt<br />`12` = Pants<br />`17` = Head<br />`18` = Face<br />`19` = Gear<br />`25` = Arms<br />`26` = Legs<br />`27` = Torso<br />`28` = RightArm<br />`29` = LeftArm<br />`30` = LeftLeg<br />`31` = RightLeg<br />`41` = HairAccessory<br />`42` = FaceAccessory<br />`43` = NeckAccessory<br />`44` = ShoulderAccessory<br />`45` = FrontAccessory<br />`46` = BackAccessory<br />`47` = WaistAccessory<br />`48` = ClimbAnimation<br />`49` = DeathAnimation<br />`50` = FallAnimation<br />`51` = IdleAnimation<br />`52` = JumpAnimation<br />`53` = RunAnimation<br />`54` = SwimAnimation<br />`55` = WalkAnimation<br />`56` = PoseAnimation<br />`61` = EmoteAnimation</td>
479393
</tr>
480394
<tr>
481395
<td>bundleType</td>

0 commit comments

Comments
 (0)