Skip to content

Latest commit

 

History

History
365 lines (251 loc) · 15 KB

ObjectUsergroupAPI.md

File metadata and controls

365 lines (251 loc) · 15 KB
Raw

ObjectUsergroupAPI

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

Method HTTP request Description
ObjectUsergroupAPI_usergroupCreateObjectV1 POST /1/object/usergroup Create a new Usergroup
ObjectUsergroupAPI_usergroupEditObjectV1 PUT /1/object/usergroup/{pkiUsergroupID} Edit an existing Usergroup
ObjectUsergroupAPI_usergroupEditPermissionsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions Edit multiple Permissions
ObjectUsergroupAPI_usergroupEditUsergroupdelegationsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations Edit multiple Usergroupdelegations
ObjectUsergroupAPI_usergroupEditUsergroupmembershipsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships Edit multiple Usergroupmemberships
ObjectUsergroupAPI_usergroupGetAutocompleteV2 GET /2/object/usergroup/getAutocomplete/{sSelector} Retrieve Usergroups and IDs
ObjectUsergroupAPI_usergroupGetListV1 GET /1/object/usergroup/getList Retrieve Usergroup list
ObjectUsergroupAPI_usergroupGetObjectV2 GET /2/object/usergroup/{pkiUsergroupID} Retrieve an existing Usergroup
ObjectUsergroupAPI_usergroupGetPermissionsV1 GET /1/object/usergroup/{pkiUsergroupID}/getPermissions Retrieve an existing Usergroup's Permissions
ObjectUsergroupAPI_usergroupGetUsergroupdelegationsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations Retrieve an existing Usergroup's Usergroupdelegations
ObjectUsergroupAPI_usergroupGetUsergroupmembershipsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships Retrieve an existing Usergroup's Usergroupmemberships

ObjectUsergroupAPI_usergroupCreateObjectV1

// Create a new Usergroup
//
// The endpoint allows to create one or many elements at once.
//
usergroup_create_object_v1_response_t* ObjectUsergroupAPI_usergroupCreateObjectV1(apiClient_t *apiClient, usergroup_create_object_v1_request_t *usergroup_create_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
usergroup_create_object_v1_request usergroup_create_object_v1_request_t *

Return type

usergroup_create_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupEditObjectV1

// Edit an existing Usergroup
//
// 
//
usergroup_edit_object_v1_response_t* ObjectUsergroupAPI_usergroupEditObjectV1(apiClient_t *apiClient, int *pkiUsergroupID, usergroup_edit_object_v1_request_t *usergroup_edit_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *
usergroup_edit_object_v1_request usergroup_edit_object_v1_request_t *

Return type

usergroup_edit_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupEditPermissionsV1

// Edit multiple Permissions
//
// Using this endpoint, you can edit multiple Permissions at the same time.
//
usergroup_edit_permissions_v1_response_t* ObjectUsergroupAPI_usergroupEditPermissionsV1(apiClient_t *apiClient, int *pkiUsergroupID, usergroup_edit_permissions_v1_request_t *usergroup_edit_permissions_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *
usergroup_edit_permissions_v1_request usergroup_edit_permissions_v1_request_t *

Return type

usergroup_edit_permissions_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupEditUsergroupdelegationsV1

// Edit multiple Usergroupdelegations
//
// Edit multiple Usergroupdelegations
//
usergroup_edit_usergroupdelegations_v1_response_t* ObjectUsergroupAPI_usergroupEditUsergroupdelegationsV1(apiClient_t *apiClient, int *pkiUsergroupID, usergroup_edit_usergroupdelegations_v1_request_t *usergroup_edit_usergroupdelegations_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *
usergroup_edit_usergroupdelegations_v1_request usergroup_edit_usergroupdelegations_v1_request_t *

Return type

usergroup_edit_usergroupdelegations_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupEditUsergroupmembershipsV1

// Edit multiple Usergroupmemberships
//
// Using this endpoint, you can edit multiple Usergroupmemberships at the same time.
//
usergroup_edit_usergroupmemberships_v1_response_t* ObjectUsergroupAPI_usergroupEditUsergroupmembershipsV1(apiClient_t *apiClient, int *pkiUsergroupID, usergroup_edit_usergroupmemberships_v1_request_t *usergroup_edit_usergroupmemberships_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *
usergroup_edit_usergroupmemberships_v1_request usergroup_edit_usergroupmemberships_v1_request_t *

Return type

usergroup_edit_usergroupmemberships_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupGetAutocompleteV2

// Retrieve Usergroups and IDs
//
// Get the list of Usergroup to be used in a dropdown or autocomplete control.
//
usergroup_get_autocomplete_v2_response_t* ObjectUsergroupAPI_usergroupGetAutocompleteV2(apiClient_t *apiClient, ezmax_api_definition__full_usergroupGetAutocompleteV2_sSelector_e sSelector, ezmax_api_definition__full_usergroupGetAutocompleteV2_eFilterActive_e eFilterActive, char *sQuery, header_accept_language_e Accept_Language);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
sSelector ezmax_api_definition__full_usergroupGetAutocompleteV2_sSelector_e The type of Usergroups to return
eFilterActive ezmax_api_definition__full_usergroupGetAutocompleteV2_eFilterActive_e Specify which results we want to display. [optional] [default to 'Active']
sQuery char * Allow to filter the returned results [optional]
Accept_Language header_accept_language_e [optional]

Return type

usergroup_get_autocomplete_v2_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupGetListV1

// Retrieve Usergroup list
//
// 
//
usergroup_get_list_v1_response_t* ObjectUsergroupAPI_usergroupGetListV1(apiClient_t *apiClient, ezmax_api_definition__full_usergroupGetListV1_eOrderBy_e eOrderBy, int *iRowMax, int *iRowOffset, header_accept_language_e Accept_Language, char *sFilter);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
eOrderBy ezmax_api_definition__full_usergroupGetListV1_eOrderBy_e Specify how you want the results to be sorted [optional]
iRowMax int * [optional]
iRowOffset int * [optional] [default to 0]
Accept_Language header_accept_language_e [optional]
sFilter char * [optional]

Return type

usergroup_get_list_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupGetObjectV2

// Retrieve an existing Usergroup
//
// 
//
usergroup_get_object_v2_response_t* ObjectUsergroupAPI_usergroupGetObjectV2(apiClient_t *apiClient, int *pkiUsergroupID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *

Return type

usergroup_get_object_v2_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupGetPermissionsV1

// Retrieve an existing Usergroup's Permissions
//
usergroup_get_permissions_v1_response_t* ObjectUsergroupAPI_usergroupGetPermissionsV1(apiClient_t *apiClient, int *pkiUsergroupID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *

Return type

usergroup_get_permissions_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupGetUsergroupdelegationsV1

// Retrieve an existing Usergroup's Usergroupdelegations
//
usergroup_get_usergroupdelegations_v1_response_t* ObjectUsergroupAPI_usergroupGetUsergroupdelegationsV1(apiClient_t *apiClient, int *pkiUsergroupID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *

Return type

usergroup_get_usergroupdelegations_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObjectUsergroupAPI_usergroupGetUsergroupmembershipsV1

// Retrieve an existing Usergroup's Usergroupmemberships
//
usergroup_get_usergroupmemberships_v1_response_t* ObjectUsergroupAPI_usergroupGetUsergroupmembershipsV1(apiClient_t *apiClient, int *pkiUsergroupID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiUsergroupID int *

Return type

usergroup_get_usergroupmemberships_v1_response_t *

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]