digitaluapi

<back to all web services

SendCampaignCommunicationsTest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET POST/campaign/communications/test/{ScheduleInstancesId}Get Campaign Communications 
namespace digitaluapi.ServiceModel

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

    [<AllowNullLiteral>]
    type SendCampaignCommunicationsResponse() = 
        member val Status:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type SendCampaignCommunicationsTest() = 
        [<DataMember(Order=1)>]
        [<Validate(Validator="NotNull")>]
        member val ScheduleInstancesId:Int64 = new Int64() with get,set

        [<DataMember(Order=2)>]
        [<Validate(Validator="NotNull")>]
        member val EmailAddress:String = null with get,set

        [<DataMember(Order=3)>]
        [<Validate(Validator="NotNull")>]
        member val MobileNumber:String = null with get,set

        [<DataMember(Order=3)>]
        member val NoOfRecords:Int32 = new Int32() with get,set

F# SendCampaignCommunicationsTest 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 /campaign/communications/test/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendCampaignCommunicationsTest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <EmailAddress>String</EmailAddress>
  <MobileNumber>String</MobileNumber>
  <NoOfRecords>0</NoOfRecords>
  <ScheduleInstancesId>0</ScheduleInstancesId>
</SendCampaignCommunicationsTest>

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

<SendCampaignCommunicationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Status>false</Status>
</SendCampaignCommunicationsResponse>