Reference for http://studio.mdl.io/REST/contactservice/ContactExport
To export contact data in the provided scope.
Url: http://studio.mdl.io/REST/contactservice/ContactExport
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_ContactExportRequest xmlns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO">
<Account_ID>9223372036854775807</Account_ID>
<ContactFields>
<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>
</ContactFields>
<ContactPerPage>2147483647</ContactPerPage>
<ContactType>255</ContactType>
<Credentials>
<IsEncrypted>true</IsEncrypted>
<PartnerPassword>String content</PartnerPassword>
<PartnerTicket>String content</PartnerTicket>
<Ticket>String content</Ticket>
<UserPassword>String content</UserPassword>
</Credentials>
<EventOption>String content</EventOption>
<Filter>String content</Filter>
<From>String content</From>
<Goal_ID>9223372036854775807</Goal_ID>
<Metric>9223372036854775807</Metric>
<MetricType>255</MetricType>
<PageNo>2147483647</PageNo>
<ScopeType>255</ScopeType>
<Scope_ID>9223372036854775807</Scope_ID>
<SearchKeyword>String content</SearchKeyword>
<ServiceType_ID>9223372036854775807</ServiceType_ID>
<SortField>String content</SortField>
<SortType>String content</SortType>
<StateID>9223372036854775807</StateID>
<SystemVariables>
<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>
</SystemVariables>
<To>String content</To>
</DTO_ContactExportRequest>
The following is an example request Json body:
{
"Account_ID":9223372036854775807,
"ContactFields":["String content"],
"ContactPerPage":2147483647,
"ContactType":255,
"Credentials":{
"IsEncrypted":true,
"PartnerPassword":"String content",
"PartnerTicket":"String content",
"Ticket":"String content",
"UserPassword":"String content"
},
"EventOption":"String content",
"Filter":"String content",
"From":"String content",
"Goal_ID":9223372036854775807,
"Metric":9223372036854775807,
"MetricType":255,
"PageNo":2147483647,
"ScopeType":255,
"Scope_ID":9223372036854775807,
"SearchKeyword":"String content",
"ServiceType_ID":9223372036854775807,
"SortField":"String content",
"SortType":"String content",
"StateID":9223372036854775807,
"SystemVariables":["String content"],
"To":"String content"
}
The following is an example response Xml body:
<DTO_ContactExportResponse xmlns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO">
<ContactsCSV>String content</ContactsCSV>
<Result>
<ErrorCode>String content</ErrorCode>
<ErrorMessage>String content</ErrorMessage>
<ExceptionMessage>String content</ExceptionMessage>
</Result>
</DTO_ContactExportResponse>
The following is an example response Json body:
{
"ContactsCSV":"String content",
"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_ContactExportRequest">
<xs:sequence>
<xs:element minOccurs="0" name="Account_ID" type="xs:long" />
<xs:element minOccurs="0" name="ContactFields" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" />
<xs:element minOccurs="0" name="ContactPerPage" type="xs:int" />
<xs:element minOccurs="0" name="ContactType" type="xs:unsignedByte" />
<xs:element minOccurs="0" name="Credentials" nillable="true" type="tns:DTO_Credentials" />
<xs:element minOccurs="0" name="EventOption" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Filter" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="From" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Goal_ID" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="Metric" type="xs:long" />
<xs:element minOccurs="0" name="MetricType" type="xs:unsignedByte" />
<xs:element minOccurs="0" name="PageNo" type="xs:int" />
<xs:element minOccurs="0" name="ScopeType" nillable="true" type="xs:unsignedByte" />
<xs:element minOccurs="0" name="Scope_ID" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="SearchKeyword" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ServiceType_ID" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="SortField" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SortType" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="StateID" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="SystemVariables" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfstring" />
<xs:element minOccurs="0" name="To" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="DTO_ContactExportRequest" nillable="true" type="tns:DTO_ContactExportRequest" />
<xs:complexType name="DTO_Credentials">
<xs:sequence>
<xs:element minOccurs="0" name="IsEncrypted" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="PartnerPassword" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PartnerTicket" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Ticket" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="UserPassword" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="DTO_Credentials" nillable="true" type="tns:DTO_Credentials" />
</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:complexType name="DTO_ContactExportResponse">
<xs:sequence>
<xs:element minOccurs="0" name="ContactsCSV" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Result" nillable="true" type="tns:DTO_Result" />
</xs:sequence>
</xs:complexType>
<xs:element name="DTO_ContactExportResponse" nillable="true" type="tns:DTO_ContactExportResponse" />
<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>
<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>