Skip to content

Latest commit

 

History

History
293 lines (190 loc) · 7.82 KB

DestinoApi.md

File metadata and controls

293 lines (190 loc) · 7.82 KB
Raw

SwaggerJsClient.DestinoApi

All URIs are relative to /

Method HTTP request Description
deleteDestinoItem DELETE /api/destinos/{idDestino} Removes the Destino resource.
getDestinoCollection GET /api/destinos Retrieves the collection of Destino resources.
getDestinoItem GET /api/destinos/{idDestino} Retrieves a Destino resource.
patchDestinoItem PATCH /api/destinos/{idDestino} Updates the Destino resource.
postDestinoCollection POST /api/destinos Creates a Destino resource.
putDestinoItem PUT /api/destinos/{idDestino} Replaces the Destino resource.

deleteDestinoItem

deleteDestinoItem(idDestino)

Removes the Destino resource.

Removes the Destino resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.DestinoApi();
let idDestino = "idDestino_example"; // String | Resource identifier

apiInstance.deleteDestinoItem(idDestino, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully.");
  }
});

Parameters

Name Type Description Notes
idDestino String Resource identifier

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getDestinoCollection

InlineResponse2005 getDestinoCollection(opts)

Retrieves the collection of Destino resources.

Retrieves the collection of Destino resources.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.DestinoApi();
let opts = {
  page: 1, // Number | The collection page number
};
apiInstance.getDestinoCollection(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
page Number The collection page number [optional] [default to 1]

Return type

InlineResponse2005

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/ld+json, application/json, text/html

getDestinoItem

DestinoJsonld getDestinoItem(idDestino)

Retrieves a Destino resource.

Retrieves a Destino resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.DestinoApi();
let idDestino = "idDestino_example"; // String | Resource identifier

apiInstance.getDestinoItem(idDestino, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
idDestino String Resource identifier

Return type

DestinoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/ld+json, application/json, text/html

patchDestinoItem

DestinoJsonld patchDestinoItem(body, idDestino)

Updates the Destino resource.

Updates the Destino resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.DestinoApi();
let body = new SwaggerJsClient.Destino(); // Destino | The updated Destino resource
let idDestino = "idDestino_example"; // String | Resource identifier

apiInstance.patchDestinoItem(body, idDestino, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
body Destino The updated Destino resource
idDestino String Resource identifier

Return type

DestinoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/merge-patch+json
  • Accept: application/ld+json, application/json, text/html

postDestinoCollection

DestinoJsonld postDestinoCollection(body)

Creates a Destino resource.

Creates a Destino resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.DestinoApi();
let body = new SwaggerJsClient.DestinoJsonld(); // DestinoJsonld | The new Destino resource

apiInstance.postDestinoCollection(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
body DestinoJsonld The new Destino resource

Return type

DestinoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/ld+json, application/json, text/html
  • Accept: application/ld+json, application/json, text/html

putDestinoItem

DestinoJsonld putDestinoItem(body, idDestino)

Replaces the Destino resource.

Replaces the Destino resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.DestinoApi();
let body = new SwaggerJsClient.DestinoJsonld(); // DestinoJsonld | The updated Destino resource
let idDestino = "idDestino_example"; // String | Resource identifier

apiInstance.putDestinoItem(body, idDestino, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
body DestinoJsonld The updated Destino resource
idDestino String Resource identifier

Return type

DestinoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/ld+json, application/json, text/html
  • Accept: application/ld+json, application/json, text/html