| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SuiteDataSourceInstanceId | body | Guid | Yes | Guid representing the external systems datasource information. |
| AlternateKey | body | string | No | The unique key that represents the communication on the external system. |
| ObjectId | body | Guid | Yes | Guid of the communication object within PSTPF. If ObjectId is known, the external system may pass this instead of the alternate key. |
| CommunicationStatusId | body | Guid | Yes | Communication Status Id. |
| CommunicationXml | body | string | Yes | XML containing the content of the communication. |
| ObjectIdPrepositional | body | 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/SaveCommunication HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AlternateKey: String,
CommunicationXml: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}