CommunicationHub.API

SendLetter

The following routes are available for this service:
POST	/Letter/Send

**SendLetter** Parameters:
Name	Parameter	Data Type	Required
FileName	body	string	No
File	body	byte[]	No
TestFlag	body	bool	No
TestEMail	body	string	No
TestShowRestrictedArea	body	bool	No
BatchId	body	int	No
CoverLetter	body	bool	No
CoverFile	body	byte[]	No
IsColor	body	bool	No
IsDuplex	body	bool	No
AddressLine1	body	string	No
AddressLine2	body	string	No
AddressLine3	body	string	No
AddressLine4	body	string	No
AddressLine5	body	string	No
ZipCode	body	string	No
City	body	string	No
Country	body	string	No
SenderAdressLine1	body	string	No
SenderStreet	body	string	No
SenderZipCode	body	string	No
SenderCity	body	string	No
Reference	body	string	No

**SendResponse** Parameters:
Name	Parameter	Data Type	Required
MessageId	form	string	No
Sender	form	string	No
Receiver	form	string	No
Status	form	Status	No
ErrorMessage	form	string	No
Configuration	form	string	No
Retry	form	bool	No
RetryCount	form	int	No

**Status** Enum:
accepted
queued
sending
sent
failed
delivered
undelivered
receiving
received
read
pickedup
unknown

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Letter/Send HTTP/1.1 
Host: communicationhub.carelogic-cloud.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommunicationHub.APIModel">
  <AddressLine1>String</AddressLine1>
  <AddressLine2>String</AddressLine2>
  <AddressLine3>String</AddressLine3>
  <AddressLine4>String</AddressLine4>
  <AddressLine5>String</AddressLine5>
  <BatchId>0</BatchId>
  <City>String</City>
  <Country>String</Country>
  <CoverFile>AA==</CoverFile>
  <CoverLetter>false</CoverLetter>
  <File>AA==</File>
  <FileName>String</FileName>
  <IsColor>false</IsColor>
  <IsDuplex>false</IsDuplex>
  <Reference>String</Reference>
  <SenderAdressLine1>String</SenderAdressLine1>
  <SenderCity>String</SenderCity>
  <SenderStreet>String</SenderStreet>
  <SenderZipCode>String</SenderZipCode>
  <TestEMail>String</TestEMail>
  <TestFlag>false</TestFlag>
  <TestShowRestrictedArea>false</TestShowRestrictedArea>
  <ZipCode>String</ZipCode>
</SendLetter>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommunicationHub.APIModel.Response">
  <Configuration>String</Configuration>
  <ErrorMessage>String</ErrorMessage>
  <MessageId>String</MessageId>
  <Receiver>String</Receiver>
  <Retry>false</Retry>
  <RetryCount>0</RetryCount>
  <Sender>String</Sender>
  <Status>accepted</Status>
</SendResponse>