POST communication/GetMessagePreviews

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ContentTemplateId	integer	None.
MessageType	string	None.
Subject	string	None.
Content	string	None.
PrimaryEmail	Collection of string	None.
CCEmail	string	None.
UniqueId	integer	None.
ObjectType	string	None.
ObjectId	integer	None.
TenantId	integer	None.
Brochures	Collection of integer	None.
Documents	Collection of integer	None.
CustId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ContentTemplateId": 1,
  "MessageType": "sample string 2",
  "Subject": "sample string 3",
  "Content": "sample string 4",
  "PrimaryEmail": [
    "sample string 1",
    "sample string 2"
  ],
  "CCEmail": "sample string 5",
  "UniqueId": 6,
  "ObjectType": "sample string 7",
  "ObjectId": 8,
  "TenantId": 9,
  "Brochures": [
    1,
    2
  ],
  "Documents": [
    1,
    2
  ],
  "CustId": 10
}

text/html

Sample:

{"ContentTemplateId":1,"MessageType":"sample string 2","Subject":"sample string 3","Content":"sample string 4","PrimaryEmail":["sample string 1","sample string 2"],"CCEmail":"sample string 5","UniqueId":6,"ObjectType":"sample string 7","ObjectId":8,"TenantId":9,"Brochures":[1,2],"Documents":[1,2],"CustId":10}

application/xml, text/xml

Sample:

<SendContentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Communication">
  <Brochures xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Brochures>
  <CCEmail>sample string 5</CCEmail>
  <Content>sample string 4</Content>
  <ContentTemplateId>1</ContentTemplateId>
  <CustId>10</CustId>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Documents>
  <MessageType>sample string 2</MessageType>
  <ObjectId>8</ObjectId>
  <ObjectType>sample string 7</ObjectType>
  <PrimaryEmail xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PrimaryEmail>
  <Subject>sample string 3</Subject>
  <TenantId>9</TenantId>
  <UniqueId>6</UniqueId>
</SendContentRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendContentRequest'.

Response Information

Resource Description

PreviewMessageWrapper

Name	Type	Additional information
messagePreviews	Collection of PreviewMessage	None.
WasSuccessful	boolean	None.
Message	string	None.
RefId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "messagePreviews": [
    {
      "CommsId": 1,
      "GridId": 2,
      "ToName": "sample string 3",
      "ToContact": "sample string 4",
      "MessageType": "sample string 5",
      "Subject": "sample string 6",
      "Content": "sample string 7",
      "Result": "sample string 8",
      "ObjectType": "sample string 9",
      "ObjectId": 10,
      "CustId": 1,
      "ContentTemplateId": 11
    },
    {
      "CommsId": 1,
      "GridId": 2,
      "ToName": "sample string 3",
      "ToContact": "sample string 4",
      "MessageType": "sample string 5",
      "Subject": "sample string 6",
      "Content": "sample string 7",
      "Result": "sample string 8",
      "ObjectType": "sample string 9",
      "ObjectId": 10,
      "CustId": 1,
      "ContentTemplateId": 11
    }
  ],
  "WasSuccessful": true,
  "Message": "sample string 2",
  "RefId": 3
}

text/html

Sample:

{"messagePreviews":[{"CommsId":1,"GridId":2,"ToName":"sample string 3","ToContact":"sample string 4","MessageType":"sample string 5","Subject":"sample string 6","Content":"sample string 7","Result":"sample string 8","ObjectType":"sample string 9","ObjectId":10,"CustId":1,"ContentTemplateId":11},{"CommsId":1,"GridId":2,"ToName":"sample string 3","ToContact":"sample string 4","MessageType":"sample string 5","Subject":"sample string 6","Content":"sample string 7","Result":"sample string 8","ObjectType":"sample string 9","ObjectId":10,"CustId":1,"ContentTemplateId":11}],"WasSuccessful":true,"Message":"sample string 2","RefId":3}

application/xml, text/xml

Sample:

<PreviewMessageWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Communication">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">sample string 2</Message>
  <RefId xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">3</RefId>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">true</WasSuccessful>
  <messagePreviews>
    <PreviewMessage>
      <CommsId>1</CommsId>
      <Content>sample string 7</Content>
      <ContentTemplateId>11</ContentTemplateId>
      <CustId>1</CustId>
      <GridId>2</GridId>
      <MessageType>sample string 5</MessageType>
      <ObjectId>10</ObjectId>
      <ObjectType>sample string 9</ObjectType>
      <Result>sample string 8</Result>
      <Subject>sample string 6</Subject>
      <ToContact>sample string 4</ToContact>
      <ToName>sample string 3</ToName>
    </PreviewMessage>
    <PreviewMessage>
      <CommsId>1</CommsId>
      <Content>sample string 7</Content>
      <ContentTemplateId>11</ContentTemplateId>
      <CustId>1</CustId>
      <GridId>2</GridId>
      <MessageType>sample string 5</MessageType>
      <ObjectId>10</ObjectId>
      <ObjectType>sample string 9</ObjectType>
      <Result>sample string 8</Result>
      <Subject>sample string 6</Subject>
      <ToContact>sample string 4</ToContact>
      <ToName>sample string 3</ToName>
    </PreviewMessage>
  </messagePreviews>
</PreviewMessageWrapper>