POST api/CommunicationUpdatesSent

Flags an communication update as sent to the integrating system.

Request Information

URI Parameters

None.

Body Parameters

Model used to set a patient communication as received.

MarkAsReceivedModel
NameDescriptionTypeAdditional information
InternalID

ID of object to 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: 
{
  "internalID": "dc719580-00b2-4ee2-9f80-e2b1f9c01399",
  "success": true,
  "resultMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<MarkAsReceivedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MarkAsReceived">
  <InternalID>dc719580-00b2-4ee2-9f80-e2b1f9c01399</InternalID>
  <ResultMessage>sample string 3</ResultMessage>
  <Success>true</Success>
</MarkAsReceivedModel>

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

Response Information

Resource Description

MarkAsReceivedModel
NameDescriptionTypeAdditional information
InternalID

ID of object to 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: 
{
  "internalID": "77737a7d-6b25-494f-b632-82d5d74509af",
  "success": true,
  "resultMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<MarkAsReceivedModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.MarkAsReceived">
  <InternalID>77737a7d-6b25-494f-b632-82d5d74509af</InternalID>
  <ResultMessage>sample string 3</ResultMessage>
  <Success>true</Success>
</MarkAsReceivedModel>