Reference for https://dna.magnetmail.net/ApiAdapter/Rest/SendEmailToGroupWithProfile/
Url: https://dna.magnetmail.net/ApiAdapter/Rest/SendEmailToGroupWithProfile/
HTTP Method: POST
| Message direction | Format | Body |
|---|---|---|
| Request | Xml | Example,Schema |
| Request | Json | Example |
| Response | Xml | Example,Schema |
| Response | Json | Example |
The following is an example request Xml body:
<SendEmailMessageToGroupWProfile xmlns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects">
<SessionID>String content</SessionID>
<UserID>String content</UserID>
<AdditionalRecipients>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string>
</AdditionalRecipients>
<BillingCode>String content</BillingCode>
<BillingInitials>String content</BillingInitials>
<FaxResolution>String content</FaxResolution>
<FilteredGroupIDs>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</FilteredGroupIDs>
<GroupIDs>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</GroupIDs>
<IncludeRecipientsThatAlreadyReceivedTheMessage>true</IncludeRecipientsThatAlreadyReceivedTheMessage>
<JobIPId>1.26743233E+15</JobIPId>
<LinkTrackingOptions>
<EnableHTMLVersion xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</EnableHTMLVersion>
<EnableMessageOpens xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</EnableMessageOpens>
<EnableTextVersion xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</EnableTextVersion>
</LinkTrackingOptions>
<LoginID>2147483647</LoginID>
<MessageFromAddress>String content</MessageFromAddress>
<MessageID>2147483647</MessageID>
<MessageSubject>String content</MessageSubject>
<Newsletter>
<NewsLetterArchive xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</NewsLetterArchive>
<NewsLetterPublishDate xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</NewsLetterPublishDate>
<NewsletterName xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</NewsletterName>
</Newsletter>
<Notification>
<CompleteNotification xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</CompleteNotification>
<CompleteNotificationFrom xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CompleteNotificationFrom>
<CompleteNotificationTo xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CompleteNotificationTo>
<CompleteNotificationWhen xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">2147483647</CompleteNotificationWhen>
<SendNotificationFrom xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</SendNotificationFrom>
<SendNotificationTo xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</SendNotificationTo>
<SendNotificationWhen xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">2147483647</SendNotificationWhen>
<ShouldSendNotification xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</ShouldSendNotification>
</Notification>
<RSSType>noRSS</RSSType>
<ReplyToEmailAddress>String content</ReplyToEmailAddress>
<Resend>true</Resend>
<ScheduledTime>String content</ScheduledTime>
<SendMessageDespiteBadFromAddress>true</SendMessageDespiteBadFromAddress>
<SendType>String content</SendType>
<SenderProfileName>String content</SenderProfileName>
<Tag1>String content</Tag1>
<Tag2>String content</Tag2>
<UseHTMLWebVersionLink>true</UseHTMLWebVersionLink>
<UseTextWebVersionLink>true</UseTextWebVersionLink>
</SendEmailMessageToGroupWProfile>
The following is an example request Json body:
{
"SessionID":"String content",
"UserID":"String content",
"AdditionalRecipients":["String content"],
"BillingCode":"String content",
"BillingInitials":"String content",
"FaxResolution":"String content",
"FilteredGroupIDs":[2147483647],
"GroupIDs":[2147483647],
"IncludeRecipientsThatAlreadyReceivedTheMessage":true,
"JobIPId":1.26743233E+15,
"LinkTrackingOptions":{
"EnableHTMLVersion":true,
"EnableMessageOpens":true,
"EnableTextVersion":true
},
"LoginID":2147483647,
"MessageFromAddress":"String content",
"MessageID":2147483647,
"MessageSubject":"String content",
"Newsletter":{
"NewsLetterArchive":true,
"NewsLetterPublishDate":"String content",
"NewsletterName":"String content"
},
"Notification":{
"CompleteNotification":true,
"CompleteNotificationFrom":"String content",
"CompleteNotificationTo":"String content",
"CompleteNotificationWhen":2147483647,
"SendNotificationFrom":"String content",
"SendNotificationTo":"String content",
"SendNotificationWhen":2147483647,
"ShouldSendNotification":true
},
"RSSType":0,
"ReplyToEmailAddress":"String content",
"Resend":true,
"ScheduledTime":"String content",
"SendMessageDespiteBadFromAddress":true,
"SendType":"String content",
"SenderProfileName":"String content",
"Tag1":"String content",
"Tag2":"String content",
"UseHTMLWebVersionLink":true,
"UseTextWebVersionLink":true
}
The following is an example response Xml body:
<EmailSendResult xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">
<Error>2147483647</Error>
<JobIDs>
<!--Valid elements of type: ArrayOfanyType, EmailSendResult, schema-->
<anyType i:type="ArrayOfanyType" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<!--Valid elements of type: ArrayOfanyType, EmailSendResult, schema-->
<anyType i:type="ArrayOfanyType">
<anyType i:nil="true" />
<anyType i:nil="true" />
</anyType>
<!--Valid elements of type: ArrayOfanyType, EmailSendResult, schema-->
<anyType i:type="ArrayOfanyType">
<anyType i:nil="true" />
<anyType i:nil="true" />
</anyType>
</anyType>
<!--Valid elements of type: ArrayOfanyType, EmailSendResult, schema-->
<anyType i:type="ArrayOfanyType" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<!--Valid elements of type: ArrayOfanyType, EmailSendResult, schema-->
<anyType i:type="ArrayOfanyType">
<anyType i:nil="true" />
<anyType i:nil="true" />
</anyType>
<!--Valid elements of type: ArrayOfanyType, EmailSendResult, schema-->
<anyType i:type="ArrayOfanyType">
<anyType i:nil="true" />
<anyType i:nil="true" />
</anyType>
</anyType>
</JobIDs>
<Message>String content</Message>
</EmailSendResult>
The following is an example response Json body:
{
"Error":2147483647,
"JobIDs":[{
"anyType":{
"anyType":null
}
}],
"Message":"String content"
}
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/APIAdapter" />
<xs:import namespace="http://schemas.datacontract.org/2004/07/RMApiAdapter.RMAPI102" />
<xs:complexType name="SendEmailMessageToGroupWProfile">
<xs:complexContent mixed="false">
<xs:extension base="tns:AuthCredentials">
<xs:sequence>
<xs:element minOccurs="0" name="AdditionalRecipients" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" />
<xs:element minOccurs="0" name="BillingCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="BillingInitials" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FaxResolution" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FilteredGroupIDs" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfint" />
<xs:element name="GroupIDs" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" />
<xs:element name="IncludeRecipientsThatAlreadyReceivedTheMessage" type="xs:boolean" />
<xs:element minOccurs="0" name="JobIPId" type="xs:double" />
<xs:element name="LinkTrackingOptions" nillable="true" xmlns:q4="http://schemas.datacontract.org/2004/07/APIAdapter" type="q4:LinkTrackingOptions" />
<xs:element name="LoginID" type="xs:int" />
<xs:element name="MessageFromAddress" nillable="true" type="xs:string" />
<xs:element name="MessageID" type="xs:int" />
<xs:element name="MessageSubject" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Newsletter" nillable="true" xmlns:q5="http://schemas.datacontract.org/2004/07/APIAdapter" type="q5:SendToGroupObjectMaps.NewsLetter" />
<xs:element minOccurs="0" name="Notification" nillable="true" xmlns:q6="http://schemas.datacontract.org/2004/07/APIAdapter" type="q6:SendToGroupObjectMaps.SendNotification" />
<xs:element minOccurs="0" name="RSSType" xmlns:q7="http://schemas.datacontract.org/2004/07/RMApiAdapter.RMAPI102" type="q7:rssType" />
<xs:element name="ReplyToEmailAddress" nillable="true" type="xs:string" />
<xs:element name="Resend" type="xs:boolean" />
<xs:element name="ScheduledTime" nillable="true" type="xs:string" />
<xs:element name="SendMessageDespiteBadFromAddress" type="xs:boolean" />
<xs:element name="SendType" nillable="true" type="xs:string" />
<xs:element name="SenderProfileName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Tag1" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Tag2" nillable="true" type="xs:string" />
<xs:element name="UseHTMLWebVersionLink" type="xs:boolean" />
<xs:element name="UseTextWebVersionLink" type="xs:boolean" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="SendEmailMessageToGroupWProfile" nillable="true" type="tns:SendEmailMessageToGroupWProfile" />
<xs:complexType name="AuthCredentials">
<xs:sequence>
<xs:element name="SessionID" nillable="true" type="xs:string" />
<xs:element name="UserID" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="AuthCredentials" nillable="true" type="tns:AuthCredentials" />
</xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfstring">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" />
<xs:complexType name="ArrayOfint">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/APIAdapter" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/APIAdapter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="LinkTrackingOptions">
<xs:sequence>
<xs:element minOccurs="0" name="EnableHTMLVersion" type="xs:boolean" />
<xs:element minOccurs="0" name="EnableMessageOpens" type="xs:boolean" />
<xs:element minOccurs="0" name="EnableTextVersion" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="LinkTrackingOptions" nillable="true" type="tns:LinkTrackingOptions" />
<xs:complexType name="SendToGroupObjectMaps.NewsLetter">
<xs:sequence>
<xs:element minOccurs="0" name="NewsLetterArchive" type="xs:boolean" />
<xs:element minOccurs="0" name="NewsLetterPublishDate" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="NewsletterName" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="SendToGroupObjectMaps.NewsLetter" nillable="true" type="tns:SendToGroupObjectMaps.NewsLetter" />
<xs:complexType name="SendToGroupObjectMaps.SendNotification">
<xs:sequence>
<xs:element minOccurs="0" name="CompleteNotification" type="xs:boolean" />
<xs:element minOccurs="0" name="CompleteNotificationFrom" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CompleteNotificationTo" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CompleteNotificationWhen" type="xs:int" />
<xs:element minOccurs="0" name="SendNotificationFrom" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SendNotificationTo" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SendNotificationWhen" type="xs:int" />
<xs:element minOccurs="0" name="ShouldSendNotification" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="SendToGroupObjectMaps.SendNotification" nillable="true" type="tns:SendToGroupObjectMaps.SendNotification" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/RMApiAdapter.RMAPI102" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/RMApiAdapter.RMAPI102" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="rssType">
<xs:restriction base="xs:string">
<xs:enumeration value="noRSS" />
<xs:enumeration value="RSSToSelectedGroups" />
<xs:enumeration value="RSSOnly" />
</xs:restriction>
</xs:simpleType>
<xs:element name="rssType" nillable="true" type="tns:rssType" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/APIAdapter" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/APIAdapter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:complexType name="EmailSendResult">
<xs:sequence>
<xs:element minOccurs="0" name="Error" type="xs:int" />
<xs:element minOccurs="0" name="JobIDs" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfanyType" />
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="EmailSendResult" nillable="true" type="tns:EmailSendResult" />
</xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="anyType" nillable="true" type="xs:anyType" />
<xs:element name="anyURI" nillable="true" type="xs:anyURI" />
<xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
<xs:element name="boolean" nillable="true" type="xs:boolean" />
<xs:element name="byte" nillable="true" type="xs:byte" />
<xs:element name="dateTime" nillable="true" type="xs:dateTime" />
<xs:element name="decimal" nillable="true" type="xs:decimal" />
<xs:element name="double" nillable="true" type="xs:double" />
<xs:element name="float" nillable="true" type="xs:float" />
<xs:element name="int" nillable="true" type="xs:int" />
<xs:element name="long" nillable="true" type="xs:long" />
<xs:element name="QName" nillable="true" type="xs:QName" />
<xs:element name="short" nillable="true" type="xs:short" />
<xs:element name="string" nillable="true" type="xs:string" />
<xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
<xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
<xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
<xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
<xs:element name="char" nillable="true" type="tns:char" />
<xs:simpleType name="char">
<xs:restriction base="xs:int" />
</xs:simpleType>
<xs:element name="duration" nillable="true" type="tns:duration" />
<xs:simpleType name="duration">
<xs:restriction base="xs:duration">
<xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
<xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
<xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
</xs:restriction>
</xs:simpleType>
<xs:element name="guid" nillable="true" type="tns:guid" />
<xs:simpleType name="guid">
<xs:restriction base="xs:string">
<xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
</xs:restriction>
</xs:simpleType>
<xs:attribute name="FactoryType" type="xs:QName" />
<xs:attribute name="Id" type="xs:ID" />
<xs:attribute name="Ref" type="xs:IDREF" />
</xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="ArrayOfanyType">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="anyType" nillable="true" type="xs:anyType" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfanyType" nillable="true" type="tns:ArrayOfanyType" />
</xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema">
<tns:element name="schema">
<tns:complexType />
</tns:element>
</tns:schema>