Skip to content

Latest commit

 

History

History
259 lines (168 loc) · 8.52 KB

ObjectBrandingApi.md

File metadata and controls

259 lines (168 loc) · 8.52 KB

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 classes:
//import org.openapitools.client.api.ObjectBrandingApi;

ObjectBrandingApi apiInstance = new ObjectBrandingApi();
BrandingCreateObjectV1Request brandingCreateObjectV1Request = new BrandingCreateObjectV1Request(); // BrandingCreateObjectV1Request | 
try {
    BrandingCreateObjectV1Response result = apiInstance.brandingCreateObjectV1(brandingCreateObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectBrandingApi#brandingCreateObjectV1");
    e.printStackTrace();
}

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 classes:
//import org.openapitools.client.api.ObjectBrandingApi;

ObjectBrandingApi apiInstance = new ObjectBrandingApi();
Integer pkiBrandingID = null; // Integer | 
BrandingEditObjectV1Request brandingEditObjectV1Request = new BrandingEditObjectV1Request(); // BrandingEditObjectV1Request | 
try {
    BrandingEditObjectV1Response result = apiInstance.brandingEditObjectV1(pkiBrandingID, brandingEditObjectV1Request);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectBrandingApi#brandingEditObjectV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiBrandingID Integer [default to null]
brandingEditObjectV1Request BrandingEditObjectV1Request

Return type

BrandingEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

brandingGetAutocompleteV2

BrandingGetAutocompleteV2Response brandingGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Brandings and IDs

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

Example

// Import classes:
//import org.openapitools.client.api.ObjectBrandingApi;

ObjectBrandingApi apiInstance = new ObjectBrandingApi();
String sSelector = null; // String | The type of Brandings to return
String eFilterActive = Active; // String | Specify which results we want to display.
String sQuery = null; // String | Allow to filter the returned results
HeaderAcceptLanguage acceptLanguage = null; // HeaderAcceptLanguage | 
try {
    BrandingGetAutocompleteV2Response result = apiInstance.brandingGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectBrandingApi#brandingGetAutocompleteV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
sSelector String The type of Brandings to return [default to null] [enum: All]
eFilterActive String Specify which results we want to display. [optional] [default to Active] [enum: All, Active, Inactive]
sQuery String Allow to filter the returned results [optional] [default to null]
acceptLanguage HeaderAcceptLanguage [optional] [default to null] [enum: *, en, fr]

Return type

BrandingGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

brandingGetListV1

BrandingGetListV1Response brandingGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Branding list

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

Example

// Import classes:
//import org.openapitools.client.api.ObjectBrandingApi;

ObjectBrandingApi apiInstance = new ObjectBrandingApi();
String eOrderBy = null; // String | Specify how you want the results to be sorted
Integer iRowMax = null; // Integer | 
Integer iRowOffset = 0; // Integer | 
HeaderAcceptLanguage acceptLanguage = null; // HeaderAcceptLanguage | 
String sFilter = null; // String | 
try {
    BrandingGetListV1Response result = apiInstance.brandingGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectBrandingApi#brandingGetListV1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional] [default to null] [enum: pkiBrandingID_ASC, pkiBrandingID_DESC, sBrandingDescriptionX_ASC, sBrandingDescriptionX_DESC, iBrandingColortext_ASC, iBrandingColortext_DESC, iBrandingColortextlinkbox_ASC, iBrandingColortextlinkbox_DESC, iBrandingColortextbutton_ASC, iBrandingColortextbutton_DESC, iBrandingColorbackground_ASC, iBrandingColorbackground_DESC, iBrandingColorbackgroundbutton_ASC, iBrandingColorbackgroundbutton_DESC, iBrandingColorbackgroundsmallbox_ASC, iBrandingColorbackgroundsmallbox_DESC, bBrandingIsactive_ASC, bBrandingIsactive_DESC]
iRowMax Integer [optional] [default to null]
iRowOffset Integer [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [default to null] [enum: *, en, fr]
sFilter String [optional] [default to null]

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 classes:
//import org.openapitools.client.api.ObjectBrandingApi;

ObjectBrandingApi apiInstance = new ObjectBrandingApi();
Integer pkiBrandingID = null; // Integer | 
try {
    BrandingGetObjectV2Response result = apiInstance.brandingGetObjectV2(pkiBrandingID);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ObjectBrandingApi#brandingGetObjectV2");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
pkiBrandingID Integer [default to null]

Return type

BrandingGetObjectV2Response

Authorization

Authorization

HTTP request headers

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