GlossarySpellingApi

All URIs are relative to http://127.0.0.1:8000/api

Method HTTP request Description
glossarySpellingDestroy DELETE /glossary-spelling/{glossarySpelling} Remove the specified resource from storage
glossarySpellingIndex GET /glossary-spelling Display a listing of the resource
glossarySpellingShow GET /glossary-spelling/{glossarySpelling} Display the specified resource
glossarySpellingStore POST /glossary-spelling Store a newly created resource in storage
glossarySpellingUpdate PATCH /glossary-spelling/{glossarySpelling} Update the specified resource in storage
glossarySpellingUpdate2 PUT /glossary-spelling/{glossarySpelling} Update the specified resource in storage

glossarySpellingDestroy

glossarySpellingDestroy()

Example

import {
    GlossarySpellingApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new GlossarySpellingApi(configuration);

let glossarySpelling: string; //The glossary spelling ID (default to undefined)

const { status, data } = await apiInstance.glossarySpellingDestroy(
    glossarySpelling
);

Parameters

Name Type Description Notes
glossarySpelling [string] The glossary spelling ID defaults to undefined

Return type

void (empty response body)

Authorization

http

HTTP request headers

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

glossarySpellingIndex

GlossarySpellingIndex200Response glossarySpellingIndex()

Example

import {
    GlossarySpellingApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new GlossarySpellingApi(configuration);

let page: number; // (optional) (default to undefined)
let perPage: number; // (optional) (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.glossarySpellingIndex(
    page,
    perPage,
    include
);

Parameters

Name Type Description Notes
page [number]   (optional) defaults to undefined
perPage [number]   (optional) defaults to undefined
include [string]   (optional) defaults to undefined

Return type

GlossarySpellingIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Paginated set of `GlossarySpellingResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

glossarySpellingShow

GlossarySpellingShow200Response glossarySpellingShow()

Example

import {
    GlossarySpellingApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new GlossarySpellingApi(configuration);

let glossarySpelling: string; //The glossary spelling ID (default to undefined)
let include: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.glossarySpellingShow(
    glossarySpelling,
    include
);

Parameters

Name Type Description Notes
glossarySpelling [string] The glossary spelling ID defaults to undefined
include [string]   (optional) defaults to undefined

Return type

GlossarySpellingShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `GlossarySpellingResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

glossarySpellingStore

GlossarySpellingShow200Response glossarySpellingStore(storeGlossarySpellingRequest)

Example

import {
    GlossarySpellingApi,
    Configuration,
    StoreGlossarySpellingRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new GlossarySpellingApi(configuration);

let storeGlossarySpellingRequest: StoreGlossarySpellingRequest; //

const { status, data } = await apiInstance.glossarySpellingStore(
    storeGlossarySpellingRequest
);

Parameters

Name Type Description Notes
storeGlossarySpellingRequest StoreGlossarySpellingRequest    

Return type

GlossarySpellingShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `GlossarySpellingResource` | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

glossarySpellingUpdate

GlossarySpellingShow200Response glossarySpellingUpdate()

Example

import {
    GlossarySpellingApi,
    Configuration,
    UpdateGlossarySpellingRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new GlossarySpellingApi(configuration);

let glossarySpelling: string; //The glossary spelling ID (default to undefined)
let updateGlossarySpellingRequest: UpdateGlossarySpellingRequest; // (optional)

const { status, data } = await apiInstance.glossarySpellingUpdate(
    glossarySpelling,
    updateGlossarySpellingRequest
);

Parameters

Name Type Description Notes
updateGlossarySpellingRequest UpdateGlossarySpellingRequest    
glossarySpelling [string] The glossary spelling ID defaults to undefined

Return type

GlossarySpellingShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `GlossarySpellingResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

glossarySpellingUpdate2

GlossarySpellingShow200Response glossarySpellingUpdate2()

Example

import {
    GlossarySpellingApi,
    Configuration,
    UpdateGlossarySpellingRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new GlossarySpellingApi(configuration);

let glossarySpelling: string; //The glossary spelling ID (default to undefined)
let updateGlossarySpellingRequest: UpdateGlossarySpellingRequest; // (optional)

const { status, data } = await apiInstance.glossarySpellingUpdate2(
    glossarySpelling,
    updateGlossarySpellingRequest
);

Parameters

Name Type Description Notes
updateGlossarySpellingRequest UpdateGlossarySpellingRequest    
glossarySpelling [string] The glossary spelling ID defaults to undefined

Return type

GlossarySpellingShow200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `GlossarySpellingResource` | - | |404 | Not found | - | |401 | Unauthenticated | - | |422 | Validation error | - | |403 | Authorization error | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.