Clients (risksense_api.__subject.__clients.__clients)

**Clients module defined for different clients related api endpoints.**

class risksense_api.__subject.__clients.__clients.Clients(profile)[source]

Bases: Subject

Class for Clients function defintions.

To utlise clients function:

Parameters:

profile (object) – Profile Object

Usage:

self.{risksenseobjectname}.clients.{function}

Examples

To get subjects using get_subject() function

>>> self.{risksenseobject}.clients.get_subjects()
__init__(profile)[source]

Initialization of Clients object.

Parameters:

profile (object) – Profile Object

get_clients(page_size=500, page_number=0)[source]

Gets all clients associated with the API key.

Parameters:

  • page_size (int) – Number of results to be returned on each page.

  • page_number (int) – The page number to be returned.

Return type:

dict

Returns:

The JSON response from the platform is returned.

Example

To use get_clients method

>>> self.{risksenseobject}.get_clients()
get_client_info(client_id=None)[source]

Gets the details for a specific client ID.

Parameters:

client_id (typing.Optional[int]) – Client ID

Return type:

dict

Returns:

The JSON response from the platform is returned.

Example

To get client info of 123

>>> self.{risksenseobject}.geT_client_info(123)
get_subjects(client_id=None)[source]

List out all of the available subjects for a specific client.

Parameters:

client_id (typing.Optional[int]) – Client ID

Return type:

list

Returns:

The JSON from the platform is returned.

Example

To try out get_subjects

>>> self.{risksenseobject}.get_subjects(1234)