93 lines
2.2 KiB
Markdown
93 lines
2.2 KiB
Markdown
# JamsApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
| Method | HTTP request | Description |
|
|
|------------- | ------------- | -------------|
|
|
| [**getJam**](JamsApi.md#getJam) | **GET** /jams/{jamId} | Show jam information |
|
|
| [**getJamSubmissions**](JamsApi.md#getJamSubmissions) | **GET** /jams/{jamId}/submissions | Show jam submissions |
|
|
| [**getJams**](JamsApi.md#getJams) | **GET** /jams | Show jams list |
|
|
|
|
|
|
<a name="getJam"></a>
|
|
# **getJam**
|
|
> Jam getJam(jamId)
|
|
|
|
Show jam information
|
|
|
|
Returns a jam.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **jamId** | **String**| Must be a valid query ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Jam**](../Models/Jam.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getJamSubmissions"></a>
|
|
# **getJamSubmissions**
|
|
> List getJamSubmissions(jamId)
|
|
|
|
Show jam submissions
|
|
|
|
Returns all submissions of a jam.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **jamId** | **String**| Must be a valid query ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**List**](../Models/Submission.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getJams"></a>
|
|
# **getJams**
|
|
> List getJams(type)
|
|
|
|
Show jams list
|
|
|
|
Lists World Jams or Avatar Jams, both currently running and ones that have ended. `isActive` is used to select only active or already ended jams. `type` is used to select only world or avatar jams, and can only take `world` or `avatar`. ``
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **type** | **String**| Only show jams of this type (`avatar` or `world`). | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**List**](../Models/Jam.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|