Platform Subscription API

<back to all web services

SaveCommunication

Inserts a communication that is not already saved.

Requires Authentication 
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Inserts a communication that is not already saved.
    ///</summary>
    [<Api(Description="Inserts a communication that is not already saved.")>]
    [<AllowNullLiteral>]
    type SaveCommunication() = 
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set

        ///<summary>
        ///The unique key that represents the communication on the external system.
        ///</summary>
        [<ApiMember(DataType="string", Description="The unique key that represents the communication on the external system.", Name="AlternateKey", ParameterType="query")>]
        member val AlternateKey:String = null with get,set

        ///<summary>
        ///Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the communication object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.", IsRequired=true, Name="ObjectId", ParameterType="query")>]
        member val ObjectId:Guid = new Guid() with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set
        ///<summary>
        ///Communication Status Id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Communication Status Id.", IsRequired=true, Name="CommunicationStatusId", ParameterType="query")>]
        member val CommunicationStatusId:Guid = new Guid() with get,set

        ///<summary>
        ///XML containing the content of the communication.
        ///</summary>
        [<ApiMember(DataType="string", Description="XML containing the content of the communication.", IsRequired=true, Name="CommunicationXml", ParameterType="query")>]
        member val CommunicationXml:String = null with get,set

        ///<summary>
        ///Guid of the object this communication is related to.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the object this communication is related to.", IsRequired=true, Name="ObjectIdPrepositional", ParameterType="query")>]
        member val ObjectIdPrepositional:Guid = new Guid() with get,set

F# SaveCommunication DTOs

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 /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>