POST Api/Results/Put

This method allows a provider to add data results to the TouchPointCare repository. To post a result to TouchPointCare: (1) Authenticate and get a token as described in the "Getting Started" section of this guide. (2) Post the results data in the JSON or XML format described below. The provider_unique_id OR mobilehelp_device_id is required in order to find a matching participant in TouchPointCare. These IDs must be assigned on the participant profile in TouchPointCare or you will receive an error message. See the list of error numbers below.

Request Information

URI Parameters

None.

Body Parameters

A result object that contains the following data: provider_unique_id - mobilehelp_device_id - question_id - question_type - result_value - result_date -

Result

Name	Description	Type	Additional information
provider_unique_id	The unique id associated with the participant as assigned by the provider's back-end systems. The provider_unique_id OR mobilehelp_device_id is required.	string	None.
mobilehelp_device_id	The MobileHelp Device ID assigned to the participant.	string	None.
schedule_id	The unique id associated with TouchPoint instance. When posting a result using a question_id, the schedule_id is required unless the question_id corresponds to a vital sign/special type question (weight, blood pressure, oxygen saturation, etc.).	integer	None.
question_id	The unique id associated with question as assigned by TouchPointCare. Either question_id OR question_type is required.	integer	None.
question_type	The type of question when importing vitals using the following format: weight - weight scale results bgm - blood glucose measurement, bgmq - blood glucose qualifier (beore breakfast, after dinner, etc) bpm - heart rate (beats per minute) diastolic - blood pressure diastolic systolic - blood pressure systolic motion - motion sensor trigger oxysat - Pulse Oxygen saturation pulseox - oxygen saturation, heart rate (bpm), and irregular heartbeat indicator in one single call. Format the result value as "SpO2=999,bpm=999,irreg=true\|yes\|1". Any of the 3 parts are optional so you could leave off the irregular heartbeat and/or bpm if desired. bloodpressure - blood pressure systolic, diastolic, heart rate (bpm), and irregular heartbeat indicator in one single call. Format the result value as "systolic=999,diastolic=999,bpm=999,irreg=true\|yes\|1". Any of the 4 parts are optional so you could leave off the irregular heartbeat and/or bpm if desired. temp - Temperature rr - Respiratory Rate Spirometry - Spirometry / FEV1 literflow - Liter Flow / PEF a1c - A1C reading irreg - Irregular Heartbeat indicator. The result_value for irregular heartbeat should be formatted as either "true", "yes", or "1" to indicate an irregular heartbeat was detected	string	None.
result_value	The numeric value/result of the data. Do not inlude the units (i.e. for a 150 lb weight reading, the result_value should only display 150).	string	Required
result_date	The date/time of the result. Value should be in coordinated Universal Time (UTC) in the following format: YYYY-MM-DD HH:MM:DD:SS	date	Required
reading_input_type	The type of reading gathered. Possible Values: Manual: DEFAULT - The reading was manually entered or communicated from the participant. Device: Readings was imported directly from a device such as a bluetooth enabled blood pressure, weight scale, etc. Clinician: Reading was taken directly from a reliable device and oversaw directly by a clinician.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "provider_unique_id": "sample string 1",
  "mobilehelp_device_id": "sample string 2",
  "schedule_id": 1,
  "question_id": 1,
  "question_type": "sample string 3",
  "result_value": "sample string 4",
  "result_date": "2025-06-14T23:12:28.5126991-05:00",
  "reading_input_type": "sample string 6"
}

application/xml, text/xml

Sample:

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <mobilehelp_device_id>sample string 2</mobilehelp_device_id>
  <provider_unique_id>sample string 1</provider_unique_id>
  <question_id>1</question_id>
  <question_type>sample string 3</question_type>
  <reading_input_type>sample string 6</reading_input_type>
  <result_date>2025-06-14T23:12:28.5126991-05:00</result_date>
  <result_value>sample string 4</result_value>
  <schedule_id>1</schedule_id>
</Result>

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

Response Information

Resource Description

A TPCResponse object. Below is a list of possible error_codes returned: <para> </para> 901 - Provider Unique ID does not exist. <para> </para> 902 - Provider Unique ID matches more than 1 participant.Provider Unique ID must be unique regardless of active/inactive as well as across any child provider accounts. <para> </para> 903 - Question ID is not a valid question. <para> </para> 904 - The question_type does not match a valid type. Check the documentation for valid question type codes. <para> </para> 905 - Your account is not properly setup to accept API vital signs of this type.Contact the TouchPointCare. <para> </para> 906 - When adding results by question type, it is required to provide either the provider_unique_id OR mobilehelp_device_id. Please supply a unique id to look up the participant. <para> </para> 907 - No participant found to match the MobileHelp Device ID. <para> </para> 908 - MobileHelp Device ID matches more than 1 participant.MobileHelp Device ID must be unique regardless of active/inactive as well as across any child provider accounts. <para> </para> 909 - Schedule ID does not match a valid scheduled TouchPoint instance. <para> </para> 910 - The value in result_value is not valid based upon the question response type. <para> </para> 100 - (this code is used for unexpected or unknown errors).

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>