LanguageApi
All URIs are relative to http://localhost:8000/api
Method | HTTP request | Description |
---|---|---|
languageDestroy | DELETE /language/{language} | Remove the specified resource from storage |
languageGetDefault | GET /language/default | Get the default Language |
languageGetEnglish | GET /language/english | Get the english Language |
languageIndex | GET /language | Display a listing of the resource |
languageSetDefault | PATCH /language/{language}/default | Set a Language as the default one |
languageShow | GET /language/{language} | Display the specified resource |
languageStore | POST /language | Store a newly created resource in storage |
languageUpdate | PUT /language/{language} | Update the specified resource in storage |
languageDestroy
languageDestroy()
Example
import {
LanguageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
let language: string; //The language ID (default to undefined)
const { status, data } = await apiInstance.languageDestroy(
language
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
language | [string] | The language 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
languageGetDefault
LanguageSetDefault200Response languageGetDefault()
Example
import {
LanguageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
const { status, data } = await apiInstance.languageGetDefault();
Parameters
This endpoint does not have any parameters.
Return type
LanguageSetDefault200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageResource` | - | |404 | | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
languageGetEnglish
LanguageSetDefault200Response languageGetEnglish()
Example
import {
LanguageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
const { status, data } = await apiInstance.languageGetEnglish();
Parameters
This endpoint does not have any parameters.
Return type
LanguageSetDefault200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageResource` | - | |404 | | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
languageIndex
LanguageIndex200Response languageIndex()
Example
import {
LanguageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
const { status, data } = await apiInstance.languageIndex();
Parameters
This endpoint does not have any parameters.
Return type
LanguageIndex200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `LanguageResource` | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
languageSetDefault
LanguageSetDefault200Response languageSetDefault(contextSetDefaultRequest)
Example
import {
LanguageApi,
Configuration,
ContextSetDefaultRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
let language: string; //The language ID (default to undefined)
let contextSetDefaultRequest: ContextSetDefaultRequest; //
const { status, data } = await apiInstance.languageSetDefault(
language,
contextSetDefaultRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
contextSetDefaultRequest | ContextSetDefaultRequest | ||
language | [string] | The language ID | defaults to undefined |
Return type
LanguageSetDefault200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
languageShow
LanguageSetDefault200Response languageShow()
Example
import {
LanguageApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
let language: string; //The language ID (default to undefined)
const { status, data } = await apiInstance.languageShow(
language
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
language | [string] | The language ID | defaults to undefined |
Return type
LanguageSetDefault200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
languageStore
LanguageSetDefault200Response languageStore(languageStoreRequest)
Example
import {
LanguageApi,
Configuration,
LanguageStoreRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
let languageStoreRequest: LanguageStoreRequest; //
const { status, data } = await apiInstance.languageStore(
languageStoreRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
languageStoreRequest | LanguageStoreRequest |
Return type
LanguageSetDefault200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |
Back to top Back to API list Back to Model list Back to README
languageUpdate
LanguageSetDefault200Response languageUpdate(languageUpdateRequest)
Example
import {
LanguageApi,
Configuration,
LanguageUpdateRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new LanguageApi(configuration);
let language: string; //The language ID (default to undefined)
let languageUpdateRequest: LanguageUpdateRequest; //
const { status, data } = await apiInstance.languageUpdate(
language,
languageUpdateRequest
);
Parameters
Name | Type | Description | Notes |
---|---|---|---|
languageUpdateRequest | LanguageUpdateRequest | ||
language | [string] | The language ID | defaults to undefined |
Return type
LanguageSetDefault200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers | |————-|————-|——————| |200 | `LanguageResource` | - | |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.