Skip to content

TemplateRoutesApi.md

Latest commit

 

History

History
501 lines (378 loc) · 14.2 KB

TemplateRoutesApi.md

File metadata and controls

501 lines (378 loc) · 14.2 KB

TemplateRoutesApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteTemplById DELETE /api/v1/template/{id}
findAll GET /api/v1/template/find-all
findByContext GET /api/v1/template/find-by-context
findByIds GET /api/v1/template/find-by-ids
findByType GET /api/v1/template/find-by-type
findOne GET /api/v1/template/find-one/{templ_id}
render POST /api/v1/template/render
upsert POST /api/v1/template

deleteTemplById

deleteTemplById(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      apiInstance.deleteTemplById(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#deleteTemplById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Delete a template by id -

findAll

List<TemplateV2> findAll()

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    try {
      List<TemplateV2> result = apiInstance.findAll();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#findAll");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

List<TemplateV2>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Find all templates -

findByContext

List<TemplateV2> findByContext(context)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    Context context = Context.fromValue("INVOICE"); // Context | 
    try {
      List<TemplateV2> result = apiInstance.findByContext(context);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#findByContext");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
context Context [enum: INVOICE, PEPPOL, C_V]

Return type

List<TemplateV2>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Find templates by context -

findByIds

List<TemplateV2> findByIds(ids)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    List<String> ids = Arrays.asList(); // List<String> | 
    try {
      List<TemplateV2> result = apiInstance.findByIds(ids);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#findByIds");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
ids List<String>

Return type

List<TemplateV2>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Find By ids -

findByType

List<TemplateV2> findByType(templateType)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    TemplateType templateType = TemplateType.fromValue("HTML"); // TemplateType | 
    try {
      List<TemplateV2> result = apiInstance.findByType(templateType);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#findByType");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
templateType TemplateType [enum: HTML, XML]

Return type

List<TemplateV2>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Find templates by type -

findOne

TemplateV2 findOne(templId)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    String templId = "templId_example"; // String | 
    try {
      TemplateV2 result = apiInstance.findOne(templId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#findOne");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
templId String

Return type

TemplateV2

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Find a template by id -

render

File render(renderRequest)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    RenderRequest renderRequest = new RenderRequest(); // RenderRequest | 
    try {
      File result = apiInstance.render(renderRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#render");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
renderRequest RenderRequest

Return type

File

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Render template -

upsert

TemplateV2 upsert(title, templateType, templateContext, files, id, description)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.TemplateRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient);
    String title = "title_example"; // String | 
    TemplateType templateType = TemplateType.fromValue("HTML"); // TemplateType | 
    Context templateContext = Context.fromValue("INVOICE"); // Context | 
    List<File> files = Arrays.asList(); // List<File> | 
    String id = "id_example"; // String | 
    String description = "description_example"; // String | 
    try {
      TemplateV2 result = apiInstance.upsert(title, templateType, templateContext, files, id, description);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TemplateRoutesApi#upsert");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
title String
templateType TemplateType [enum: HTML, XML]
templateContext Context [enum: INVOICE, PEPPOL, C_V]
files List<File>
id String [optional]
description String [optional]

Return type

TemplateV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Upsert a template -