regis

<back to all web services

CMSummaryRequest

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

Namespace Global

    Namespace regis.CampaignMonitor.Requests

        Public Partial Class CMSummaryRequest
            Public Overridable Property email As String
        End Class
    End Namespace

    Namespace regis.CampaignMonitor.Responses

        Public Partial Class CMListResponse
            Public Sub New()
                segments = New List(Of String)
            End Sub

            Public Overridable Property id As String
            Public Overridable Property name As String
            Public Overridable Property status As String
            Public Overridable Property segments As List(Of String)
        End Class

        Public Partial Class CMSummaryResponse
            Public Sub New()
                lists = New List(Of CMListResponse)
            End Sub

            Public Overridable Property email As String
            Public Overridable Property is_optin As Boolean
            Public Overridable Property is_ebr As Boolean
            Public Overridable Property is_express_consent As String
            Public Overridable Property is_suppressed As Boolean
            Public Overridable Property last_consent_source As String
            Public Overridable Property last_consent_date As Nullable(Of Date)
            Public Overridable Property last_event_date As Nullable(Of Date)
            Public Overridable Property last_reframe_purchase_date As Nullable(Of Date)
            Public Overridable Property lists As List(Of CMListResponse)
        End Class
    End Namespace
End Namespace

VB.NET 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>