|
| 1 | +# vrchatapi.JamsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://vrchat.com/api/1* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_jam**](JamsApi.md#get_jam) | **GET** /jams/{jamId} | Show jam information |
| 8 | +[**get_jam_submissions**](JamsApi.md#get_jam_submissions) | **GET** /jams/{jamId}/submissions | Show jam submissions |
| 9 | +[**get_jams**](JamsApi.md#get_jams) | **GET** /jams | Show jams list |
| 10 | + |
| 11 | + |
| 12 | +# **get_jam** |
| 13 | +> Jam get_jam(jam_id) |
| 14 | +
|
| 15 | +Show jam information |
| 16 | + |
| 17 | +Returns a jam. |
| 18 | + |
| 19 | +### Example |
| 20 | + |
| 21 | +* Api Key Authentication (authCookie): |
| 22 | +```python |
| 23 | +from __future__ import print_function |
| 24 | +import time |
| 25 | +import vrchatapi |
| 26 | +from vrchatapi.rest import ApiException |
| 27 | +from pprint import pprint |
| 28 | +# Defining the host is optional and defaults to https://vrchat.com/api/1 |
| 29 | +# See configuration.py for a list of all supported configuration parameters. |
| 30 | +configuration = vrchatapi.Configuration( |
| 31 | + host = "https://vrchat.com/api/1" |
| 32 | +) |
| 33 | + |
| 34 | +# The client must configure the authentication and authorization parameters |
| 35 | +# in accordance with the API server security policy. |
| 36 | +# Examples for each auth method are provided below, use the example that |
| 37 | +# satisfies your auth use case. |
| 38 | + |
| 39 | +# Configure API key authorization: authCookie |
| 40 | +configuration.api_key['authCookie'] = 'YOUR_API_KEY' |
| 41 | + |
| 42 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 43 | +# configuration.api_key_prefix['authCookie'] = 'Bearer' |
| 44 | + |
| 45 | +# Enter a context with an instance of the API client |
| 46 | +with vrchatapi.ApiClient(configuration) as api_client: |
| 47 | + # Create an instance of the API class |
| 48 | + api_instance = vrchatapi.JamsApi(api_client) |
| 49 | + jam_id = 'jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9' # str | Must be a valid query ID. |
| 50 | + |
| 51 | + try: |
| 52 | + # Show jam information |
| 53 | + api_response = api_instance.get_jam(jam_id) |
| 54 | + pprint(api_response) |
| 55 | + except ApiException as e: |
| 56 | + print("Exception when calling JamsApi->get_jam: %s\n" % e) |
| 57 | +``` |
| 58 | + |
| 59 | +### Parameters |
| 60 | + |
| 61 | +Name | Type | Description | Notes |
| 62 | +------------- | ------------- | ------------- | ------------- |
| 63 | + **jam_id** | **str**| Must be a valid query ID. | |
| 64 | + |
| 65 | +### Return type |
| 66 | + |
| 67 | +[**Jam**](Jam.md) |
| 68 | + |
| 69 | +### Authorization |
| 70 | + |
| 71 | +[authCookie](../README.md#authCookie) |
| 72 | + |
| 73 | +### HTTP request headers |
| 74 | + |
| 75 | + - **Content-Type**: Not defined |
| 76 | + - **Accept**: application/json |
| 77 | + |
| 78 | +### HTTP response details |
| 79 | +| Status code | Description | Response headers | |
| 80 | +|-------------|-------------|------------------| |
| 81 | +**200** | Returns a Jam object. | - | |
| 82 | +**404** | Error response when trying to show information about a non-existent jam. | - | |
| 83 | + |
| 84 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 85 | + |
| 86 | +# **get_jam_submissions** |
| 87 | +> list[Submission] get_jam_submissions(jam_id) |
| 88 | +
|
| 89 | +Show jam submissions |
| 90 | + |
| 91 | +Returns all submissions of a jam. |
| 92 | + |
| 93 | +### Example |
| 94 | + |
| 95 | +* Api Key Authentication (authCookie): |
| 96 | +```python |
| 97 | +from __future__ import print_function |
| 98 | +import time |
| 99 | +import vrchatapi |
| 100 | +from vrchatapi.rest import ApiException |
| 101 | +from pprint import pprint |
| 102 | +# Defining the host is optional and defaults to https://vrchat.com/api/1 |
| 103 | +# See configuration.py for a list of all supported configuration parameters. |
| 104 | +configuration = vrchatapi.Configuration( |
| 105 | + host = "https://vrchat.com/api/1" |
| 106 | +) |
| 107 | + |
| 108 | +# The client must configure the authentication and authorization parameters |
| 109 | +# in accordance with the API server security policy. |
| 110 | +# Examples for each auth method are provided below, use the example that |
| 111 | +# satisfies your auth use case. |
| 112 | + |
| 113 | +# Configure API key authorization: authCookie |
| 114 | +configuration.api_key['authCookie'] = 'YOUR_API_KEY' |
| 115 | + |
| 116 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 117 | +# configuration.api_key_prefix['authCookie'] = 'Bearer' |
| 118 | + |
| 119 | +# Enter a context with an instance of the API client |
| 120 | +with vrchatapi.ApiClient(configuration) as api_client: |
| 121 | + # Create an instance of the API class |
| 122 | + api_instance = vrchatapi.JamsApi(api_client) |
| 123 | + jam_id = 'jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9' # str | Must be a valid query ID. |
| 124 | + |
| 125 | + try: |
| 126 | + # Show jam submissions |
| 127 | + api_response = api_instance.get_jam_submissions(jam_id) |
| 128 | + pprint(api_response) |
| 129 | + except ApiException as e: |
| 130 | + print("Exception when calling JamsApi->get_jam_submissions: %s\n" % e) |
| 131 | +``` |
| 132 | + |
| 133 | +### Parameters |
| 134 | + |
| 135 | +Name | Type | Description | Notes |
| 136 | +------------- | ------------- | ------------- | ------------- |
| 137 | + **jam_id** | **str**| Must be a valid query ID. | |
| 138 | + |
| 139 | +### Return type |
| 140 | + |
| 141 | +[**list[Submission]**](Submission.md) |
| 142 | + |
| 143 | +### Authorization |
| 144 | + |
| 145 | +[authCookie](../README.md#authCookie) |
| 146 | + |
| 147 | +### HTTP request headers |
| 148 | + |
| 149 | + - **Content-Type**: Not defined |
| 150 | + - **Accept**: application/json |
| 151 | + |
| 152 | +### HTTP response details |
| 153 | +| Status code | Description | Response headers | |
| 154 | +|-------------|-------------|------------------| |
| 155 | +**200** | Returns a list of Submission objects. | - | |
| 156 | +**404** | Error response when trying to show information about a non-existent jam. | - | |
| 157 | + |
| 158 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 159 | + |
| 160 | +# **get_jams** |
| 161 | +> list[Jam] get_jams(type=type) |
| 162 | +
|
| 163 | +Show jams list |
| 164 | + |
| 165 | +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`. `` |
| 166 | + |
| 167 | +### Example |
| 168 | + |
| 169 | +* Api Key Authentication (authCookie): |
| 170 | +```python |
| 171 | +from __future__ import print_function |
| 172 | +import time |
| 173 | +import vrchatapi |
| 174 | +from vrchatapi.rest import ApiException |
| 175 | +from pprint import pprint |
| 176 | +# Defining the host is optional and defaults to https://vrchat.com/api/1 |
| 177 | +# See configuration.py for a list of all supported configuration parameters. |
| 178 | +configuration = vrchatapi.Configuration( |
| 179 | + host = "https://vrchat.com/api/1" |
| 180 | +) |
| 181 | + |
| 182 | +# The client must configure the authentication and authorization parameters |
| 183 | +# in accordance with the API server security policy. |
| 184 | +# Examples for each auth method are provided below, use the example that |
| 185 | +# satisfies your auth use case. |
| 186 | + |
| 187 | +# Configure API key authorization: authCookie |
| 188 | +configuration.api_key['authCookie'] = 'YOUR_API_KEY' |
| 189 | + |
| 190 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 191 | +# configuration.api_key_prefix['authCookie'] = 'Bearer' |
| 192 | + |
| 193 | +# Enter a context with an instance of the API client |
| 194 | +with vrchatapi.ApiClient(configuration) as api_client: |
| 195 | + # Create an instance of the API class |
| 196 | + api_instance = vrchatapi.JamsApi(api_client) |
| 197 | + type = 'avatar' # str | Only show jams of this type (`avatar` or `world`). (optional) |
| 198 | + |
| 199 | + try: |
| 200 | + # Show jams list |
| 201 | + api_response = api_instance.get_jams(type=type) |
| 202 | + pprint(api_response) |
| 203 | + except ApiException as e: |
| 204 | + print("Exception when calling JamsApi->get_jams: %s\n" % e) |
| 205 | +``` |
| 206 | + |
| 207 | +### Parameters |
| 208 | + |
| 209 | +Name | Type | Description | Notes |
| 210 | +------------- | ------------- | ------------- | ------------- |
| 211 | + **type** | **str**| Only show jams of this type (`avatar` or `world`). | [optional] |
| 212 | + |
| 213 | +### Return type |
| 214 | + |
| 215 | +[**list[Jam]**](Jam.md) |
| 216 | + |
| 217 | +### Authorization |
| 218 | + |
| 219 | +[authCookie](../README.md#authCookie) |
| 220 | + |
| 221 | +### HTTP request headers |
| 222 | + |
| 223 | + - **Content-Type**: Not defined |
| 224 | + - **Accept**: application/json |
| 225 | + |
| 226 | +### HTTP response details |
| 227 | +| Status code | Description | Response headers | |
| 228 | +|-------------|-------------|------------------| |
| 229 | +**200** | Returns a list of Jam objects. | - | |
| 230 | + |
| 231 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 232 | + |
0 commit comments