wallet.SystemApi

All URIs are relative to https://api.wall.et

Method	HTTP request	Description
create_role	POST /v2/system/roles	Create role
delete_role	DELETE /v2/system/roles/{roleID}	Delete role
fetch_audit_log_of_roles	GET /v2/system/roles/auditLog	Fetch role's audit log
fetch_employees_with_role	GET /v2/system/roles/employees/{roleID}	Fetch employees with role
fetch_webpages_for_role	GET /v2/system/roles/webpages/{roleID}	Fetch webpages for role
get_payment_prefixes	GET /v2/system/prefixes	Get payment prefixes
load_role	GET /v2/system/roles/{roleID}	Fetch role
save_role	PUT /v2/system/roles/{roleID}	Update role

create_role

Role create_role(wt_system_role_create)

Create role

Example

import wallet
from wallet.models.role import Role
from wallet.models.wt_system_role_create import WTSystemRoleCreate
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    wt_system_role_create = wallet.WTSystemRoleCreate() # WTSystemRoleCreate | 

    try:
        # Create role
        api_response = api_instance.create_role(wt_system_role_create)
        print("The response of SystemApi->create_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->create_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
wt_system_role_create	WTSystemRoleCreate

Return type

Role

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

delete_role

bool delete_role(role_id)

Delete role

Example

import wallet
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    role_id = 'role_id_example' # str | 

    try:
        # Delete role
        api_response = api_instance.delete_role(role_id)
        print("The response of SystemApi->delete_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->delete_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	str

Return type

bool

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

fetch_audit_log_of_roles

List[RoleAuditLog] fetch_audit_log_of_roles(start_date_time, end_date_time)

Fetch role's audit log

Example

import wallet
from wallet.models.role_audit_log import RoleAuditLog
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    start_date_time = '2013-10-20T19:20:30+01:00' # datetime | 
    end_date_time = '2013-10-20T19:20:30+01:00' # datetime | 

    try:
        # Fetch role's audit log
        api_response = api_instance.fetch_audit_log_of_roles(start_date_time, end_date_time)
        print("The response of SystemApi->fetch_audit_log_of_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->fetch_audit_log_of_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_date_time	datetime
end_date_time	datetime

Return type

List[RoleAuditLog]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

fetch_employees_with_role

List[Employee] fetch_employees_with_role(role_id)

Fetch employees with role

Example

import wallet
from wallet.models.employee import Employee
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    role_id = 'role_id_example' # str | 

    try:
        # Fetch employees with role
        api_response = api_instance.fetch_employees_with_role(role_id)
        print("The response of SystemApi->fetch_employees_with_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->fetch_employees_with_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	str

Return type

List[Employee]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

fetch_webpages_for_role

List[Webpage] fetch_webpages_for_role(role_id)

Fetch webpages for role

Example

import wallet
from wallet.models.webpage import Webpage
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    role_id = 'role_id_example' # str | 

    try:
        # Fetch webpages for role
        api_response = api_instance.fetch_webpages_for_role(role_id)
        print("The response of SystemApi->fetch_webpages_for_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->fetch_webpages_for_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	str

Return type

List[Webpage]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

get_payment_prefixes

List[object] get_payment_prefixes()

Get payment prefixes

Example

import wallet
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)

    try:
        # Get payment prefixes
        api_response = api_instance.get_payment_prefixes()
        print("The response of SystemApi->get_payment_prefixes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_payment_prefixes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[object]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

load_role

WTRole load_role(role_id)

Fetch role

Example

import wallet
from wallet.models.wt_role import WTRole
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    role_id = 'role_id_example' # str | 

    try:
        # Fetch role
        api_response = api_instance.load_role(role_id)
        print("The response of SystemApi->load_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->load_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	str

Return type

WTRole

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

save_role

Role save_role(role_id, wt_system_role_create)

Update role

Example

import wallet
from wallet.models.role import Role
from wallet.models.wt_system_role_create import WTSystemRoleCreate
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.SystemApi(api_client)
    role_id = 'role_id_example' # str | 
    wt_system_role_create = wallet.WTSystemRoleCreate() # WTSystemRoleCreate | 

    try:
        # Update role
        api_response = api_instance.save_role(role_id, wt_system_role_create)
        print("The response of SystemApi->save_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->save_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	str
wt_system_role_create	WTSystemRoleCreate

Return type

Role

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Ok	-
401	Authentication Failed	-
422	Validation Failed	-
500	Internal Server Error	-

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

FilesExpand file tree

SystemApi.md

Latest commit

History

SystemApi.md

File metadata and controls

wallet.SystemApi

create_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_audit_log_of_roles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_employees_with_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_webpages_for_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_payment_prefixes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

load_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

save_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details