DetailApi

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

Method HTTP request Description
detailDestroy DELETE /detail/{detail} Remove the specified resource from storage
detailIndex GET /detail Display a listing of the resource
detailShow GET /detail/{detail} Display the specified resource
detailStore POST /detail Store a newly created resource in storage
detailUpdate PUT /detail/{detail} Update the specified resource in storage

detailDestroy

detailDestroy()

Example

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

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

let detail: string; //The detail ID (default to undefined)

const { status, data } = await apiInstance.detailDestroy(
    detail
);

Parameters

Name Type Description Notes
detail [string] The detail 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

detailIndex

DetailIndex200Response detailIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

DetailIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `DetailResource` | - | |401 | Unauthenticated | - |

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

detailShow

DetailStore200Response detailShow()

Example

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

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

let detail: string; //The detail ID (default to undefined)

const { status, data } = await apiInstance.detailShow(
    detail
);

Parameters

Name Type Description Notes
detail [string] The detail ID defaults to undefined

Return type

DetailStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `DetailResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |

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

detailStore

DetailStore200Response detailStore(detailStoreRequest)

Example

import {
    DetailApi,
    Configuration,
    DetailStoreRequest
} from './api';

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

let detailStoreRequest: DetailStoreRequest; //

const { status, data } = await apiInstance.detailStore(
    detailStoreRequest
);

Parameters

Name Type Description Notes
detailStoreRequest DetailStoreRequest    

Return type

DetailStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `DetailResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |

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

detailUpdate

DetailStore200Response detailUpdate(detailStoreRequest)

Example

import {
    DetailApi,
    Configuration,
    DetailStoreRequest
} from './api';

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

let detail: string; //The detail ID (default to undefined)
let detailStoreRequest: DetailStoreRequest; //

const { status, data } = await apiInstance.detailUpdate(
    detail,
    detailStoreRequest
);

Parameters

Name Type Description Notes
detailStoreRequest DetailStoreRequest    
detail [string] The detail ID defaults to undefined

Return type

DetailStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `DetailResource` | - | |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.