Reference for http://studio.mdl.io/REST/contactservice/ImportContactsByPartner
To import contacts through a CSV file for an action. The action can be one of Add, Update, Add/Update, Activate or Inactivate [Mode: 1=insert/update, 2=insert only, 3=update only, 4=inactivate, 5=activate], [Status: 0=waiting for process, 1=in process, 2=complete, 3=failed, 4=cancelled, 255=all]
Url: http://studio.mdl.io/REST/contactservice/ImportContactsByPartner
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:
<DTO_ImportByPartnerRequest xmlns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO"> <ExportColumns> <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> </ExportColumns> <FtpPassword>String content</FtpPassword> <FtpUrl>String content</FtpUrl> <FtpUsername>String content</FtpUsername> <FileName>String content</FileName> <Filterable>true</Filterable> <Mapping>String content</Mapping> <Mode>255</Mode> <Name>String content</Name> <NotificationEmail>String content</NotificationEmail> <Account_ID>9223372036854775807</Account_ID> <CSV>QmFzZSA2NCBTdHJlYW0=</CSV> <CsvFormat>255</CsvFormat> <PartnerCredentials> <Ticket>String content</Ticket> </PartnerCredentials> <UseSystemPath>true</UseSystemPath> </DTO_ImportByPartnerRequest>
The following is an example request Json body:
{ "ExportColumns":["String content"], "FtpPassword":"String content", "FtpUrl":"String content", "FtpUsername":"String content", "FileName":"String content", "Filterable":true, "Mapping":"String content", "Mode":255, "Name":"String content", "NotificationEmail":"String content", "Account_ID":9223372036854775807, "CSV":[81, 109, 70, 122, 90, 83, 65, 50, 78, 67, 66, 84, 100, 72, 74, 108, 89, 87, 48, 61], "CsvFormat":255, "PartnerCredentials":{ "Ticket":"String content" }, "UseSystemPath":true }
The following is an example response Xml body:
<DTO_ImportByPartnerResponse xmlns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO"> <ExportColumns> <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> </ExportColumns> <FtpPassword>String content</FtpPassword> <FtpUrl>String content</FtpUrl> <FtpUsername>String content</FtpUsername> <FileName>String content</FileName> <Filterable>true</Filterable> <Mapping>String content</Mapping> <Mode>255</Mode> <Name>String content</Name> <NotificationEmail>String content</NotificationEmail> <CsvRecords>2147483647</CsvRecords> <ID>9223372036854775807</ID> <LastUpdate>1999-05-31T11:20:00</LastUpdate> <ProcessEndDate>1999-05-31T11:20:00</ProcessEndDate> <ProcessStartDate>1999-05-31T11:20:00</ProcessStartDate> <ProcessedRecords>2147483647</ProcessedRecords> <RejectedRecords>2147483647</RejectedRecords> <Status>255</Status> <SubmitDate>1999-05-31T11:20:00</SubmitDate> <SuccessfulRecords>2147483647</SuccessfulRecords> <Result> <ErrorCode>String content</ErrorCode> <ErrorMessage>String content</ErrorMessage> <ExceptionMessage>String content</ExceptionMessage> </Result> </DTO_ImportByPartnerResponse>
The following is an example response Json body:
{ "ExportColumns":["String content"], "FtpPassword":"String content", "FtpUrl":"String content", "FtpUsername":"String content", "FileName":"String content", "Filterable":true, "Mapping":"String content", "Mode":255, "Name":"String content", "NotificationEmail":"String content", "CsvRecords":2147483647, "ID":9223372036854775807, "LastUpdate":"\/Date(928174800000-0700)\/", "ProcessEndDate":"\/Date(928174800000-0700)\/", "ProcessStartDate":"\/Date(928174800000-0700)\/", "ProcessedRecords":2147483647, "RejectedRecords":2147483647, "Status":255, "SubmitDate":"\/Date(928174800000-0700)\/", "SuccessfulRecords":2147483647, "Result":{ "ErrorCode":"String content", "ErrorMessage":"String content", "ExceptionMessage":"String content" } }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="DTO_ImportByPartnerRequest"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_Import"> <xs:sequence> <xs:element minOccurs="0" name="Account_ID" type="xs:long" /> <xs:element minOccurs="0" name="CSV" nillable="true" type="xs:base64Binary" /> <xs:element minOccurs="0" name="CsvFormat" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="PartnerCredentials" nillable="true" type="tns:DTO_PartnerCredentials" /> <xs:element minOccurs="0" name="UseSystemPath" type="xs:boolean" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ImportByPartnerRequest" nillable="true" type="tns:DTO_ImportByPartnerRequest" /> <xs:complexType name="DTO_Import"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_ImportExport"> <xs:sequence> <xs:element minOccurs="0" name="FileName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Filterable" type="xs:boolean" /> <xs:element minOccurs="0" name="Mapping" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Mode" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NotificationEmail" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_Import" nillable="true" type="tns:DTO_Import" /> <xs:complexType name="DTO_ImportExport"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_Base"> <xs:sequence> <xs:element minOccurs="0" name="ExportColumns" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" /> <xs:element minOccurs="0" name="FtpPassword" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FtpUrl" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FtpUsername" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ImportExport" nillable="true" type="tns:DTO_ImportExport" /> <xs:complexType name="DTO_Base"> <xs:sequence /> </xs:complexType> <xs:element name="DTO_Base" nillable="true" type="tns:DTO_Base" /> <xs:complexType name="DTO_PartnerCredentials"> <xs:sequence> <xs:element minOccurs="0" name="Ticket" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="DTO_PartnerCredentials" nillable="true" type="tns:DTO_PartnerCredentials" /> </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: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/MindFireInc.Services.DTO" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="DTO_ImportByPartnerResponse"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_ImportDetail"> <xs:sequence> <xs:element minOccurs="0" name="Result" nillable="true" type="tns:DTO_Result" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ImportByPartnerResponse" nillable="true" type="tns:DTO_ImportByPartnerResponse" /> <xs:complexType name="DTO_ImportDetail"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_Import"> <xs:sequence> <xs:element minOccurs="0" name="CsvRecords" type="xs:int" /> <xs:element minOccurs="0" name="ID" type="xs:long" /> <xs:element minOccurs="0" name="LastUpdate" nillable="true" type="xs:dateTime" /> <xs:element minOccurs="0" name="ProcessEndDate" nillable="true" type="xs:dateTime" /> <xs:element minOccurs="0" name="ProcessStartDate" nillable="true" type="xs:dateTime" /> <xs:element minOccurs="0" name="ProcessedRecords" type="xs:int" /> <xs:element minOccurs="0" name="RejectedRecords" type="xs:int" /> <xs:element minOccurs="0" name="Status" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="SubmitDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="SuccessfulRecords" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ImportDetail" nillable="true" type="tns:DTO_ImportDetail" /> <xs:complexType name="DTO_Import"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_ImportExport"> <xs:sequence> <xs:element minOccurs="0" name="FileName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Filterable" type="xs:boolean" /> <xs:element minOccurs="0" name="Mapping" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Mode" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NotificationEmail" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_Import" nillable="true" type="tns:DTO_Import" /> <xs:complexType name="DTO_ImportExport"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_Base"> <xs:sequence> <xs:element minOccurs="0" name="ExportColumns" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" /> <xs:element minOccurs="0" name="FtpPassword" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FtpUrl" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FtpUsername" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ImportExport" nillable="true" type="tns:DTO_ImportExport" /> <xs:complexType name="DTO_Base"> <xs:sequence /> </xs:complexType> <xs:element name="DTO_Base" nillable="true" type="tns:DTO_Base" /> <xs:complexType name="DTO_Result"> <xs:sequence> <xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ErrorMessage" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ExceptionMessage" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="DTO_Result" nillable="true" type="tns:DTO_Result" /> </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="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: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>