Skip to content

DefaultApi.md

Latest commit

 

History

History
112 lines (78 loc) · 3.2 KB

DefaultApi.md

File metadata and controls

112 lines (78 loc) · 3.2 KB

DefaultApi

All URIs are relative to https://api.doxey.io

Method HTTP request Description
mergeGet GET /v1/merge
mergePost POST /v1/merge

mergeGet

File mergeGet(apiKey, template, locale, currency, timezone, format, model)

Merge the template document into a new document, given a Model

Example

// Import classes:
//import com.floreysoft.doxey.invoke.ApiException;
//import com.floreysoft.doxey.api.DefaultApi;


DefaultApi apiInstance = new DefaultApi();
String apiKey = "apiKey_example"; // String | API key
String template = "template_example"; // String | URL (http or data) of the source file
String locale = "locale_example"; // String | The locale ('de', 'en' ...)
String currency = "currency_example"; // String | The currency ('USD', 'EUR' ...)
String timezone = "timezone_example"; // String | The timezone ('Europe/Berlin', 'GMT+06:00' ...)
String format = "format_example"; // String | Target format
Object model = null; // Object | Variable model
try {
    File result = apiInstance.mergeGet(apiKey, template, locale, currency, timezone, format, model);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#mergeGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
apiKey String API key
template String URL (http or data) of the source file
locale String The locale ('de', 'en' ...)
currency String The currency ('USD', 'EUR' ...)
timezone String The timezone ('Europe/Berlin', 'GMT+06:00' ...)
format String Target format [enum: pdf, txt, odt, html, docx]
model Object Variable model

Return type

File

Authorization

No authorization required

HTTP request headers

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

mergePost

File mergePost(params)

Merge the template document into a new document, given a Model

Example

// Import classes:
//import com.floreysoft.doxey.invoke.ApiException;
//import com.floreysoft.doxey.api.DefaultApi;


DefaultApi apiInstance = new DefaultApi();
Params params = new Params(); // Params | The conversion parameters
try {
    File result = apiInstance.mergePost(params);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#mergePost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
params Params The conversion parameters

Return type

File

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/zip, application/pdf, application/docx, application/odt, text/html, text/plain, application/octetstream, application/json