Reference for https://dna.magnetmail.net/ApiAdapter/Rest/AddRecipient/
Url: https://dna.magnetmail.net/ApiAdapter/Rest/AddRecipient/
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:
<AddRecipient xmlns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects">
<Address xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Address>
<Address2 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Address2>
<City xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</City>
<Company xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Company>
<CustomField1 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField1>
<CustomField10 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField10>
<CustomField11 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField11>
<CustomField12 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField12>
<CustomField13 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField13>
<CustomField14 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField14>
<CustomField15 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField15>
<CustomField16 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField16>
<CustomField17 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField17>
<CustomField18 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField18>
<CustomField19 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField19>
<CustomField2 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField2>
<CustomField20 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField20>
<CustomField21 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField21>
<CustomField22 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField22>
<CustomField23 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField23>
<CustomField24 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField24>
<CustomField25 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField25>
<CustomField26 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField26>
<CustomField27 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField27>
<CustomField28 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField28>
<CustomField29 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField29>
<CustomField3 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField3>
<CustomField30 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField30>
<CustomField4 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField4>
<CustomField5 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField5>
<CustomField6 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField6>
<CustomField7 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField7>
<CustomField8 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField8>
<CustomField9 xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomField9>
<CustomID xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</CustomID>
<Email xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Email>
<Fax xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Fax>
<FirstName xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</FirstName>
<LastName xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</LastName>
<Phone xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Phone>
<State xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</State>
<TextOnlyRecipient xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">true</TextOnlyRecipient>
<Zip xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">String content</Zip>
<Groups>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
</Groups>
<SessionID>String content</SessionID>
<UserID>String content</UserID>
</AddRecipient>
The following is an example request Json body:
{
"Address":"String content",
"Address2":"String content",
"City":"String content",
"Company":"String content",
"CustomField1":"String content",
"CustomField10":"String content",
"CustomField11":"String content",
"CustomField12":"String content",
"CustomField13":"String content",
"CustomField14":"String content",
"CustomField15":"String content",
"CustomField16":"String content",
"CustomField17":"String content",
"CustomField18":"String content",
"CustomField19":"String content",
"CustomField2":"String content",
"CustomField20":"String content",
"CustomField21":"String content",
"CustomField22":"String content",
"CustomField23":"String content",
"CustomField24":"String content",
"CustomField25":"String content",
"CustomField26":"String content",
"CustomField27":"String content",
"CustomField28":"String content",
"CustomField29":"String content",
"CustomField3":"String content",
"CustomField30":"String content",
"CustomField4":"String content",
"CustomField5":"String content",
"CustomField6":"String content",
"CustomField7":"String content",
"CustomField8":"String content",
"CustomField9":"String content",
"CustomID":"String content",
"Email":"String content",
"Fax":"String content",
"FirstName":"String content",
"LastName":"String content",
"Phone":"String content",
"State":"String content",
"TextOnlyRecipient":true,
"Zip":"String content",
"Groups":[2147483647],
"SessionID":"String content",
"UserID":"String content"
}
The following is an example response Xml body:
<SaveResult xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">
<AdditionalParams>String content</AdditionalParams>
<Error>1.26743233E+15</Error>
<ErrorObject>
<ErrorCode>String content</ErrorCode>
<ErrorDetails>String content</ErrorDetails>
<ErrorID>2147483647</ErrorID>
<ErrorMessage>String content</ErrorMessage>
<ErrorType>String content</ErrorType>
</ErrorObject>
<Message>String content</Message>
</SaveResult>
The following is an example response Json body:
{
"AdditionalParams":"String content",
"Error":1.26743233E+15,
"ErrorObject":{
"ErrorCode":"String content",
"ErrorDetails":"String content",
"ErrorID":2147483647,
"ErrorMessage":"String content",
"ErrorType":"String content"
},
"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:complexType name="AddRecipient">
<xs:complexContent mixed="false">
<xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/APIAdapter" base="q1:RecipientOBJMinimized">
<xs:sequence>
<xs:element minOccurs="0" name="Groups" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfint" />
<xs:element name="SessionID" nillable="true" type="xs:string" />
<xs:element name="UserID" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="AddRecipient" nillable="true" type="tns:AddRecipient" />
</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.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="RecipientOBJMinimized">
<xs:sequence>
<xs:element minOccurs="0" name="Address" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Address2" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="City" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Company" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField1" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField10" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField11" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField12" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField13" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField14" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField15" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField16" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField17" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField18" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField19" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField2" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField20" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField21" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField22" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField23" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField24" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField25" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField26" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField27" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField28" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField29" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField3" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField30" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField4" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField5" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField6" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField7" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField8" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomField9" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="CustomID" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Email" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Fax" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Phone" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="State" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TextOnlyRecipient" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="RecipientOBJMinimized" nillable="true" type="tns:RecipientOBJMinimized" />
</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="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>
<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:complexType name="SaveResult">
<xs:sequence>
<xs:element minOccurs="0" name="AdditionalParams" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Error" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="ErrorObject" nillable="true" type="tns:Error" />
<xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="SaveResult" nillable="true" type="tns:SaveResult" />
<xs:complexType name="Error">
<xs:sequence>
<xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ErrorDetails" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ErrorID" type="xs:int" />
<xs:element minOccurs="0" name="ErrorMessage" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ErrorType" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Error" nillable="true" type="tns:Error" />
</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>
<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>