GET PlanCare2Api/DynamicData/ChainMessageById?agb={agb}&id={id}&externalId={externalId}&externalInfo={externalInfo}
Gets a chainmessage based on the given parameters. Sets the given chainmessage as status = exported
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| agb |
The code of the supplier to retreive messages for |
string |
Required |
| id |
The identifier of the chain message to retreive |
integer |
Required |
| externalId |
The external identifier used by the third party system for the chain message. This is stored as part of the Plancare message |
string |
Required |
| externalInfo |
The external information used by the third party system for the chain message. This is stored as part of the Plancare message |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Displays a chain message
Collection of ChainMessageByIdResultNone.
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1"
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfDynamicDataController.ChainMessageByIdResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers"> <DynamicDataController.ChainMessageByIdResult /> <DynamicDataController.ChainMessageByIdResult /> </ArrayOfDynamicDataController.ChainMessageByIdResult>