regis

CMSummaryRequest

**Requires Authentication**
Required permission:	CMPermission

The following routes are available for this service:
POST	/CampaignMonitor/{email}/Summary

"use strict";
export class CMListResponse {
    /** @param {{id?:string,name?:string,status?:string,segments?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {string} */
    status;
    /** @type {string[]} */
    segments;
}
export class CMSummaryResponse {
    /** @param {{email?:string,is_optin?:boolean,is_ebr?:boolean,is_express_consent?:string,is_suppressed?:boolean,last_consent_source?:string,last_consent_date?:string,last_event_date?:string,last_reframe_purchase_date?:string,lists?:CMListResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
    /** @type {boolean} */
    is_optin;
    /** @type {boolean} */
    is_ebr;
    /** @type {string} */
    is_express_consent;
    /** @type {boolean} */
    is_suppressed;
    /** @type {string} */
    last_consent_source;
    /** @type {?string} */
    last_consent_date;
    /** @type {?string} */
    last_event_date;
    /** @type {?string} */
    last_reframe_purchase_date;
    /** @type {CMListResponse[]} */
    lists;
}
export class CMSummaryRequest {
    /** @param {{email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    email;
}

JavaScript 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>