Creates and submits a new message.
URL
https://secure.healthx.com/api/MessagingV1/Thread/Start/[processid]
HTTP Method
POST
URL Parameters
- processid: The process ID, in GUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
Request Body Parameters
- data: A two-dimensional array with each item (row) in the array being an array containing the name and value.
- attachmentid: Optional. The attachment working ID, in GUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
Example XML Request
<ThreadStart>
<data xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:ArrayOfstring>
<a:string>FIELD1</a:string>
<a:string>FIELD1Value</a:string>
</a:ArrayOfstring>
<a:ArrayOfstring>
<a:string>FIELD2</a:string>
<a:string>FIELD2Value</a:string>
</a:ArrayOfstring>
<a:ArrayOfstring>
<a:string>FIELD3</a:string>
<a:string>FIELD3Value</a:string>
</a:ArrayOfstring>
</data>
<attachmentid></attachmentid>
</ThreadStart>
Example XML Response
<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AddDateTime>2016-01-01T08:30:22.507</AddDateTime>
<Attachments/>
<CancelledBySender>false</CancelledBySender>
<Data i:nil="true"/>
<DateRead i:nil="true"/>
<FormName/>
<NextTransaction i:nil="true"/>
<ObjectID>ad4d9c10-7527-4b37-917d-1bbff2438002
<ObjectType>ExR</ObjectType>
<PrevTransaction>5c85f090-7d76-49dc-9194-71e68d8127b6</PrevTransaction>
<ProcessStepID>96675cff-840e-4c04-b4c2-770b22015a38</ProcessStepID>
<Recipient>fffb4484-4a0a-4b32-bcd8-a5850c08b492</Recipient>
<RecipientType>User</RecipientType>
<Sender>ecc59677-8a5e-4c7b-b8e6-7195a0b2fabf</Sender>
<Status>Approved</Status>
<StatusMessage i:nil="true"/>
<TrackingID>10020</TrackingID>
<TransactionID>4d4165a4-1ca7-42ad-b8bf-fe920df08ffa</TransactionID>
</Transaction>
Example JSON Request
{
"data":[["FIELD1","FIELD1Value"],["FIELD2","FIELD2Value"],["FIELD3","FIELD3Value"]],
"attachmentid":null
}
Example JSON Response
{
"AddDateTime":"\/Date(1472046800000-0500)\/",
"Attachments":[],
"CancelledBySender":false,
"Data":null,
"DateRead":null,
"FormName":"",
"NextTransaction":null,
"ObjectID":"ad4d9c10-7527-4b37-917d-1bbff2438002
"ObjectType":0,
"PrevTransaction":"5c85f090-7d76-49dc-9194-71e68d8127b6",
"ProcessStepID":"96675cff-840e-4c04-b4c2-770b22015a38",
"Recipient":"fffb4484-4a0a-4b32-bcd8-a5850c08b492",
"RecipientType":0,
"Sender":"ecc59677-8a5e-4c7b-b8e6-7195a0b2fabf",
"Status":0,
"StatusMessage":null,
"TrackingID":10020,
"TransactionID":"4d4165a4-1ca7-42ad-b8bf-fe920df08ffa"
}
|
|
