Table of Contents

MemberApi

All URIs are relative to http://localhost

Method Description
get_member Gets information about the specified member in the connection.
get_members Gets information about all members in the connection.
set_bearing_member Set bearing member for memberIt
update_member Updates the member in the connection with the provided data.

get_member

ConMember get_member(project_id, connection_id, member_id)

Gets information about the specified member in the connection.

Parameters

Name Type Description Notes
project_id str The unique identifier of the opened project in the ConnectionRestApi service.
connection_id int The ID of the connection containing the member.
member_id int The ID of the requested member in the connection.

Return type

ConMember

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_member import ConMember
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

For client instantiation instructions, refer to the [README] documentation.

def get_memberExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | The ID of the connection containing the member.
    member_id = 56 # int | The ID of the requested member in the connection.

    try:
        # Gets information about the specified member in the connection.
        api_response = api_client.member.get_member(project_id, connection_id, member_id)
        print("The response of MemberApi->get_member:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling MemberApi->get_member: %s\n" % e)

Code Samples

Looking for a code sample? request some help on our discussion page.

REST Usage

Http Request

All URIs are relative to http://localhost

GET /api/3/projects/{projectId}/connections/{connectionId}/members/{memberId}

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

get_members

List[ConMember] get_members(project_id, connection_id)

Gets information about all members in the connection.

Parameters

Name Type Description Notes
project_id str The unique identifier of the opened project in the ConnectionRestApi service.
connection_id int The ID of the connection from which to retrieve members.

Return type

List[ConMember]

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_member import ConMember
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

For client instantiation instructions, refer to the [README] documentation.

def get_membersExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | The ID of the connection from which to retrieve members.

    try:
        # Gets information about all members in the connection.
        api_response = api_client.member.get_members(project_id, connection_id)
        print("The response of MemberApi->get_members:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling MemberApi->get_members: %s\n" % e)

Code Samples

Looking for a code sample? request some help on our discussion page.

REST Usage

Http Request

All URIs are relative to http://localhost

GET /api/3/projects/{projectId}/connections/{connectionId}/members

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

set_bearing_member

ConMember set_bearing_member(project_id, connection_id, member_id)

Set bearing member for memberIt

Parameters

Name Type Description Notes
project_id str
connection_id int
member_id int

Return type

ConMember

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_member import ConMember
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

For client instantiation instructions, refer to the [README] documentation.

def set_bearing_memberExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | 
    connection_id = 56 # int | 
    member_id = 56 # int | 

    try:
        # Set bearing member for memberIt
        api_response = api_client.member.set_bearing_member(project_id, connection_id, member_id)
        print("The response of MemberApi->set_bearing_member:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling MemberApi->set_bearing_member: %s\n" % e)

Code Samples

Looking for a code sample? request some help on our discussion page.

REST Usage

Http Request

All URIs are relative to http://localhost

PUT /api/3/projects/{projectId}/connections/{connectionId}/members/{memberId}/set-bearing-member

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

update_member

ConMember update_member(project_id, connection_id, con_member=con_member)

Updates the member in the connection with the provided data.

Parameters

Name Type Description Notes
project_id str The unique identifier of the opened project in the ConnectionRestApi service.
connection_id int The ID of the connection containing the member to update.
con_member ConMember The new member data to apply. [optional]

Return type

ConMember

Example

Required Imports

import ideastatica_connection_api
from ideastatica_connection_api.models.con_member import ConMember
from ideastatica_connection_api.rest import ApiException
from pprint import pprint

For client instantiation instructions, refer to the [README] documentation.

def update_memberExampleFunc(api_client):
    
    project_id = 'project_id_example' # str | The unique identifier of the opened project in the ConnectionRestApi service.
    connection_id = 56 # int | The ID of the connection containing the member to update.
    con_member = ideastatica_connection_api.ConMember() # ConMember | The new member data to apply. (optional)

    try:
        # Updates the member in the connection with the provided data.
        api_response = api_client.member.update_member(project_id, connection_id, con_member=con_member)
        print("The response of MemberApi->update_member:\n")
        pprint(api_response)
        return api_response
    except Exception as e:
        print("Exception when calling MemberApi->update_member: %s\n" % e)

Code Samples

Looking for a code sample? request some help on our discussion page.

REST Usage

Http Request

All URIs are relative to http://localhost

PUT /api/3/projects/{projectId}/connections/{connectionId}/members

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

Edit this page