LocationApi

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

Method HTTP request Description
locationDestroy DELETE /location/{location} Remove the specified location
locationIndex GET /location Display a listing of locations
locationShow GET /location/{location} Display the specified location
locationStore POST /location Store a newly created location
locationUpdate PUT /location/{location} Update the specified location

locationDestroy

locationDestroy()

Example

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

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

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

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

Parameters

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

locationIndex

LocationIndex200Response locationIndex()

Example

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

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

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

Parameters

This endpoint does not have any parameters.

Return type

LocationIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

locationShow

LocationStore201Response locationShow()

Example

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

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

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

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

Parameters

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

Return type

LocationStore201Response

Authorization

http

HTTP request headers

HTTP response details

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

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

locationStore

LocationStore201Response locationStore(locationStoreRequest)

Example

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

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

let locationStoreRequest: LocationStoreRequest; //

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

Parameters

Name Type Description Notes
locationStoreRequest LocationStoreRequest    

Return type

LocationStore201Response

Authorization

http

HTTP request headers

HTTP response details

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

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

locationUpdate

LocationStore201Response locationUpdate(locationUpdateRequest)

Example

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

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

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

const { status, data } = await apiInstance.locationUpdate(
    location,
    locationUpdateRequest
);

Parameters

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

Return type

LocationStore201Response

Authorization

http

HTTP request headers

HTTP response details

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