No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This C# SDK is automatically generated by the OpenAPI Generator project:
- API version: v1
- SDK version: 1.0.0
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
- .NET Core >=1.0
- .NET Framework >=4.6
- Mono/Xamarin >=vNext
- RestSharp - 106.13.0 or later
- Json.NET - 13.0.2 or later
- JsonSubTypes - 1.8.0 or later
- System.ComponentModel.Annotations - 5.0.0 or later
The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.
Generate the DLL using your preferred tool (e.g. dotnet build
)
Then include the DLL (under the bin
folder) in the C# project, and use the namespaces:
using Knedlex.Roblox.Avatar.ApiV1.Api;
using Knedlex.Roblox.Avatar.ApiV1.Client;
using Knedlex.Roblox.Avatar.ApiV1.Model;
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
using System.Collections.Generic;
using System.Diagnostics;
using Knedlex.Roblox.Avatar.ApiV1.Api;
using Knedlex.Roblox.Avatar.ApiV1.Client;
using Knedlex.Roblox.Avatar.ApiV1.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://avatar.roblox.com";
var apiInstance = new AvatarApi(config);
var assetId = 789L; // long | The asset id.
try
{
// Removes the asset from the authenticated user's avatar.
RobloxApiAvatarModelsAvatarApiSuccessResponse result = apiInstance.V1AvatarAssetsAssetIdRemovePost(assetId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling AvatarApi.V1AvatarAssetsAssetIdRemovePost: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
All URIs are relative to https://avatar.roblox.com
Class | Method | HTTP request | Description |
---|---|---|---|
AvatarApi | V1AvatarAssetsAssetIdRemovePost | POST /v1/avatar/assets/{assetId}/remove | Removes the asset from the authenticated user's avatar. |
AvatarApi | V1AvatarAssetsAssetIdWearPost | POST /v1/avatar/assets/{assetId}/wear | Puts the asset on the authenticated user's avatar. - Flagged as obsolete, does not support layered clothing meta params |
AvatarApi | V1AvatarGet | GET /v1/avatar | Returns details about the authenticated user's avatar |
AvatarApi | V1AvatarMetadataGet | GET /v1/avatar/metadata | Returns metadata used by the avatar page of the website |
AvatarApi | V1AvatarRedrawThumbnailPost | POST /v1/avatar/redraw-thumbnail | Requests the authenticated user's thumbnail be redrawn |
AvatarApi | V1AvatarRulesGet | GET /v1/avatar-rules | Returns the business rules related to avatars |
AvatarApi | V1AvatarSetBodyColorsPost | POST /v1/avatar/set-body-colors | Sets the authenticated user's body colors |
AvatarApi | V1AvatarSetPlayerAvatarTypePost | POST /v1/avatar/set-player-avatar-type | Sets the authenticated user's player avatar type (e.g. R6 or R15). |
AvatarApi | V1AvatarSetScalesPost | POST /v1/avatar/set-scales | Sets the authenticated user's scales |
AvatarApi | V1AvatarSetWearingAssetsPost | POST /v1/avatar/set-wearing-assets | Sets the avatar's current assets to the list - Flagged as obsolete, does not support layered clothing meta params |
AvatarApi | V1GameStartInfoGet | GET /v1/game-start-info | The server will call this on game server start to request general information about the universe This is version 1.1, which returns an entry from the UniverseAvatarType enum. During mixed mode this may return unreliable results. |
AvatarApi | V1UsersUserIdAvatarGet | GET /v1/users/{userId}/avatar | Returns details about a specified user's avatar |
AvatarApi | V1UsersUserIdCurrentlyWearingGet | GET /v1/users/{userId}/currently-wearing | Gets a list of asset ids that the user is currently wearing |
AvatarApi | V1UsersUserIdOutfitsGet | GET /v1/users/{userId}/outfits | Deprecated, user v2. Gets a list of outfits for the specified user. |
OutfitsApi | V1OutfitsCreatePost | POST /v1/outfits/create | Creates a new outfit. |
OutfitsApi | V1OutfitsUserOutfitIdDeletePost | POST /v1/outfits/{userOutfitId}/delete | Deletes the outfit |
OutfitsApi | V1OutfitsUserOutfitIdDetailsGet | GET /v1/outfits/{userOutfitId}/details | |
OutfitsApi | V1OutfitsUserOutfitIdPatch | PATCH /v1/outfits/{userOutfitId} | Updates the contents of an outfit. Deprecated. There are no calls to this API |
OutfitsApi | V1OutfitsUserOutfitIdUpdatePost | POST /v1/outfits/{userOutfitId}/update | Updates the contents of the outfit. Deprecated. There are no calls to this API |
OutfitsApi | V1OutfitsUserOutfitIdWearPost | POST /v1/outfits/{userOutfitId}/wear | Wears the outfit |
RecentItemApi | V1RecentItemsRecentItemListTypeListGet | GET /v1/recent-items/{recentItemListType}/list | Returns a list of recent items Recent items can be Assets or Outfits |
- Model.AvatarCommonModelsAccessoryPositionModel
- Model.AvatarCommonModelsAccessoryRefinementModel
- Model.AvatarCommonModelsAccessoryRotationModel
- Model.AvatarCommonModelsAccessoryScaleModel
- Model.RobloxApiAvatarModelsAssetIdListModel
- Model.RobloxApiAvatarModelsAssetMetaModelV1
- Model.RobloxApiAvatarModelsAssetModelV2
- Model.RobloxApiAvatarModelsAssetTypeModel
- Model.RobloxApiAvatarModelsAssetTypeRulesModel
- Model.RobloxApiAvatarModelsAvatarApiSuccessResponse
- Model.RobloxApiAvatarModelsAvatarFilteredPageResponseRobloxApiAvatarModelsOutfitModel
- Model.RobloxApiAvatarModelsAvatarMetadataModel
- Model.RobloxApiAvatarModelsAvatarModelV2
- Model.RobloxApiAvatarModelsAvatarRulesModel
- Model.RobloxApiAvatarModelsAvatarRulesModelAccessoryRefinementLowerBounds
- Model.RobloxApiAvatarModelsBodyColorModel
- Model.RobloxApiAvatarModelsBodyColorsModel
- Model.RobloxApiAvatarModelsDefaultClothingAssets
- Model.RobloxApiAvatarModelsEmoteResponseModel
- Model.RobloxApiAvatarModelsGameStartInfoResponse
- Model.RobloxApiAvatarModelsOutfitDetailsModel
- Model.RobloxApiAvatarModelsOutfitModel
- Model.RobloxApiAvatarModelsOutfitUpdateModelV1
- Model.RobloxApiAvatarModelsPlayerAvatarTypeModel
- Model.RobloxApiAvatarModelsRecentItemModel
- Model.RobloxApiAvatarModelsScaleRulesModel
- Model.RobloxApiAvatarModelsUniverseAvatarAssetOverrideResponseModel
- Model.RobloxApiAvatarModelsWearResponseModel
- Model.RobloxAvatarcoreSharedV3Beta1AssetPosition
- Model.RobloxAvatarcoreSharedV3Beta1AssetRotation
- Model.RobloxAvatarcoreSharedV3Beta1AssetScale
- Model.RobloxWebResponsesAvatarScaleModel
- Model.RobloxWebWebAPIModelsApiLegacyPageResponseRobloxApiAvatarModelsRecentItemModel
Endpoints do not require authorization.