ThemeApi
All URIs are relative to http://localhost:8000/api
Method | HTTP request | Description |
---|---|---|
themeDestroy | DELETE /theme/{theme} | Remove the specified theme from storage |
themeIndex | GET /theme | Display a listing of the themes for an exhibition |
themeShow | GET /theme/{theme} | Display the specified theme |
themeStore | POST /theme | Store a newly created theme in storage |
themeUpdate | PUT /theme/{theme} | Update the specified theme in storage |
themeDestroy
themeDestroy()
Example
import {
ThemeApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ThemeApi(configuration);
let theme: string; //The theme ID (default to undefined)
const { status, data } = await apiInstance.themeDestroy(
theme
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
theme | [string] | The theme ID | defaults to undefined |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
themeIndex
ThemeIndex200Response themeIndex()
Example
import {
ThemeApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ThemeApi(configuration);
const { status, data } = await apiInstance.themeIndex();
Parameters
This endpoint does not have any parameters.
Return type
ThemeIndex200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `ThemeResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
themeShow
ThemeStore200Response themeShow()
Example
import {
ThemeApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ThemeApi(configuration);
let theme: string; //The theme ID (default to undefined)
const { status, data } = await apiInstance.themeShow(
theme
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
theme | [string] | The theme ID | defaults to undefined |
Return type
ThemeStore200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ThemeResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
themeStore
ThemeStore200Response themeStore(themeStoreRequest)
Example
import {
ThemeApi,
Configuration,
ThemeStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ThemeApi(configuration);
let themeStoreRequest: ThemeStoreRequest; //
const { status, data } = await apiInstance.themeStore(
themeStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
themeStoreRequest | ThemeStoreRequest |
Return type
ThemeStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ThemeResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
themeUpdate
ThemeStore200Response themeUpdate()
Example
import {
ThemeApi,
Configuration,
ExhibitionUpdateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ThemeApi(configuration);
let theme: string; //The theme ID (default to undefined)
let exhibitionUpdateRequest: ExhibitionUpdateRequest; // (optional)
const { status, data } = await apiInstance.themeUpdate(
theme,
exhibitionUpdateRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
exhibitionUpdateRequest | ExhibitionUpdateRequest | ||
theme | [string] | The theme ID | defaults to undefined |
Return type
ThemeStore200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `ThemeResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
This documentation was automatically generated from the TypeScript API client.