Reference for http://api.123-txt.com/Api123WCF.svc/rest/Contact/Properties
Retrieve list of valid properties associated with a client.
Url: http://api.123-txt.com/Api123WCF.svc/rest/Contact/Properties
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:
<JsonUserApiCredentials xmlns="http://schemas.datacontract.org/2004/07/Contacts.JSON.General"> <Pass>String content</Pass> <User>String content</User> </JsonUserApiCredentials>
The following is an example request Json body:
{ "Pass":"String content", "User":"String content" }
The following is an example response Xml body:
<ArrayOfJsonContactPropertyDefinition xmlns="http://schemas.datacontract.org/2004/07/Contacts.JSON.General"> <JsonContactPropertyDefinition> <Confidential>true</Confidential> <Description>String content</Description> <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id> <Name>String content</Name> <Order>2147483647</Order> <RecordCreationDate>String content</RecordCreationDate> <SystemDefined>true</SystemDefined> <Type>255</Type> <UserId>1627aea5-8e0a-4371-9022-9b504344e724</UserId> <canTruncate>true</canTruncate> <capitalisation>255</capitalisation> <truncateLength>32767</truncateLength> </JsonContactPropertyDefinition> <JsonContactPropertyDefinition> <Confidential>true</Confidential> <Description>String content</Description> <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id> <Name>String content</Name> <Order>2147483647</Order> <RecordCreationDate>String content</RecordCreationDate> <SystemDefined>true</SystemDefined> <Type>255</Type> <UserId>1627aea5-8e0a-4371-9022-9b504344e724</UserId> <canTruncate>true</canTruncate> <capitalisation>255</capitalisation> <truncateLength>32767</truncateLength> </JsonContactPropertyDefinition> </ArrayOfJsonContactPropertyDefinition>
The following is an example response Json body:
[{ "Confidential":true, "Description":"String content", "Id":"1627aea5-8e0a-4371-9022-9b504344e724", "Name":"String content", "Order":2147483647, "RecordCreationDate":"String content", "SystemDefined":true, "Type":255, "UserId":"1627aea5-8e0a-4371-9022-9b504344e724", "canTruncate":true, "capitalisation":255, "truncateLength":32767 }]
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Contacts.JSON.General" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Contacts.JSON.General" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="JsonUserApiCredentials"> <xs:sequence> <xs:element minOccurs="0" name="Pass" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="User" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="JsonUserApiCredentials" nillable="true" type="tns:JsonUserApiCredentials" /> </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/Contacts.JSON.General" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Contacts.JSON.General" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="ArrayOfJsonContactPropertyDefinition"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="JsonContactPropertyDefinition" nillable="true" type="tns:JsonContactPropertyDefinition" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfJsonContactPropertyDefinition" nillable="true" type="tns:ArrayOfJsonContactPropertyDefinition" /> <xs:complexType name="JsonContactPropertyDefinition"> <xs:sequence> <xs:element minOccurs="0" name="Confidential" type="xs:boolean" /> <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Id" type="ser:guid" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Order" type="xs:int" /> <xs:element minOccurs="0" name="RecordCreationDate" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SystemDefined" type="xs:boolean" /> <xs:element minOccurs="0" name="Type" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="UserId" type="ser:guid" /> <xs:element minOccurs="0" name="canTruncate" type="xs:boolean" /> <xs:element minOccurs="0" name="capitalisation" type="xs:unsignedByte" /> <xs:element minOccurs="0" name="truncateLength" nillable="true" type="xs:short"> <xs:annotation> <xs:appinfo> <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" /> </xs:appinfo> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="JsonContactPropertyDefinition" nillable="true" type="tns:JsonContactPropertyDefinition" /> </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>