Skip to content

Latest commit

 

History

History
92 lines (57 loc) · 2.05 KB

ContactApi.md

File metadata and controls

92 lines (57 loc) · 2.05 KB

DigitaleKulturEvokeApiClientJs.ContactApi

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

Method HTTP request Description
createMessage POST /contact Send a new message
showAllCategories GET /contact/categories Get a list of all contact categories

createMessage

createMessage(contactMessage)

Send a new message

Example

import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClientJs.ContactApi();
let contactMessage = new DigitaleKulturEvokeApiClientJs.ContactMessage(); // ContactMessage | Information about the message to be sent
apiInstance.createMessage(contactMessage, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
contactMessage ContactMessage Information about the message to be sent

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

showAllCategories

[ContactCategory] showAllCategories()

Get a list of all contact categories

Example

import DigitaleKulturEvokeApiClientJs from 'digitale-kultur/evoke-api-client-js';

let apiInstance = new DigitaleKulturEvokeApiClientJs.ContactApi();
apiInstance.showAllCategories((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

[ContactCategory]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json