regis

<back to all web services

CMSummaryRequest

Requires Authentication
Required permission:CMPermission
The following routes are available for this service:
POST/CampaignMonitor/{email}/Summary
namespace regis.CampaignMonitor.Requests

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

    [<AllowNullLiteral>]
    type CMListResponse() = 
        member val id:String = null with get,set
        member val name:String = null with get,set
        member val status:String = null with get,set
        member val segments:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type CMSummaryResponse() = 
        member val email:String = null with get,set
        member val is_optin:Boolean = new Boolean() with get,set
        member val is_ebr:Boolean = new Boolean() with get,set
        member val is_express_consent:String = null with get,set
        member val is_suppressed:Boolean = new Boolean() with get,set
        member val last_consent_source:String = null with get,set
        member val last_consent_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_event_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_reframe_purchase_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val lists:ResizeArray<CMListResponse> = new ResizeArray<CMListResponse>() with get,set

    [<AllowNullLiteral>]
    type CMSummaryRequest() = 
        member val email:String = null with get,set

F# CMSummaryRequest DTOs

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

HTTP + CSV

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

POST /CampaignMonitor/{email}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"email":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"email":"String","is_optin":false,"is_ebr":false,"is_express_consent":"String","is_suppressed":false,"last_consent_source":"String","last_consent_date":"0001-01-01T00:00:00.0000000","last_event_date":"0001-01-01T00:00:00.0000000","last_reframe_purchase_date":"0001-01-01T00:00:00.0000000","lists":[{"id":"String","name":"String","status":"String","segments":["String"]}]}