Reference for https://dna.magnetmail.net/ApiAdapter/Rest/GetDetailedTracking/
Url: https://dna.magnetmail.net/ApiAdapter/Rest/GetDetailedTracking/
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:
<GetDetailedTracking xmlns="http://schemas.datacontract.org/2004/07/APIAdapter.ContractObjects"> <SessionID>String content</SessionID> <UserID>String content</UserID> <CustomParameters>String content</CustomParameters> <Email>String content</Email> <Fax>String content</Fax> <FirstName>String content</FirstName> <FromDate>String content</FromDate> <GroupID>2147483647</GroupID> <LastName>String content</LastName> <MessageID>2147483647</MessageID> <Page>2147483647</Page> <RecordsPerPage>2147483647</RecordsPerPage> <ReportType>String content</ReportType> <ToDate>String content</ToDate> </GetDetailedTracking>
The following is an example request Json body:
{
"SessionID":"String content",
"UserID":"String content",
"CustomParameters":"String content",
"Email":"String content",
"Fax":"String content",
"FirstName":"String content",
"FromDate":"String content",
"GroupID":2147483647,
"LastName":"String content",
"MessageID":2147483647,
"Page":2147483647,
"RecordsPerPage":2147483647,
"ReportType":"String content",
"ToDate":"String content"
}
The following is an example response Xml body:
<TrackingDetailsResult xmlns="http://schemas.datacontract.org/2004/07/APIAdapter">
<Error>String content</Error>
<Page>2147483647</Page>
<RecordsPerPage>2147483647</RecordsPerPage>
<TotalRecords>2147483647</TotalRecords>
<Tracking>
<RecipientTracking>
<FaxStatus>Inprogress</FaxStatus>
<MTRId>9223372036854775807</MTRId>
<OpenDate>1999-05-31T11:20:00</OpenDate>
<Recipient>
<Address>String content</Address>
<Address2>String content</Address2>
<City>String content</City>
<Company>String content</Company>
<CustomField1>String content</CustomField1>
<CustomField10>String content</CustomField10>
<CustomField11>String content</CustomField11>
<CustomField12>String content</CustomField12>
<CustomField13>String content</CustomField13>
<CustomField14>String content</CustomField14>
<CustomField15>String content</CustomField15>
<CustomField16>String content</CustomField16>
<CustomField17>String content</CustomField17>
<CustomField18>String content</CustomField18>
<CustomField19>String content</CustomField19>
<CustomField2>String content</CustomField2>
<CustomField20>String content</CustomField20>
<CustomField21>String content</CustomField21>
<CustomField22>String content</CustomField22>
<CustomField23>String content</CustomField23>
<CustomField24>String content</CustomField24>
<CustomField25>String content</CustomField25>
<CustomField26>String content</CustomField26>
<CustomField27>String content</CustomField27>
<CustomField28>String content</CustomField28>
<CustomField29>String content</CustomField29>
<CustomField3>String content</CustomField3>
<CustomField30>String content</CustomField30>
<CustomField4>String content</CustomField4>
<CustomField5>String content</CustomField5>
<CustomField6>String content</CustomField6>
<CustomField7>String content</CustomField7>
<CustomField8>String content</CustomField8>
<CustomField9>String content</CustomField9>
<CustomID>String content</CustomID>
<Email>String content</Email>
<EmailConfirmed>true</EmailConfirmed>
<EmailSendSuppress>true</EmailSendSuppress>
<Fax>String content</Fax>
<FaxSendSupress>true</FaxSendSupress>
<FirstName>String content</FirstName>
<ID>String content</ID>
<LastName>String content</LastName>
<Phone>String content</Phone>
<State>String content</State>
<SuppressedDate>1999-05-31T11:20:00</SuppressedDate>
<TextOnlyRecipient>true</TextOnlyRecipient>
<Unsubscribed>true</Unsubscribed>
<Zip>String content</Zip>
</Recipient>
<Remarks>String content</Remarks>
<ResultDate>1999-05-31T11:20:00</ResultDate>
<Status>Inprogress</Status>
</RecipientTracking>
<RecipientTracking>
<FaxStatus>Inprogress</FaxStatus>
<MTRId>9223372036854775807</MTRId>
<OpenDate>1999-05-31T11:20:00</OpenDate>
<Recipient>
<Address>String content</Address>
<Address2>String content</Address2>
<City>String content</City>
<Company>String content</Company>
<CustomField1>String content</CustomField1>
<CustomField10>String content</CustomField10>
<CustomField11>String content</CustomField11>
<CustomField12>String content</CustomField12>
<CustomField13>String content</CustomField13>
<CustomField14>String content</CustomField14>
<CustomField15>String content</CustomField15>
<CustomField16>String content</CustomField16>
<CustomField17>String content</CustomField17>
<CustomField18>String content</CustomField18>
<CustomField19>String content</CustomField19>
<CustomField2>String content</CustomField2>
<CustomField20>String content</CustomField20>
<CustomField21>String content</CustomField21>
<CustomField22>String content</CustomField22>
<CustomField23>String content</CustomField23>
<CustomField24>String content</CustomField24>
<CustomField25>String content</CustomField25>
<CustomField26>String content</CustomField26>
<CustomField27>String content</CustomField27>
<CustomField28>String content</CustomField28>
<CustomField29>String content</CustomField29>
<CustomField3>String content</CustomField3>
<CustomField30>String content</CustomField30>
<CustomField4>String content</CustomField4>
<CustomField5>String content</CustomField5>
<CustomField6>String content</CustomField6>
<CustomField7>String content</CustomField7>
<CustomField8>String content</CustomField8>
<CustomField9>String content</CustomField9>
<CustomID>String content</CustomID>
<Email>String content</Email>
<EmailConfirmed>true</EmailConfirmed>
<EmailSendSuppress>true</EmailSendSuppress>
<Fax>String content</Fax>
<FaxSendSupress>true</FaxSendSupress>
<FirstName>String content</FirstName>
<ID>String content</ID>
<LastName>String content</LastName>
<Phone>String content</Phone>
<State>String content</State>
<SuppressedDate>1999-05-31T11:20:00</SuppressedDate>
<TextOnlyRecipient>true</TextOnlyRecipient>
<Unsubscribed>true</Unsubscribed>
<Zip>String content</Zip>
</Recipient>
<Remarks>String content</Remarks>
<ResultDate>1999-05-31T11:20:00</ResultDate>
<Status>Inprogress</Status>
</RecipientTracking>
</Tracking>
</TrackingDetailsResult>
The following is an example response Json body:
{
"Error":"String content",
"Page":2147483647,
"RecordsPerPage":2147483647,
"TotalRecords":2147483647,
"Tracking":[{
"FaxStatus":0,
"MTRId":9223372036854775807,
"OpenDate":"\/Date(928164000000-0400)\/",
"Recipient":{
"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",
"EmailConfirmed":true,
"EmailSendSuppress":true,
"Fax":"String content",
"FaxSendSupress":true,
"FirstName":"String content",
"ID":"String content",
"LastName":"String content",
"Phone":"String content",
"State":"String content",
"SuppressedDate":"\/Date(928164000000-0400)\/",
"TextOnlyRecipient":true,
"Unsubscribed":true,
"Zip":"String content"
},
"Remarks":"String content",
"ResultDate":"\/Date(928164000000-0400)\/",
"Status":0
}]
}
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:complexType name="GetDetailedTracking">
<xs:complexContent mixed="false">
<xs:extension base="tns:AuthCredentials">
<xs:sequence>
<xs:element minOccurs="0" name="CustomParameters" 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 name="FromDate" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="GroupID" type="xs:int" />
<xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" />
<xs:element name="MessageID" type="xs:int" />
<xs:element name="Page" type="xs:int" />
<xs:element name="RecordsPerPage" type="xs:int" />
<xs:element name="ReportType" nillable="true" type="xs:string" />
<xs:element name="ToDate" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="GetDetailedTracking" nillable="true" type="tns:GetDetailedTracking" />
<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>
<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.datacontract.org/2004/07/RMApiAdapter.RMAPI102" />
<xs:complexType name="TrackingDetailsResult">
<xs:sequence>
<xs:element minOccurs="0" name="Error" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Page" type="xs:int" />
<xs:element minOccurs="0" name="RecordsPerPage" type="xs:int" />
<xs:element minOccurs="0" name="TotalRecords" type="xs:int" />
<xs:element minOccurs="0" name="Tracking" nillable="true" type="tns:ArrayOfRecipientTracking" />
</xs:sequence>
</xs:complexType>
<xs:element name="TrackingDetailsResult" nillable="true" type="tns:TrackingDetailsResult" />
<xs:complexType name="ArrayOfRecipientTracking">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="RecipientTracking" nillable="true" type="tns:RecipientTracking" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfRecipientTracking" nillable="true" type="tns:ArrayOfRecipientTracking" />
<xs:complexType name="RecipientTracking">
<xs:sequence>
<xs:element minOccurs="0" name="FaxStatus" xmlns:q1="http://schemas.datacontract.org/2004/07/RMApiAdapter.RMAPI102" type="q1:FaxStatus" />
<xs:element minOccurs="0" name="MTRId" type="xs:long" />
<xs:element minOccurs="0" name="OpenDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="Recipient" nillable="true" type="tns:RecipientOBJ" />
<xs:element minOccurs="0" name="Remarks" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ResultDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="Status" xmlns:q2="http://schemas.datacontract.org/2004/07/RMApiAdapter.RMAPI102" type="q2:EmailStatus" />
</xs:sequence>
</xs:complexType>
<xs:element name="RecipientTracking" nillable="true" type="tns:RecipientTracking" />
<xs:complexType name="RecipientOBJ">
<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="EmailConfirmed" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="EmailSendSuppress" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="Fax" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FaxSendSupress" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ID" 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="SuppressedDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="TextOnlyRecipient" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="Unsubscribed" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="Zip" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="RecipientOBJ" nillable="true" type="tns:RecipientOBJ" />
</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.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="FaxStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Inprogress" />
<xs:enumeration value="Delivered" />
<xs:enumeration value="Failed" />
</xs:restriction>
</xs:simpleType>
<xs:element name="FaxStatus" nillable="true" type="tns:FaxStatus" />
<xs:simpleType name="EmailStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Inprogress" />
<xs:enumeration value="Delivered" />
<xs:enumeration value="SB" />
<xs:enumeration value="HB" />
<xs:enumeration value="UNF" />
<xs:enumeration value="TU" />
<xs:enumeration value="MF" />
<xs:enumeration value="BD" />
<xs:enumeration value="Failed" />
</xs:restriction>
</xs:simpleType>
<xs:element name="EmailStatus" nillable="true" type="tns:EmailStatus" />
</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>