Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SuiteDataSourceInstanceId | query | Guid | Yes | Guid representing the external systems datasource information. |
AlternateKey | query | string | No | The unique key that represents the communication on the external system. |
ObjectId | query | Guid | Yes | Guid of the communication object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key. |
IgnoreValidation | query | bool | No | |
CommunicationStatusId | query | Guid | Yes | Communication Status Id. |
CommunicationXml | query | string | Yes | XML containing the content of the communication. |
ObjectIdPrepositional | query | Guid | Yes | Guid of the object this communication is related to. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/SaveCommunication HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SaveCommunication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
<AlternateKey>String</AlternateKey>
<CommunicationStatusId>00000000-0000-0000-0000-000000000000</CommunicationStatusId>
<CommunicationXml>String</CommunicationXml>
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
<ObjectIdPrepositional>00000000-0000-0000-0000-000000000000</ObjectIdPrepositional>
<SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</SaveCommunication>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> </ResponseStatus>