Skip to content

Latest commit

 

History

History
221 lines (142 loc) · 5.22 KB

EventApi.md

File metadata and controls

221 lines (142 loc) · 5.22 KB

SeminarCatalogApi.EventApi

All URIs are relative to https://localhost

Method HTTP request Description
eventCreate POST /api/event SeminarCatalog\Rest\Resources\Controller\ResourceController::create
eventDelete DELETE /api/event/{id}/{lng} SeminarCatalog\Rest\Resources\Controller\ResourceController::delete
eventGet GET /api/event/{id}/{lng} SeminarCatalog\Rest\Resources\Controller\ResourceController::get
eventList GET /api/event SeminarCatalog\Rest\Resources\Controller\ResourceController::list
eventUpdate PUT /api/event/{id} SeminarCatalog\Rest\Resources\Controller\ResourceController::update

eventCreate

Event eventCreate(eventPost)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.EventApi();

const eventPost = new SeminarCatalogApi.Event(); // Event | 

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

Parameters

Name Type Description Notes
eventPost Event

Return type

Event

Authorization

No authorization required

HTTP request headers

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

eventDelete

Event eventDelete(id, lng)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.EventApi();

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

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

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

Event

Authorization

No authorization required

HTTP request headers

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

eventGet

Event eventGet(id, lng)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.EventApi();

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

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

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

Event

Authorization

No authorization required

HTTP request headers

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

eventList

EventPaginationResult eventList()

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

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

Parameters

This endpoint does not need any parameter.

Return type

EventPaginationResult

Authorization

No authorization required

HTTP request headers

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

eventUpdate

Event eventUpdate(id, eventPut)

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

Example

import {SeminarCatalogApi} from 'seminar_catalog_api';

const apiInstance = new SeminarCatalogApi.EventApi();

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

const eventPut = new SeminarCatalogApi.Event(); // Event | 

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

Parameters

Name Type Description Notes
id Number The resource identifier
eventPut Event

Return type

Event

Authorization

No authorization required

HTTP request headers

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