POST Api/ParticipantDevice

This method allows a provider to assign a device to a participant.

Request Information

URI Parameters

None.

Body Parameters

ParticipantDeviceAssignment
NameDescriptionTypeAdditional information
alert_id

The unique id of the participant as assigned by TouchPointCare

 integer

None.
device_type

The type of vital using the following format:

  • anelto - Used to assign an Anelto device id to the participant
  • mobilehelp - Used to assign a MobileHelp device id to the participant

 string

None.
device_id

The lower bounds of the alert threshold. Results above this value are valid.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "alert_id": 1,
  "device_type": "sample string 2",
  "device_id": "sample string 3"
}

application/xml, text/xml

Sample: 
<ParticipantDeviceAssignment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <alert_id>1</alert_id>
  <device_id>sample string 3</device_id>
  <device_type>sample string 2</device_type>
</ParticipantDeviceAssignment>

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 'ParticipantDeviceAssignment'.

Response Information

Resource Description

TPCResponse
NameDescriptionTypeAdditional 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>