155 lines
3.7 KiB
Markdown
155 lines
3.7 KiB
Markdown
# PrintsApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
| Method | HTTP request | Description |
|
|
|------------- | ------------- | -------------|
|
|
| [**deletePrint**](PrintsApi.md#deletePrint) | **DELETE** /prints/{printId} | Delete Print |
|
|
| [**editPrint**](PrintsApi.md#editPrint) | **POST** /prints/{printId} | Edit Print |
|
|
| [**getPrint**](PrintsApi.md#getPrint) | **GET** /prints/{printId} | Get Print |
|
|
| [**getUserPrints**](PrintsApi.md#getUserPrints) | **GET** /prints/user/{userId} | Get Own Prints |
|
|
| [**uploadPrint**](PrintsApi.md#uploadPrint) | **POST** /prints | Upload Print |
|
|
|
|
|
|
<a name="deletePrint"></a>
|
|
# **deletePrint**
|
|
> deletePrint(printId)
|
|
|
|
Delete Print
|
|
|
|
Returns a print.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **printId** | **String**| Print ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="editPrint"></a>
|
|
# **editPrint**
|
|
> Print editPrint(printId, image, note)
|
|
|
|
Edit Print
|
|
|
|
Edits a print.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **printId** | **String**| Print ID. | [default to null] |
|
|
| **image** | **File**| The binary blob of the png file. | [default to null] |
|
|
| **note** | **String**| The caption for the image. | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Print**](../Models/Print.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: multipart/form-data
|
|
- **Accept**: application/json
|
|
|
|
<a name="getPrint"></a>
|
|
# **getPrint**
|
|
> Print getPrint(printId)
|
|
|
|
Get Print
|
|
|
|
Returns a print.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **printId** | **String**| Print ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Print**](../Models/Print.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getUserPrints"></a>
|
|
# **getUserPrints**
|
|
> List getUserPrints(userId)
|
|
|
|
Get Own Prints
|
|
|
|
Returns a list of all prints of the user. User id has to be your own userId, as you can't request other user's prints.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**List**](../Models/Print.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="uploadPrint"></a>
|
|
# **uploadPrint**
|
|
> Print uploadPrint(image, timestamp, note, worldId, worldName)
|
|
|
|
Upload Print
|
|
|
|
Uploads and creates a print.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **image** | **File**| The binary blob of the png file. | [default to null] |
|
|
| **timestamp** | **Date**| The time the image was captured. | [default to null] |
|
|
| **note** | **String**| The caption for the image. | [optional] [default to null] |
|
|
| **worldId** | **String**| The id of the world in which the image was captured. | [optional] [default to null] |
|
|
| **worldName** | **String**| The name of the world in which the image was captured. | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Print**](../Models/Print.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: multipart/form-data
|
|
- **Accept**: application/json
|
|
|