POST Api/ParticipantInterface/Put

This method allows a provider to insert or update an existing participant record using the Alert ID (unique id assigned by TPC) or the Participant ID (unique id assigned by the provider). You can also add the participant to groups subsequently kicking off any associated TouchPoints.

Request Information

URI Parameters

None.

Body Parameters

Participant Data.

Collection of InterfaceParticipant

Name	Description	Type	Additional information
alert_id	Gets or sets optional - The id of the participant as assigned by TouchPointCare.	integer	None.
account_name	Gets or sets Account Name.	string	None.
participant_unique_id	Gets or sets Participant Unique Id.	string	None.
first_name	Gets or sets First Name.	string	None.
last_name	Gets or sets Last Name.	string	None.
phone_number	Gets or sets Phone Number.	string	None.
case_manager_first_name	Gets or sets Case Manager First Name.	string	None.
case_manager_last_name	Gets or sets Case Manager Last Name.	string	None.
grouping	Gets or sets Grouping.	InterfaceGrouping	None.
instance	Gets or sets Instance.	Object	None.
email_address	Gets or sets Email Address.	string	None.
date_of_birth	Gets or sets Date of Birth.	string	None.
end_date	Gets or sets End Date.	string	None.
address_1	Gets or sets Address 1.	string	None.
address_2	Gets or sets Address 2.	string	None.
city	Gets or sets City.	string	None.
state	Gets or sets State.	string	None.
zip	Gets or sets Zip.	string	None.
insurance_carrier	Gets or sets Insurance Carrier.	string	None.
policy_number	Gets or sets Policy Number.	string	None.
custom_1	Gets or sets Custom 1.	string	None.
custom_2	Gets or sets Custom 2.	string	None.
custom_3	Gets or sets Custom 3.	string	None.
custom_4	Gets or sets Custom 4.	string	None.
dr_first_name	Gets or sets Dr First Name.	string	None.
dr_last_name	Gets or sets Dr Last Name.	string	None.
dr_middle_name	Gets or sets Dr Middle Name.	string	None.
dr_address_1	Gets or sets Dr Address 1.	string	None.
dr_address_2	Gets or sets Dr Address 2.	string	None.
dr_city	Gets or sets Dr City.	string	None.
dr_state	Gets or sets Dr State.	string	None.
dr_zip	Gets or sets Dr Zip.	string	None.
dr_phone	Gets or sets Dr Phone.	string	None.
active	Gets or sets Active.	boolean	None.
custom_xml	Gets or sets Custom XML.	string	None.
cancel	Gets or sets Cancel.	string	None.
event_date	Gets or sets Event Date.	string	None.
mobile_phone	Gets or sets Mobile Phone.	string	None.
encounter_id	Gets or sets Encounter Id.	string	None.
encounter_date	Gets or sets Encounter Date.	string	None.
gender	Gets or sets Gender.	string	None.
dr_fax	Gets or sets Dr Fax.	string	None.
division_name	Gets or sets Division Name.	string	None.
marital_status	Gets or sets Marital Status.	string	None.
emergency_contact	Gets or sets Emergency Contact.	string	None.
emergency_contact_relationship	Gets or sets Emergency Contact Relationship.	string	None.
emergency_contact_phone	Gets or sets Emergency Contact Phone.	string	None.
is_suspended	Gets or sets Is Suspended.	boolean	None.
priority_score	Gets or sets Priority Score.	decimal number	None.
primary_diagnosis_code	Gets or sets Primary Diagnosis Code.	string	None.
participant_contacts	Gets or sets a collection of participant contact records. Typically used to assign secondary physicians to a participant.	Collection of InterfaceParticipantContact	None.
start_of_care_date	Gets or sets Start of Care Date.	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "alert_id": 1,
    "account_name": "sample string 1",
    "participant_unique_id": "sample string 2",
    "first_name": "sample string 3",
    "last_name": "sample string 4",
    "phone_number": "sample string 5",
    "case_manager_first_name": "sample string 6",
    "case_manager_last_name": "sample string 7",
    "grouping": {
      "code": "sample string 1",
      "type": "sample string 2",
      "readmitted": "sample string 3"
    },
    "instance": {},
    "email_address": "sample string 9",
    "date_of_birth": "sample string 10",
    "end_date": "sample string 11",
    "address_1": "sample string 12",
    "address_2": "sample string 13",
    "city": "sample string 14",
    "state": "sample string 15",
    "zip": "sample string 16",
    "insurance_carrier": "sample string 17",
    "policy_number": "sample string 18",
    "custom_1": "sample string 19",
    "custom_2": "sample string 20",
    "custom_3": "sample string 21",
    "custom_4": "sample string 22",
    "dr_first_name": "sample string 23",
    "dr_last_name": "sample string 24",
    "dr_middle_name": "sample string 25",
    "dr_address_1": "sample string 26",
    "dr_address_2": "sample string 27",
    "dr_city": "sample string 28",
    "dr_state": "sample string 29",
    "dr_zip": "sample string 30",
    "dr_phone": "sample string 31",
    "active": true,
    "custom_xml": "sample string 32",
    "cancel": "sample string 33",
    "event_date": "sample string 34",
    "mobile_phone": "sample string 35",
    "encounter_id": "sample string 36",
    "encounter_date": "sample string 37",
    "gender": "sample string 38",
    "dr_fax": "sample string 39",
    "division_name": "sample string 40",
    "marital_status": "sample string 41",
    "emergency_contact": "sample string 42",
    "emergency_contact_relationship": "sample string 43",
    "emergency_contact_phone": "sample string 44",
    "is_suspended": true,
    "priority_score": 1.0,
    "primary_diagnosis_code": "sample string 45",
    "participant_contacts": null,
    "start_of_care_date": "sample string 46"
  },
  {
    "alert_id": 1,
    "account_name": "sample string 1",
    "participant_unique_id": "sample string 2",
    "first_name": "sample string 3",
    "last_name": "sample string 4",
    "phone_number": "sample string 5",
    "case_manager_first_name": "sample string 6",
    "case_manager_last_name": "sample string 7",
    "grouping": {
      "code": "sample string 1",
      "type": "sample string 2",
      "readmitted": "sample string 3"
    },
    "instance": {},
    "email_address": "sample string 9",
    "date_of_birth": "sample string 10",
    "end_date": "sample string 11",
    "address_1": "sample string 12",
    "address_2": "sample string 13",
    "city": "sample string 14",
    "state": "sample string 15",
    "zip": "sample string 16",
    "insurance_carrier": "sample string 17",
    "policy_number": "sample string 18",
    "custom_1": "sample string 19",
    "custom_2": "sample string 20",
    "custom_3": "sample string 21",
    "custom_4": "sample string 22",
    "dr_first_name": "sample string 23",
    "dr_last_name": "sample string 24",
    "dr_middle_name": "sample string 25",
    "dr_address_1": "sample string 26",
    "dr_address_2": "sample string 27",
    "dr_city": "sample string 28",
    "dr_state": "sample string 29",
    "dr_zip": "sample string 30",
    "dr_phone": "sample string 31",
    "active": true,
    "custom_xml": "sample string 32",
    "cancel": "sample string 33",
    "event_date": "sample string 34",
    "mobile_phone": "sample string 35",
    "encounter_id": "sample string 36",
    "encounter_date": "sample string 37",
    "gender": "sample string 38",
    "dr_fax": "sample string 39",
    "division_name": "sample string 40",
    "marital_status": "sample string 41",
    "emergency_contact": "sample string 42",
    "emergency_contact_relationship": "sample string 43",
    "emergency_contact_phone": "sample string 44",
    "is_suspended": true,
    "priority_score": 1.0,
    "primary_diagnosis_code": "sample string 45",
    "participant_contacts": null,
    "start_of_care_date": "sample string 46"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInterfaceParticipant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.Core">
  <InterfaceParticipant>
    <AccountName>sample string 1</AccountName>
    <Active>true</Active>
    <Address1>sample string 12</Address1>
    <Address2>sample string 13</Address2>
    <AlertId>1</AlertId>
    <Cancel>sample string 33</Cancel>
    <CaseManagerFirstName>sample string 6</CaseManagerFirstName>
    <CaseManagerLastName>sample string 7</CaseManagerLastName>
    <City>sample string 14</City>
    <Custom1>sample string 19</Custom1>
    <Custom2>sample string 20</Custom2>
    <Custom3>sample string 21</Custom3>
    <Custom4>sample string 22</Custom4>
    <CustomXml>sample string 32</CustomXml>
    <DateOfBirth>sample string 10</DateOfBirth>
    <DivisionName>sample string 40</DivisionName>
    <DrAddress1>sample string 26</DrAddress1>
    <DrAddress2>sample string 27</DrAddress2>
    <DrCity>sample string 28</DrCity>
    <DrFax>sample string 39</DrFax>
    <DrFirstName>sample string 23</DrFirstName>
    <DrLastName>sample string 24</DrLastName>
    <DrMiddleName>sample string 25</DrMiddleName>
    <DrPhone>sample string 31</DrPhone>
    <DrState>sample string 29</DrState>
    <DrZip>sample string 30</DrZip>
    <EmailAddress>sample string 9</EmailAddress>
    <EmergencyContact>sample string 42</EmergencyContact>
    <EmergencyContactPhone>sample string 44</EmergencyContactPhone>
    <EmergencyContactRelationship>sample string 43</EmergencyContactRelationship>
    <EncounterDate>sample string 37</EncounterDate>
    <EncounterId>sample string 36</EncounterId>
    <EndDate>sample string 11</EndDate>
    <EventDate>sample string 34</EventDate>
    <FirstName>sample string 3</FirstName>
    <Gender>sample string 38</Gender>
    <Grouping>
      <code>sample string 1</code>
      <readmitted>sample string 3</readmitted>
      <type>sample string 2</type>
    </Grouping>
    <Instance />
    <InsuranceCarrier>sample string 17</InsuranceCarrier>
    <IsSuspended>true</IsSuspended>
    <LastName>sample string 4</LastName>
    <MaritalStatus>sample string 41</MaritalStatus>
    <MobilePhone>sample string 35</MobilePhone>
    <ParticipantContacts i:nil="true" />
    <ParticipantUniqueId>sample string 2</ParticipantUniqueId>
    <PhoneNumber>sample string 5</PhoneNumber>
    <PolicyNumber>sample string 18</PolicyNumber>
    <PrimaryDiagnosisCode>sample string 45</PrimaryDiagnosisCode>
    <PriorityScore>1</PriorityScore>
    <StartOfCareDate>sample string 46</StartOfCareDate>
    <State>sample string 15</State>
    <Zip>sample string 16</Zip>
  </InterfaceParticipant>
  <InterfaceParticipant>
    <AccountName>sample string 1</AccountName>
    <Active>true</Active>
    <Address1>sample string 12</Address1>
    <Address2>sample string 13</Address2>
    <AlertId>1</AlertId>
    <Cancel>sample string 33</Cancel>
    <CaseManagerFirstName>sample string 6</CaseManagerFirstName>
    <CaseManagerLastName>sample string 7</CaseManagerLastName>
    <City>sample string 14</City>
    <Custom1>sample string 19</Custom1>
    <Custom2>sample string 20</Custom2>
    <Custom3>sample string 21</Custom3>
    <Custom4>sample string 22</Custom4>
    <CustomXml>sample string 32</CustomXml>
    <DateOfBirth>sample string 10</DateOfBirth>
    <DivisionName>sample string 40</DivisionName>
    <DrAddress1>sample string 26</DrAddress1>
    <DrAddress2>sample string 27</DrAddress2>
    <DrCity>sample string 28</DrCity>
    <DrFax>sample string 39</DrFax>
    <DrFirstName>sample string 23</DrFirstName>
    <DrLastName>sample string 24</DrLastName>
    <DrMiddleName>sample string 25</DrMiddleName>
    <DrPhone>sample string 31</DrPhone>
    <DrState>sample string 29</DrState>
    <DrZip>sample string 30</DrZip>
    <EmailAddress>sample string 9</EmailAddress>
    <EmergencyContact>sample string 42</EmergencyContact>
    <EmergencyContactPhone>sample string 44</EmergencyContactPhone>
    <EmergencyContactRelationship>sample string 43</EmergencyContactRelationship>
    <EncounterDate>sample string 37</EncounterDate>
    <EncounterId>sample string 36</EncounterId>
    <EndDate>sample string 11</EndDate>
    <EventDate>sample string 34</EventDate>
    <FirstName>sample string 3</FirstName>
    <Gender>sample string 38</Gender>
    <Grouping>
      <code>sample string 1</code>
      <readmitted>sample string 3</readmitted>
      <type>sample string 2</type>
    </Grouping>
    <Instance />
    <InsuranceCarrier>sample string 17</InsuranceCarrier>
    <IsSuspended>true</IsSuspended>
    <LastName>sample string 4</LastName>
    <MaritalStatus>sample string 41</MaritalStatus>
    <MobilePhone>sample string 35</MobilePhone>
    <ParticipantContacts i:nil="true" />
    <ParticipantUniqueId>sample string 2</ParticipantUniqueId>
    <PhoneNumber>sample string 5</PhoneNumber>
    <PolicyNumber>sample string 18</PolicyNumber>
    <PrimaryDiagnosisCode>sample string 45</PrimaryDiagnosisCode>
    <PriorityScore>1</PriorityScore>
    <StartOfCareDate>sample string 46</StartOfCareDate>
    <State>sample string 15</State>
    <Zip>sample string 16</Zip>
  </InterfaceParticipant>
</ArrayOfInterfaceParticipant>

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 'List`1'.

Response Information

Resource Description

List of Interface Participants.

InterfaceResponse

Name	Type	Additional information
result	string	None.
error_code	integer	None.
message	string	None.
results	Collection of InterfaceParticipantResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1",
  "error_code": 1,
  "message": "sample string 2",
  "results": [
    {
      "result": "sample string 1",
      "error_code": 1,
      "message": "sample string 2",
      "alert_id": 1,
      "participant_unique_id": "sample string 3"
    },
    {
      "result": "sample string 1",
      "error_code": 1,
      "message": "sample string 2",
      "alert_id": 1,
      "participant_unique_id": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<InterfaceResponse 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>
  <results>
    <InterfaceParticipantResponse>
      <alert_id>1</alert_id>
      <error_code>1</error_code>
      <message>sample string 2</message>
      <participant_unique_id>sample string 3</participant_unique_id>
      <result>sample string 1</result>
    </InterfaceParticipantResponse>
    <InterfaceParticipantResponse>
      <alert_id>1</alert_id>
      <error_code>1</error_code>
      <message>sample string 2</message>
      <participant_unique_id>sample string 3</participant_unique_id>
      <result>sample string 1</result>
    </InterfaceParticipantResponse>
  </results>
</InterfaceResponse>