regis

<back to all web services

CMSummaryRequest

Requires Authentication
Required permission:CMPermission
The following routes are available for this service:
POST/CampaignMonitor/{email}/Summary
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CMSummaryRequest
    {
        public String email = null;
        
        public String getEmail() { return email; }
        public CMSummaryRequest setEmail(String value) { this.email = value; return this; }
    }

    public static class CMSummaryResponse
    {
        public String email = null;
        public Boolean is_optin = null;
        public Boolean is_ebr = null;
        public String is_express_consent = null;
        public Boolean is_suppressed = null;
        public String last_consent_source = null;
        public Date last_consent_date = null;
        public Date last_event_date = null;
        public Date last_reframe_purchase_date = null;
        public ArrayList<CMListResponse> lists = null;
        
        public String getEmail() { return email; }
        public CMSummaryResponse setEmail(String value) { this.email = value; return this; }
        public Boolean getIsOptin() { return is_optin; }
        public CMSummaryResponse setIsOptin(Boolean value) { this.is_optin = value; return this; }
        public Boolean getIsEbr() { return is_ebr; }
        public CMSummaryResponse setIsEbr(Boolean value) { this.is_ebr = value; return this; }
        public String getIsExpressConsent() { return is_express_consent; }
        public CMSummaryResponse setIsExpressConsent(String value) { this.is_express_consent = value; return this; }
        public Boolean getIsSuppressed() { return is_suppressed; }
        public CMSummaryResponse setIsSuppressed(Boolean value) { this.is_suppressed = value; return this; }
        public String getLastConsentSource() { return last_consent_source; }
        public CMSummaryResponse setLastConsentSource(String value) { this.last_consent_source = value; return this; }
        public Date getLastConsentDate() { return last_consent_date; }
        public CMSummaryResponse setLastConsentDate(Date value) { this.last_consent_date = value; return this; }
        public Date getLastEventDate() { return last_event_date; }
        public CMSummaryResponse setLastEventDate(Date value) { this.last_event_date = value; return this; }
        public Date getLastReframePurchaseDate() { return last_reframe_purchase_date; }
        public CMSummaryResponse setLastReframePurchaseDate(Date value) { this.last_reframe_purchase_date = value; return this; }
        public ArrayList<CMListResponse> getLists() { return lists; }
        public CMSummaryResponse setLists(ArrayList<CMListResponse> value) { this.lists = value; return this; }
    }

    public static class CMListResponse
    {
        public String id = null;
        public String name = null;
        public String status = null;
        public ArrayList<String> segments = null;
        
        public String getId() { return id; }
        public CMListResponse setId(String value) { this.id = value; return this; }
        public String getName() { return name; }
        public CMListResponse setName(String value) { this.name = value; return this; }
        public String getStatus() { return status; }
        public CMListResponse setStatus(String value) { this.status = value; return this; }
        public ArrayList<String> getSegments() { return segments; }
        public CMListResponse setSegments(ArrayList<String> value) { this.segments = value; return this; }
    }

}

Java CMSummaryRequest 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 /CampaignMonitor/{email}/Summary HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CMSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.CampaignMonitor.Requests">
  <email>String</email>
</CMSummaryRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CMSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.CampaignMonitor.Responses">
  <email>String</email>
  <is_ebr>false</is_ebr>
  <is_express_consent>String</is_express_consent>
  <is_optin>false</is_optin>
  <is_suppressed>false</is_suppressed>
  <last_consent_date>0001-01-01T00:00:00</last_consent_date>
  <last_consent_source>String</last_consent_source>
  <last_event_date>0001-01-01T00:00:00</last_event_date>
  <last_reframe_purchase_date>0001-01-01T00:00:00</last_reframe_purchase_date>
  <lists>
    <CMListResponse>
      <id>String</id>
      <name>String</name>
      <segments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </segments>
      <status>String</status>
    </CMListResponse>
  </lists>
</CMSummaryResponse>