POST api/transmithealthsummary

Transmits the health summary to a recipient.

Request Information

URI Parameters

None.

Body Parameters

Model used to retrieve or set information about the health summary.

TransmitCdaModel
NameDescriptionTypeAdditional information
CdaId

Unique ID of the health summary.

globally unique identifier

None.

Recipients

Recipient (email addresses) of the health summary.

string

None.

Subject

Subject for transmiting the health summary.

string

None.

Message

Comments about transmit of health summary.

string

None.

Method

Method of transmission of the health summary. Possible values are EmailUnsecure, EmailSecure, DirectMessage.

string

None.

Password

Password to protect the health summary file.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CdaId": "e6c8f434-a6ad-4eb5-ae69-4f503bd0d730",
  "Recipients": "sample string 2",
  "Subject": "sample string 3",
  "Message": "sample string 4",
  "Method": "sample string 5",
  "Password": "sample string 6"
}

application/xml, text/xml

Sample:
<TransmitCdaModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthSummaries">
  <CdaId>e6c8f434-a6ad-4eb5-ae69-4f503bd0d730</CdaId>
  <Message>sample string 4</Message>
  <Method>sample string 5</Method>
  <Password>sample string 6</Password>
  <Recipients>sample string 2</Recipients>
  <Subject>sample string 3</Subject>
</TransmitCdaModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>