Trendsic Platform Service

<back to all web services

MassCommunicationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/MassCommunication
import Foundation
import ServiceStack

public class MassCommunicationRequest : Codable
{
    public var message:String
    public var recipients:[String] = []
    public var locations:[String] = []
    public var emailMissingNumbers:Bool
    public var emailAll:Bool
    public var smsAll:Bool

    required public init(){}
}

public class MassCommunicationResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var success:Bool
    public var recipients:Int

    required public init(){}
}


Swift MassCommunicationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/MassCommunication HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Message":"String","Recipients":["String"],"Locations":["String"],"EmailMissingNumbers":false,"EmailAll":false,"SMSAll":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Success":false,"Recipients":0}