Skip to content

Latest commit

 

History

History
221 lines (142 loc) · 5.37 KB

ProductApi.md

File metadata and controls

221 lines (142 loc) · 5.37 KB

SeminarCatalogApi.ProductApi

All URIs are relative to https://localhost

Method HTTP request Description
productCreate POST /api/product SeminarCatalog\Rest\Resources\Controller\ResourceController::create
productDelete DELETE /api/product/{id}/{lng} SeminarCatalog\Rest\Resources\Controller\ResourceController::delete
productGet GET /api/product/{id}/{lng} SeminarCatalog\Rest\Resources\Controller\ResourceController::get
productList GET /api/product SeminarCatalog\Rest\Resources\Controller\ResourceController::list
productUpdate PUT /api/product/{id} SeminarCatalog\Rest\Resources\Controller\ResourceController::update

productCreate

Product productCreate(productPost)

SeminarCatalog\Rest\Resources\Controller\ResourceController::create

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.ProductApi();

const productPost = new SeminarCatalogApi.Product(); // Product | 

apiInstance.productCreate(productPost).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
productPost Product

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

productDelete

Product productDelete(id, lng)

SeminarCatalog\Rest\Resources\Controller\ResourceController::delete

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.ProductApi();

const id = 56; // Number | Numeric identifier for this resource

const lng = 56; // Number | Numeric identifier for this resource

apiInstance.productDelete(id, lng).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number Numeric identifier for this resource
lng Number Numeric identifier for this resource

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

productGet

Product productGet(id, lng)

SeminarCatalog\Rest\Resources\Controller\ResourceController::get

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.ProductApi();

const id = 56; // Number | Numeric identifier for this resource

const lng = 56; // Number | Numeric identifier for this resource

apiInstance.productGet(id, lng).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number Numeric identifier for this resource
lng Number Numeric identifier for this resource

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

productList

ProductPaginationResult productList()

SeminarCatalog\Rest\Resources\Controller\ResourceController::list

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.ProductApi();
apiInstance.productList().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

This endpoint does not need any parameter.

Return type

ProductPaginationResult

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

productUpdate

Product productUpdate(id, productPut)

SeminarCatalog\Rest\Resources\Controller\ResourceController::update

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.ProductApi();

const id = 56; // Number | The resource identifier

const productPut = new SeminarCatalogApi.Product(); // Product | 

apiInstance.productUpdate(id, productPut).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number The resource identifier
productPut Product

Return type

Product

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined