Reference for http://studio.mdl.io/REST/contactservice/GetDWContactFieldList
To get a list of all fields avaiable for contacts from Data Warehouse. You can specify what type of fields you want: 0=both standard and custom fields, 1=only standard fields and 2=only custom fields. DataType_ID can be: 1=String, 2=Integer, 3=Decimal, 4=DateTime, 5=Boolean
Url: http://studio.mdl.io/REST/contactservice/GetDWContactFieldList
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_ContactFieldListRequest xmlns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO"> <Credentials> <AccountID>9223372036854775807</AccountID> <IdentityToken>String content</IdentityToken> <IsEncrypted>true</IsEncrypted> <PartnerPassword>String content</PartnerPassword> <PartnerTicket>String content</PartnerTicket> <Ticket>String content</Ticket> <UserPassword>String content</UserPassword> </Credentials> <Type>255</Type> </DTO_ContactFieldListRequest>
The following is an example request Json body:
{ "Credentials":{ "AccountID":9223372036854775807, "IdentityToken":"String content", "IsEncrypted":true, "PartnerPassword":"String content", "PartnerTicket":"String content", "Ticket":"String content", "UserPassword":"String content" }, "Type":255 }
The following is an example response Xml body:
<DTO_ContactFieldListResponse xmlns="http://schemas.datacontract.org/2004/07/MindFireInc.Services.DTO"> <FieldList> <DTO_ContactFieldDetail> <Category_ID>9223372036854775807</Category_ID> <DataType_ID>255</DataType_ID> <DedupGroupIndex>255</DedupGroupIndex> <Description>String content</Description> <ID>9223372036854775807</ID> <IsEncrypted>true</IsEncrypted> <IsRequired>true</IsRequired> <MaxLength>2147483647</MaxLength> <Name>String content</Name> <PURLIndex>255</PURLIndex> <Type>255</Type> <ValidationRegex>String content</ValidationRegex> <CategoryName>String content</CategoryName> <DataTypeName>String content</DataTypeName> </DTO_ContactFieldDetail> <DTO_ContactFieldDetail> <Category_ID>9223372036854775807</Category_ID> <DataType_ID>255</DataType_ID> <DedupGroupIndex>255</DedupGroupIndex> <Description>String content</Description> <ID>9223372036854775807</ID> <IsEncrypted>true</IsEncrypted> <IsRequired>true</IsRequired> <MaxLength>2147483647</MaxLength> <Name>String content</Name> <PURLIndex>255</PURLIndex> <Type>255</Type> <ValidationRegex>String content</ValidationRegex> <CategoryName>String content</CategoryName> <DataTypeName>String content</DataTypeName> </DTO_ContactFieldDetail> </FieldList> <Result> <ErrorCode>String content</ErrorCode> <ErrorMessage>String content</ErrorMessage> <ExceptionMessage>String content</ExceptionMessage> </Result> </DTO_ContactFieldListResponse>
The following is an example response Json body:
{ "FieldList":[{ "Category_ID":9223372036854775807, "DataType_ID":255, "DedupGroupIndex":255, "Description":"String content", "ID":9223372036854775807, "IsEncrypted":true, "IsRequired":true, "MaxLength":2147483647, "Name":"String content", "PURLIndex":255, "Type":255, "ValidationRegex":"String content", "CategoryName":"String content", "DataTypeName":"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:complexType name="DTO_ContactFieldListRequest"> <xs:sequence> <xs:element minOccurs="0" name="Credentials" nillable="true" type="tns:DTO_JWTCredentials" /> <xs:element minOccurs="0" name="Type" type="xs:unsignedByte" /> </xs:sequence> </xs:complexType> <xs:element name="DTO_ContactFieldListRequest" nillable="true" type="tns:DTO_ContactFieldListRequest" /> <xs:complexType name="DTO_JWTCredentials"> <xs:sequence> <xs:element minOccurs="0" name="AccountID" type="xs:long" /> <xs:element minOccurs="0" name="IdentityToken" nillable="true" type="xs:string" /> <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_JWTCredentials" nillable="true" type="tns:DTO_JWTCredentials" /> </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/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_ContactFieldListResponse"> <xs:sequence> <xs:element minOccurs="0" name="FieldList" nillable="true" type="tns:ArrayOfDTO_ContactFieldDetail" /> <xs:element minOccurs="0" name="Result" nillable="true" type="tns:DTO_Result" /> </xs:sequence> </xs:complexType> <xs:element name="DTO_ContactFieldListResponse" nillable="true" type="tns:DTO_ContactFieldListResponse" /> <xs:complexType name="ArrayOfDTO_ContactFieldDetail"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="DTO_ContactFieldDetail" nillable="true" type="tns:DTO_ContactFieldDetail" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDTO_ContactFieldDetail" nillable="true" type="tns:ArrayOfDTO_ContactFieldDetail" /> <xs:complexType name="DTO_ContactFieldDetail"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_ContactField"> <xs:sequence> <xs:element minOccurs="0" name="CategoryName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DataTypeName" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ContactFieldDetail" nillable="true" type="tns:DTO_ContactFieldDetail" /> <xs:complexType name="DTO_ContactField"> <xs:complexContent mixed="false"> <xs:extension base="tns:DTO_Base"> <xs:sequence> <xs:element minOccurs="0" name="Category_ID" type="xs:long" /> <xs:element minOccurs="0" name="DataType_ID" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="DedupGroupIndex" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ID" type="xs:long" /> <xs:element minOccurs="0" name="IsEncrypted" type="xs:boolean" /> <xs:element minOccurs="0" name="IsRequired" type="xs:boolean" /> <xs:element minOccurs="0" name="MaxLength" type="xs:int" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PURLIndex" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="Type" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="ValidationRegex" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="DTO_ContactField" nillable="true" type="tns:DTO_ContactField" /> <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>
<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>