Skip to content

Latest commit

 

History

History
221 lines (142 loc) · 5.22 KB

TopicApi.md

File metadata and controls

221 lines (142 loc) · 5.22 KB

SeminarCatalogApi.TopicApi

All URIs are relative to https://localhost

Method HTTP request Description
topicCreate POST /api/topic SeminarCatalog\Rest\Resources\Controller\ResourceController::create
topicDelete DELETE /api/topic/{id}/{lng} SeminarCatalog\Rest\Resources\Controller\ResourceController::delete
topicGet GET /api/topic/{id}/{lng} SeminarCatalog\Rest\Resources\Controller\ResourceController::get
topicList GET /api/topic SeminarCatalog\Rest\Resources\Controller\ResourceController::list
topicUpdate PUT /api/topic/{id} SeminarCatalog\Rest\Resources\Controller\ResourceController::update

topicCreate

Topic topicCreate(topicPost)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.TopicApi();

const topicPost = new SeminarCatalogApi.Topic(); // Topic | 

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

Parameters

Name Type Description Notes
topicPost Topic

Return type

Topic

Authorization

No authorization required

HTTP request headers

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

topicDelete

Topic topicDelete(id, lng)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.TopicApi();

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

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

apiInstance.topicDelete(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

Topic

Authorization

No authorization required

HTTP request headers

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

topicGet

Topic topicGet(id, lng)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.TopicApi();

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

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

apiInstance.topicGet(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

Topic

Authorization

No authorization required

HTTP request headers

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

topicList

TopicPaginationResult topicList()

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

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

Parameters

This endpoint does not need any parameter.

Return type

TopicPaginationResult

Authorization

No authorization required

HTTP request headers

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

topicUpdate

Topic topicUpdate(id, topicPut)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.TopicApi();

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

const topicPut = new SeminarCatalogApi.Topic(); // Topic | 

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

Parameters

Name Type Description Notes
id Number The resource identifier
topicPut Topic

Return type

Topic

Authorization

No authorization required

HTTP request headers

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