regis

<back to all web services

CMSummaryRequest

Requires Authentication
Required permission:CMPermission
The following routes are available for this service:
POST/CampaignMonitor/{email}/Summary
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.CampaignMonitor.Requests;
using regis.CampaignMonitor.Responses;

namespace regis.CampaignMonitor.Requests
{
    public partial class CMSummaryRequest
    {
        public virtual string email { get; set; }
    }

}

namespace regis.CampaignMonitor.Responses
{
    public partial class CMListResponse
    {
        public CMListResponse()
        {
            segments = new List<string>{};
        }

        public virtual string id { get; set; }
        public virtual string name { get; set; }
        public virtual string status { get; set; }
        public virtual List<string> segments { get; set; }
    }

    public partial class CMSummaryResponse
    {
        public CMSummaryResponse()
        {
            lists = new List<CMListResponse>{};
        }

        public virtual string email { get; set; }
        public virtual bool is_optin { get; set; }
        public virtual bool is_ebr { get; set; }
        public virtual string is_express_consent { get; set; }
        public virtual bool is_suppressed { get; set; }
        public virtual string last_consent_source { get; set; }
        public virtual DateTime? last_consent_date { get; set; }
        public virtual DateTime? last_event_date { get; set; }
        public virtual DateTime? last_reframe_purchase_date { get; set; }
        public virtual List<CMListResponse> lists { get; set; }
    }

}

C# CMSummaryRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	email: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
	last_event_date: 0001-01-01,
	last_reframe_purchase_date: 0001-01-01,
	lists: 
	[
		{
			id: String,
			name: String,
			status: String,
			segments: 
			[
				String
			]
		}
	]
}