# DotVisionMotionApiV2.ParticipantsApi

All URIs are relative to *http://dotvision-motion-webapi.azurewebsites.net*

Method | HTTP request | Description
------------- | ------------- | -------------
[**participantsAddTeammateToTeam**](ParticipantsApi.md#participantsAddTeammateToTeam) | **POST** /api/participants/{id}/teammates | Add a teammate to a team
[**participantsCountTeammates**](ParticipantsApi.md#participantsCountTeammates) | **GET** /api/participants/{id}/teammates/count | Get teammates count for a team
[**participantsGetAllActivities**](ParticipantsApi.md#participantsGetAllActivities) | **GET** /api/participants/{id}/activities | Get all activities for a participant
[**participantsGetAllCategories**](ParticipantsApi.md#participantsGetAllCategories) | **GET** /api/participants/{id}/categories | Get all categories for a participant
[**participantsGetAllTeammates**](ParticipantsApi.md#participantsGetAllTeammates) | **GET** /api/participants/{id}/teammates | Get all teammates for a team
[**participantsGetAssociatedUser**](ParticipantsApi.md#participantsGetAssociatedUser) | **GET** /api/participants/{id}/associatedUser | Get the user associated with participant
[**participantsGetCategoriesCountForParticipant**](ParticipantsApi.md#participantsGetCategoriesCountForParticipant) | **GET** /api/participants/{id}/categories/count | Get number of categories for a participant
[**participantsGetParticipant**](ParticipantsApi.md#participantsGetParticipant) | **GET** /api/participants/{id} | Get a participant
[**participantsGetRoleForTeammate**](ParticipantsApi.md#participantsGetRoleForTeammate) | **GET** /api/participants/{id}/teammates/{participantId}/teamRole | Get role for a teammate
[**participantsGetTeammate**](ParticipantsApi.md#participantsGetTeammate) | **GET** /api/participants/{id}/teammates/{participantId} | Get a teammate of a team
[**participantsLinkCategory**](ParticipantsApi.md#participantsLinkCategory) | **POST** /api/participants/{id}/categories | Link a category to a participant
[**participantsRemoveTeammateFromTeam**](ParticipantsApi.md#participantsRemoveTeammateFromTeam) | **DELETE** /api/participants/{id}/teammates/{participantId} | Delete a teammate
[**participantsUnlinkCategory**](ParticipantsApi.md#participantsUnlinkCategory) | **DELETE** /api/participants/{id}/categories | Unlink a category from a participant
[**participantsUpdateTeammate**](ParticipantsApi.md#participantsUpdateTeammate) | **PUT** /api/participants/{id}/teammates | Update a teammate


<a name="participantsAddTeammateToTeam"></a>
# **participantsAddTeammateToTeam**
> TeammateModel participantsAddTeammateToTeam(id, participantId, roleId, friendlyRoleName)

Add a teammate to a team

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)

var participantId = 789; // {Integer} Participant id

var roleId = 789; // {Integer} Role id

var friendlyRoleName = "friendlyRoleName_example"; // {String} Friendly role name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsAddTeammateToTeam(id, participantId, roleId, friendlyRoleName, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 
 **participantId** | **Integer**| Participant id | 
 **roleId** | **Integer**| Role id | 
 **friendlyRoleName** | **String**| Friendly role name | 

### Return type

[**TeammateModel**](TeammateModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsCountTeammates"></a>
# **participantsCountTeammates**
> &#39;Integer&#39; participantsCountTeammates(id)

Get teammates count for a team

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsCountTeammates(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 

### Return type

**&#39;Integer&#39;**

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetAllActivities"></a>
# **participantsGetAllActivities**
> [ActivityModel] participantsGetAllActivities(id)

Get all activities for a participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetAllActivities(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant id | 

### Return type

[**[ActivityModel]**](ActivityModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetAllCategories"></a>
# **participantsGetAllCategories**
> [CategoryModel] participantsGetAllCategories(id)

Get all categories for a participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetAllCategories(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant id | 

### Return type

[**[CategoryModel]**](CategoryModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetAllTeammates"></a>
# **participantsGetAllTeammates**
> [TeammateModel] participantsGetAllTeammates(id)

Get all teammates for a team

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetAllTeammates(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 

### Return type

[**[TeammateModel]**](TeammateModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetAssociatedUser"></a>
# **participantsGetAssociatedUser**
> UserModel participantsGetAssociatedUser(id)

Get the user associated with participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetAssociatedUser(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant Id | 

### Return type

[**UserModel**](UserModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetCategoriesCountForParticipant"></a>
# **participantsGetCategoriesCountForParticipant**
> &#39;Integer&#39; participantsGetCategoriesCountForParticipant(id)

Get number of categories for a participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetCategoriesCountForParticipant(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant id | 

### Return type

**&#39;Integer&#39;**

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetParticipant"></a>
# **participantsGetParticipant**
> ParticipantModel participantsGetParticipant(id)

Get a participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetParticipant(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant Id | 

### Return type

[**ParticipantModel**](ParticipantModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetRoleForTeammate"></a>
# **participantsGetRoleForTeammate**
> TeamRoleModel participantsGetRoleForTeammate(id, participantId)

Get role for a teammate

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)

var participantId = 789; // {Integer} Participant id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetRoleForTeammate(id, participantId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 
 **participantId** | **Integer**| Participant id | 

### Return type

[**TeamRoleModel**](TeamRoleModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsGetTeammate"></a>
# **participantsGetTeammate**
> TeammateModel participantsGetTeammate(id, participantId)

Get a teammate of a team

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)

var participantId = 789; // {Integer} Participant id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsGetTeammate(id, participantId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 
 **participantId** | **Integer**| Participant id | 

### Return type

[**TeammateModel**](TeammateModel.md)

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsLinkCategory"></a>
# **participantsLinkCategory**
> &#39;Boolean&#39; participantsLinkCategory(id, categoryId)

Link a category to a participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant id

var categoryId = 789; // {Integer} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsLinkCategory(id, categoryId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant id | 
 **categoryId** | **Integer**|  | 

### Return type

**&#39;Boolean&#39;**

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsRemoveTeammateFromTeam"></a>
# **participantsRemoveTeammateFromTeam**
> &#39;Boolean&#39; participantsRemoveTeammateFromTeam(id, participantId)

Delete a teammate

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)

var participantId = 789; // {Integer} Participant id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsRemoveTeammateFromTeam(id, participantId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 
 **participantId** | **Integer**| Participant id | 

### Return type

**&#39;Boolean&#39;**

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsUnlinkCategory"></a>
# **participantsUnlinkCategory**
> &#39;Boolean&#39; participantsUnlinkCategory(id, categoryId)

Unlink a category from a participant

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Participant id

var categoryId = 789; // {Integer} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsUnlinkCategory(id, categoryId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Participant id | 
 **categoryId** | **Integer**|  | 

### Return type

**&#39;Boolean&#39;**

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml

<a name="participantsUpdateTeammate"></a>
# **participantsUpdateTeammate**
> &#39;Boolean&#39; participantsUpdateTeammate(id, participantId, roleId, friendlyRoleName)

Update a teammate

### Example
```javascript
var DotVisionMotionApiV2 = require('dot-vision-motion-api-v2');

var api = new DotVisionMotionApiV2.ParticipantsApi()

var id = 789; // {Integer} Team id (Participant \"team\" type)

var participantId = 789; // {Integer} Participant id

var roleId = 789; // {Integer} Role id

var friendlyRoleName = "friendlyRoleName_example"; // {String} Friendly role name


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.participantsUpdateTeammate(id, participantId, roleId, friendlyRoleName, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **Integer**| Team id (Participant \&quot;team\&quot; type) | 
 **participantId** | **Integer**| Participant id | 
 **roleId** | **Integer**| Role id | 
 **friendlyRoleName** | **String**| Friendly role name | 

### Return type

**&#39;Boolean&#39;**

### Authorization

No authorization required

### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, text/json, application/xml, text/xml