POST api/ExternalHealthInformationLinksSent

Flags an external health information link as sent to the integrating system.

Request Information

URI Parameters

None.

Body Parameters

Model used to set an external health information link as sent to the integrating system.

ExternalHealthInformationLinksMarkAsReceivedModel
NameDescriptionTypeAdditional information
PatientId

Internal ID of patient which link will be marked as received (Required).

 globally unique identifier

None.
Success

Success.

 boolean

None.
ResultMessage

Result message.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "patientId": "ab9b6b47-5bcf-4c7d-905a-be2736b68d11",
  "success": true,
  "resultMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<ExternalHealthInformationLinksMarkAsReceivedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.ExternalHealthInformationLinksSent">
  <PatientId>ab9b6b47-5bcf-4c7d-905a-be2736b68d11</PatientId>
  <ResultMessage>sample string 3</ResultMessage>
  <Success>true</Success>
</ExternalHealthInformationLinksMarkAsReceivedModel>

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

Response Information

Resource Description

ExternalHealthInformationLinksMarkAsReceivedModel
NameDescriptionTypeAdditional information
PatientId

Internal ID of patient which link will be marked as received (Required).

 globally unique identifier

None.
Success

Success.

 boolean

None.
ResultMessage

Result message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "patientId": "c5d72a77-9f71-443a-944a-e371a47eed1c",
  "success": true,
  "resultMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<ExternalHealthInformationLinksMarkAsReceivedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.ExternalHealthInformationLinksSent">
  <PatientId>c5d72a77-9f71-443a-944a-e371a47eed1c</PatientId>
  <ResultMessage>sample string 3</ResultMessage>
  <Success>true</Success>
</ExternalHealthInformationLinksMarkAsReceivedModel>