POST api/letters/feedback
Finish the letter proccess for the actions linked to the Communication Id
Request Information
URI Parameters
None.
Body Parameters
CommunicationCallbackViewModel
CommunicationFeedbackViewModelName | Description | Type | Additional information |
---|---|---|---|
CommunicationId |
Communication Id |
integer |
Required |
StatusCode |
Communication Status |
HttpStatusCode |
None. |
Recipients |
List of recipiens ids |
Collection of FakeRecipientViewModel |
None. |
Message |
Message for the logs |
string |
None. |
CallbackHeaders |
|
Dictionary of string [key] and string [value] |
None. |
Request Formats
application/json, text/json
Sample:
{ "communicationId": 1, "statusCode": 100, "recipients": [ { "recipientId": "sample string 1", "statusCode": 100, "message": "sample string 2" }, { "recipientId": "sample string 1", "statusCode": 100, "message": "sample string 2" } ], "message": "sample string 2", "callbackHeaders": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }
application/xml, text/xml
Sample:
<CommunicationFeedbackViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections.Communication"> <CallbackHeaders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> </CallbackHeaders> <CommunicationId>1</CommunicationId> <Message>sample string 2</Message> <Recipients> <FakeRecipientViewModel> <Message>sample string 2</Message> <RecipientId>sample string 1</RecipientId> <StatusCode>Continue</StatusCode> </FakeRecipientViewModel> <FakeRecipientViewModel> <Message>sample string 2</Message> <RecipientId>sample string 1</RecipientId> <StatusCode>Continue</StatusCode> </FakeRecipientViewModel> </Recipients> <StatusCode>Continue</StatusCode> </CommunicationFeedbackViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.