Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
288 lines (197 loc) · 9.13 KB

ObjectBrandingApi.md

File metadata and controls

288 lines (197 loc) · 9.13 KB

EZmaxApiDefinitionFull.ObjectBrandingApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
brandingCreateObjectV1 POST /1/object/branding Create a new Branding
brandingEditObjectV1 PUT /1/object/branding/{pkiBrandingID} Edit an existing Branding
brandingGetAutocompleteV2 GET /2/object/branding/getAutocomplete/{sSelector} Retrieve Brandings and IDs
brandingGetListV1 GET /1/object/branding/getList Retrieve Branding list
brandingGetObjectV2 GET /2/object/branding/{pkiBrandingID} Retrieve an existing Branding

brandingCreateObjectV1

BrandingCreateObjectV1Response brandingCreateObjectV1(BrandingCreateObjectV1Request)

Create a new Branding

The endpoint allows to create one or many elements at once.

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectBrandingApi();
let BrandingCreateObjectV1Request = new EZmaxApiDefinitionFull.BrandingCreateObjectV1Request(); // BrandingCreateObjectV1Request | 
apiInstance.brandingCreateObjectV1(BrandingCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
BrandingCreateObjectV1Request BrandingCreateObjectV1Request

Return type

BrandingCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

brandingEditObjectV1

BrandingEditObjectV1Response brandingEditObjectV1(pkiBrandingID, BrandingEditObjectV1Request)

Edit an existing Branding

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectBrandingApi();
let pkiBrandingID = 56; // Number | 
let BrandingEditObjectV1Request = new EZmaxApiDefinitionFull.BrandingEditObjectV1Request(); // BrandingEditObjectV1Request | 
apiInstance.brandingEditObjectV1(pkiBrandingID, BrandingEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiBrandingID Number
BrandingEditObjectV1Request BrandingEditObjectV1Request

Return type

BrandingEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

brandingGetAutocompleteV2

BrandingGetAutocompleteV2Response brandingGetAutocompleteV2(sSelector, opts)

Retrieve Brandings and IDs

Get the list of Branding to be used in a dropdown or autocomplete control.

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectBrandingApi();
let sSelector = "sSelector_example"; // String | The type of Brandings to return
let opts = {
  'eFilterActive': "'Active'", // String | Specify which results we want to display.
  'sQuery': "sQuery_example", // String | Allow to filter the returned results
  'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage() // HeaderAcceptLanguage | 
};
apiInstance.brandingGetAutocompleteV2(sSelector, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
sSelector String The type of Brandings to return
eFilterActive String Specify which results we want to display. [optional] [default to 'Active']
sQuery String Allow to filter the returned results [optional]
Accept_Language HeaderAcceptLanguage [optional]

Return type

BrandingGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

brandingGetListV1

BrandingGetListV1Response brandingGetListV1(opts)

Retrieve Branding list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eBrandingLogo | Default<br>JPEG<br>PNG |

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectBrandingApi();
let opts = {
  'eOrderBy': "eOrderBy_example", // String | Specify how you want the results to be sorted
  'iRowMax': 10000, // Number | 
  'iRowOffset': 0, // Number | 
  'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage(), // HeaderAcceptLanguage | 
  'sFilter': "sFilter_example" // String | 
};
apiInstance.brandingGetListV1(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax Number [optional] [default to 10000]
iRowOffset Number [optional] [default to 0]
Accept_Language HeaderAcceptLanguage [optional]
sFilter String [optional]

Return type

BrandingGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

brandingGetObjectV2

BrandingGetObjectV2Response brandingGetObjectV2(pkiBrandingID)

Retrieve an existing Branding

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectBrandingApi();
let pkiBrandingID = 56; // Number | 
apiInstance.brandingGetObjectV2(pkiBrandingID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiBrandingID Number

Return type

BrandingGetObjectV2Response

Authorization

Authorization

HTTP request headers

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