POST Api/ParticipantGroup/ChangeGroup

This api method will add or remove a participant from a group.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
alert_id	The ID of the participant as assigned by TouchPointCare. The alert_id OR the participant_id is required to identity the participant.	integer	None.
participant_id	The ID of the participant as assigned by the Provider/Client. The alert_id OR the participant_id is required to identity the participant.	string	None.
grouping_code	The grouping code assigned to one or more groups on TouchPointCare.net.	string	None.
is_add_to_group	Optional - true if adding to a group, false if remove from group. Default: true	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "alert_id": 1,
  "participant_id": "sample string 1",
  "grouping_code": "sample string 2",
  "is_add_to_group": true
}

application/xml, text/xml

Sample:

<ParticipantGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <alert_id>1</alert_id>
  <grouping_code>sample string 2</grouping_code>
  <is_add_to_group>true</is_add_to_group>
  <participant_id>sample string 1</participant_id>
</ParticipantGroup>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ParticipantGroup'.

Response Information

Resource Description

TPCResponse

Name	Type	Additional information
result	string	None.
error_code	integer	None.
message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1",
  "error_code": 1,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:

<TPCResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <error_code>1</error_code>
  <message>sample string 2</message>
  <result>sample string 1</result>
</TPCResponse>