LocationApi

All URIs are relative to http://127.0.0.1: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 PATCH /location/{location} Update the specified location
locationUpdate2 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);

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.locationIndex(
    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

LocationIndex200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

locationShow

LocationShow200Response 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)
let include: string; // (optional) (default to undefined)

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

Parameters

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

Return type

LocationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

locationStore

LocationShow200Response locationStore(storeLocationRequest)

Example

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

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

let storeLocationRequest: StoreLocationRequest; //

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

Parameters

Name Type Description Notes
storeLocationRequest StoreLocationRequest    

Return type

LocationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

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

locationUpdate

LocationShow200Response locationUpdate(updateLocationRequest)

Example

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

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

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

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

Parameters

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

Return type

LocationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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

locationUpdate2

LocationShow200Response locationUpdate2(updateLocationRequest)

Example

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

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

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

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

Parameters

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

Return type

LocationShow200Response

Authorization

http

HTTP request headers

HTTP response details

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