ProvinceApi

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

Method HTTP request Description
provinceDestroy DELETE /province/{province} Remove the specified province
provinceIndex GET /province Display a listing of provinces
provinceShow GET /province/{province} Display the specified province
provinceStore POST /province Store a newly created province
provinceUpdate PUT /province/{province} Update the specified province

provinceDestroy

provinceDestroy()

Example

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

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

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

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

Parameters

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

provinceIndex

ProvinceIndex200Response provinceIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

ProvinceIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

provinceShow

ProvinceStore201Response provinceShow()

Example

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

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

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

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

Parameters

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

Return type

ProvinceStore201Response

Authorization

http

HTTP request headers

HTTP response details

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

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

provinceStore

ProvinceStore201Response provinceStore(locationStoreRequest)

Example

import {
    ProvinceApi,
    Configuration,
    LocationStoreRequest
} from './api';

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

let locationStoreRequest: LocationStoreRequest; //

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

Parameters

Name Type Description Notes
locationStoreRequest LocationStoreRequest    

Return type

ProvinceStore201Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |201 | `ProvinceResource` | - | |422 | | - | |401 | Unauthenticated | - |

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

provinceUpdate

ProvinceStore201Response provinceUpdate(locationUpdateRequest)

Example

import {
    ProvinceApi,
    Configuration,
    LocationUpdateRequest
} from './api';

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

let province: string; //The province ID (default to undefined)
let locationUpdateRequest: LocationUpdateRequest; //

const { status, data } = await apiInstance.provinceUpdate(
    province,
    locationUpdateRequest
);

Parameters

Name Type Description Notes
locationUpdateRequest LocationUpdateRequest    
province [string] The province ID defaults to undefined

Return type

ProvinceStore201Response

Authorization

http

HTTP request headers

HTTP response details

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