Reference for https://dna.magnetmail.net/ApiAdapter/Rest/UpsertRecipient/
Url: https://dna.magnetmail.net/ApiAdapter/Rest/UpsertRecipient/
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:
<UpsertRecipient xmlns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects">
<SessionID>String content</SessionID>
<UserID>String content</UserID>
<RecipientDetails>
<Address xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Address>
<Address2 xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Address2>
<City xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</City>
<Company xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Company>
<CustomFields xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">
<KeyValueOfintstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>2147483647</Key>
<Value>String content</Value>
</KeyValueOfintstring>
<KeyValueOfintstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>2147483647</Key>
<Value>String content</Value>
</KeyValueOfintstring>
</CustomFields>
<CustomMemberID xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</CustomMemberID>
<Email xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Email>
<EnhancedPersonalizedFields xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">
<KeyValueOfintstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>2147483647</Key>
<Value>String content</Value>
</KeyValueOfintstring>
<KeyValueOfintstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<Key>2147483647</Key>
<Value>String content</Value>
</KeyValueOfintstring>
</EnhancedPersonalizedFields>
<Fax xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Fax>
<FirstName xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</FirstName>
<ID xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">9223372036854775807</ID>
<LastName xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</LastName>
<Phone xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Phone>
<RecipientSuppressed xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">true</RecipientSuppressed>
<SmsNumber xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</SmsNumber>
<State xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</State>
<TextOnly xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">true</TextOnly>
<Unsubscribed xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">true</Unsubscribed>
<Zip xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">String content</Zip>
</RecipientDetails>
<UpdateWithNullifNotPassed>true</UpdateWithNullifNotPassed>
<UpsertType>String content</UpsertType>
<ValidateEmail>true</ValidateEmail>
</UpsertRecipient>
The following is an example request Json body:
{
"SessionID":"String content",
"UserID":"String content",
"RecipientDetails":{
"Address":"String content",
"Address2":"String content",
"City":"String content",
"Company":"String content",
"CustomFields":[{
"Key":2147483647,
"Value":"String content"
}],
"CustomMemberID":"String content",
"Email":"String content",
"EnhancedPersonalizedFields":[{
"Key":2147483647,
"Value":"String content"
}],
"Fax":"String content",
"FirstName":"String content",
"ID":9223372036854775807,
"LastName":"String content",
"Phone":"String content",
"RecipientSuppressed":true,
"SmsNumber":"String content",
"State":"String content",
"TextOnly":true,
"Unsubscribed":true,
"Zip":"String content"
},
"UpdateWithNullifNotPassed":true,
"UpsertType":"String content",
"ValidateEmail":true
}
The following is an example response Xml body:
<GlobalAPIResponse xmlns="http://schemas.datacontract.org/2004/07/UltimateDNA">
<Details>String content</Details>
<ID>9223372036854775807</ID>
<!--Valid elements of type: GlobalAPIResponse, schema-->
<Result i:type="GlobalAPIResponse" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Details>String content</Details>
<ID>9223372036854775807</ID>
<!--Valid elements of type: GlobalAPIResponse, schema-->
<Result i:type="GlobalAPIResponse">
<Details>String content</Details>
<ID>9223372036854775807</ID>
<Result i:nil="true" />
<Success>true</Success>
</Result>
<Success>true</Success>
</Result>
<Success>true</Success>
</GlobalAPIResponse>
The following is an example response Json body:
{
"Details":"String content",
"ID":9223372036854775807,
"Result":{
"Details":"String content",
"ID":9223372036854775807,
"Result":{
"Details":"String content",
"ID":9223372036854775807,
"Result":null,
"Success":true
},
"Success":true
},
"Success":true
}
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.datacontract.org/2004/07/UltimateDNA" />
<xs:complexType name="UpsertRecipient">
<xs:complexContent mixed="false">
<xs:extension base="tns:AuthCredentials">
<xs:sequence>
<xs:element name="RecipientDetails" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/UltimateDNA" type="q1:Recipient" />
<xs:element minOccurs="0" name="UpdateWithNullifNotPassed" type="xs:boolean" />
<xs:element name="UpsertType" nillable="true" type="xs:string" />
<xs:element name="ValidateEmail" type="xs:boolean" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="UpsertRecipient" nillable="true" type="tns:UpsertRecipient" />
<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.datacontract.org/2004/07/UltimateDNA" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/UltimateDNA" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<xs:complexType name="Recipient">
<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="CustomFields" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfKeyValueOfintstring" />
<xs:element minOccurs="0" name="CustomMemberID" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Email" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EnhancedPersonalizedFields" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfKeyValueOfintstring" />
<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="ID" type="xs:long" />
<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="RecipientSuppressed" type="xs:boolean" />
<xs:element minOccurs="0" name="SmsNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="State" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TextOnly" type="xs:boolean" />
<xs:element minOccurs="0" name="Unsubscribed" type="xs:boolean" />
<xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Recipient" nillable="true" type="tns:Recipient" />
</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="ArrayOfKeyValueOfintstring">
<xs:annotation>
<xs:appinfo>
<IsDictionary xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</IsDictionary>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="KeyValueOfintstring">
<xs:complexType>
<xs:sequence>
<xs:element name="Key" type="xs:int" />
<xs:element name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfKeyValueOfintstring" nillable="true" type="tns:ArrayOfKeyValueOfintstring" />
</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/UltimateDNA" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/UltimateDNA" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType name="GlobalAPIResponse">
<xs:sequence>
<xs:element minOccurs="0" name="Details" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ID" type="xs:long" />
<xs:element minOccurs="0" name="Result" nillable="true" type="xs:anyType" />
<xs:element minOccurs="0" name="Success" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
<xs:element name="GlobalAPIResponse" nillable="true" type="tns:GlobalAPIResponse" />
</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>