Reference for http://api.123-txt.com/Api123WCF.svc/rest/ContactList

Retrieve paged list of contact lists associated with a client.

Url: http://api.123-txt.com/Api123WCF.svc/rest/ContactList

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:

<JsonApiContactGetContactListsRequest xmlns="http://schemas.datacontract.org/2004/07/Contacts.JSON.Requests">
  <Credentials>
    <Pass xmlns="http://schemas.datacontract.org/2004/07/Contacts.JSON.General">String content</Pass>
    <User xmlns="http://schemas.datacontract.org/2004/07/Contacts.JSON.General">String content</User>
  </Credentials>
  <PageNo>2147483647</PageNo>
  <PageSize>2147483647</PageSize>
</JsonApiContactGetContactListsRequest>

The following is an example request Json body:

{
	"Credentials":{
		"Pass":"String content",
		"User":"String content"
	},
	"PageNo":2147483647,
	"PageSize":2147483647
}

The following is an example response Xml body:

<ArrayOfJsonApiContactList xmlns="http://schemas.datacontract.org/2004/07/Contacts.JSON.General">
  <JsonApiContactList>
    <CanModify>true</CanModify>
    <Description>String content</Description>
    <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id>
    <Name>String content</Name>
    <OwnerUserId>1627aea5-8e0a-4371-9022-9b504344e724</OwnerUserId>
    <Type>255</Type>
  </JsonApiContactList>
  <JsonApiContactList>
    <CanModify>true</CanModify>
    <Description>String content</Description>
    <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id>
    <Name>String content</Name>
    <OwnerUserId>1627aea5-8e0a-4371-9022-9b504344e724</OwnerUserId>
    <Type>255</Type>
  </JsonApiContactList>
</ArrayOfJsonApiContactList>

The following is an example response Json body:

[{
	"CanModify":true,
	"Description":"String content",
	"Id":"1627aea5-8e0a-4371-9022-9b504344e724",
	"Name":"String content",
	"OwnerUserId":"1627aea5-8e0a-4371-9022-9b504344e724",
	"Type":255
}]

The following is the request Xml Schema:

<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Contacts.JSON.Requests" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Contacts.JSON.Requests" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.datacontract.org/2004/07/Contacts.JSON.General" />
  <xs:complexType name="JsonApiContactGetContactListsRequest">
    <xs:sequence>
      <xs:element name="Credentials" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/Contacts.JSON.General" type="q1:JsonUserApiCredentials" />
      <xs:element name="PageNo" type="xs:int" />
      <xs:element name="PageSize" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="JsonApiContactGetContactListsRequest" nillable="true" type="tns:JsonApiContactGetContactListsRequest" />
</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.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>

<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="ArrayOfJsonApiContactList">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="JsonApiContactList" nillable="true" type="tns:JsonApiContactList" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfJsonApiContactList" nillable="true" type="tns:ArrayOfJsonApiContactList" />
  <xs:complexType name="JsonApiContactList">
    <xs:sequence>
      <xs:element minOccurs="0" name="CanModify" 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="OwnerUserId" type="ser:guid" />
      <xs:element minOccurs="0" name="Type" type="xs:unsignedByte" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="JsonApiContactList" nillable="true" type="tns:JsonApiContactList" />
</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>