Reference for https://dna.magnetmail.net/ApiAdapter/Rest/UploadRecipients/
Url: https://dna.magnetmail.net/ApiAdapter/Rest/UploadRecipients/
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:
<UploadRecipient xmlns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects"> <SessionID>String content</SessionID> <UserID>String content</UserID> <AddOrReplace>String content</AddOrReplace> <ContainsUnicode>true</ContainsUnicode> <Data>String content</Data> <GroupId>2147483647</GroupId> <HasHeaderRow>true</HasHeaderRow> <LoginId>2147483647</LoginId> <Mapping> <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> </Mapping> <UpdateExistingRecipients>true</UpdateExistingRecipients> </UploadRecipient>
The following is an example request Json body:
{ "SessionID":"String content", "UserID":"String content", "AddOrReplace":"String content", "ContainsUnicode":true, "Data":"String content", "GroupId":2147483647, "HasHeaderRow":true, "LoginId":2147483647, "Mapping":[{ "Key":2147483647, "Value":"String content" }], "UpdateExistingRecipients":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.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="UploadRecipient"> <xs:complexContent mixed="false"> <xs:extension base="tns:AuthCredentials"> <xs:sequence> <xs:element name="AddOrReplace" nillable="true" type="xs:string" /> <xs:element name="ContainsUnicode" type="xs:boolean" /> <xs:element name="Data" nillable="true" type="xs:string" /> <xs:element name="GroupId" type="xs:int" /> <xs:element name="HasHeaderRow" type="xs:boolean" /> <xs:element minOccurs="0" name="LoginId" type="xs:int" /> <xs:element name="Mapping" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfKeyValueOfintstring" /> <xs:element name="UpdateExistingRecipients" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="UploadRecipient" nillable="true" type="tns:UploadRecipient" /> <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="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>