CountryApi

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

Method HTTP request Description
countryDestroy DELETE /country/{country} Remove the specified resource from storage
countryIndex GET /country Display a listing of the resource
countryShow GET /country/{country} Display the specified resource
countryStore POST /country Store a newly created resource in storage
countryUpdate PUT /country/{country} Update the specified resource in storage

countryDestroy

countryDestroy()

Example

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

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

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

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

Parameters

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

countryIndex

CountryIndex200Response countryIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

CountryIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

countryShow

CountryStore200Response countryShow()

Example

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

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

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

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

Parameters

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

Return type

CountryStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

countryStore

CountryStore200Response countryStore(countryStoreRequest)

Example

import {
    CountryApi,
    Configuration,
    CountryStoreRequest
} from './api';

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

let countryStoreRequest: CountryStoreRequest; //

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

Parameters

Name Type Description Notes
countryStoreRequest CountryStoreRequest    

Return type

CountryStore200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

countryUpdate

CountryStore200Response countryUpdate(countryUpdateRequest)

Example

import {
    CountryApi,
    Configuration,
    CountryUpdateRequest
} from './api';

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

let country: string; //The country ID (default to undefined)
let countryUpdateRequest: CountryUpdateRequest; //

const { status, data } = await apiInstance.countryUpdate(
    country,
    countryUpdateRequest
);

Parameters

Name Type Description Notes
countryUpdateRequest CountryUpdateRequest    
country [string] The country ID defaults to undefined

Return type

CountryStore200Response

Authorization

http

HTTP request headers

HTTP response details

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