Reference for http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipients?email={EMAIL}&sms={SMS}

Retrieve recipients' information.

Url: http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipients?email={EMAIL}&sms={SMS}

HTTP Method: GET

This operation supports JSONP responses. The callback function can be specified using the "callback" Url query parameter.

Message direction Format Body
Request N/A The Request body is empty.
Response Xml Example,Schema
Response Json Example

The following is an example response Xml body:

<CollectionOfConsoleRecipientDetailsItem xmlns="http://MailupSoa.Ws.Schema.API">
  <IsPaginated>true</IsPaginated>
  <Items>
    <ConsoleRecipientDetailsItem xmlns="http://MailupSoa.Ws.Schema.API.Console">
      <Fields>
        <ConsoleRecipientDynamicFieldItem>
          <Description>String content</Description>
          <Id>2147483647</Id>
          <Value>String content</Value>
        </ConsoleRecipientDynamicFieldItem>
        <ConsoleRecipientDynamicFieldItem>
          <Description>String content</Description>
          <Id>2147483647</Id>
          <Value>String content</Value>
        </ConsoleRecipientDynamicFieldItem>
      </Fields>
      <Name>String content</Name>
      <idRecipient>2147483647</idRecipient>
      <Email>String content</Email>
      <MobileNumber>String content</MobileNumber>
      <MobilePrefix>String content</MobilePrefix>
      <PendingOnEmailChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </PendingOnEmailChannel>
      <PendingOnSmsChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </PendingOnSmsChannel>
      <SubscribedOnEmailChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </SubscribedOnEmailChannel>
      <SubscribedOnSmsChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </SubscribedOnSmsChannel>
      <UnsubscribedOnEmailChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </UnsubscribedOnEmailChannel>
      <UnsubscribedOnSmsChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </UnsubscribedOnSmsChannel>
    </ConsoleRecipientDetailsItem>
    <ConsoleRecipientDetailsItem xmlns="http://MailupSoa.Ws.Schema.API.Console">
      <Fields>
        <ConsoleRecipientDynamicFieldItem>
          <Description>String content</Description>
          <Id>2147483647</Id>
          <Value>String content</Value>
        </ConsoleRecipientDynamicFieldItem>
        <ConsoleRecipientDynamicFieldItem>
          <Description>String content</Description>
          <Id>2147483647</Id>
          <Value>String content</Value>
        </ConsoleRecipientDynamicFieldItem>
      </Fields>
      <Name>String content</Name>
      <idRecipient>2147483647</idRecipient>
      <Email>String content</Email>
      <MobileNumber>String content</MobileNumber>
      <MobilePrefix>String content</MobilePrefix>
      <PendingOnEmailChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </PendingOnEmailChannel>
      <PendingOnSmsChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </PendingOnSmsChannel>
      <SubscribedOnEmailChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </SubscribedOnEmailChannel>
      <SubscribedOnSmsChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </SubscribedOnSmsChannel>
      <UnsubscribedOnEmailChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </UnsubscribedOnEmailChannel>
      <UnsubscribedOnSmsChannel>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
        <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">2147483647</int>
      </UnsubscribedOnSmsChannel>
    </ConsoleRecipientDetailsItem>
  </Items>
  <PageNumber>2147483647</PageNumber>
  <PageSize>2147483647</PageSize>
  <Skipped>2147483647</Skipped>
  <TotalElementsCount>2147483647</TotalElementsCount>
</CollectionOfConsoleRecipientDetailsItem>

The following is an example response Json body:

{
	"IsPaginated":true,
	"Items":[{
		"Fields":[{
			"Description":"String content",
			"Id":2147483647,
			"Value":"String content"
		}],
		"Name":"String content",
		"idRecipient":2147483647,
		"Email":"String content",
		"MobileNumber":"String content",
		"MobilePrefix":"String content",
		"PendingOnEmailChannel":[2147483647],
		"PendingOnSmsChannel":[2147483647],
		"SubscribedOnEmailChannel":[2147483647],
		"SubscribedOnSmsChannel":[2147483647],
		"UnsubscribedOnEmailChannel":[2147483647],
		"UnsubscribedOnSmsChannel":[2147483647]
	}],
	"PageNumber":2147483647,
	"PageSize":2147483647,
	"Skipped":2147483647,
	"TotalElementsCount":2147483647
}

The following is the response Xml Schema:

<xs:schema xmlns:tns="http://MailupSoa.Ws.Schema.API" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.Schema.API" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://MailupSoa.Ws.Schema.API.Console" />
  <xs:import namespace="http://MailupSoa.Ws.API.Schema" />
  <xs:complexType name="CollectionOfConsoleRecipientDetailsItem">
    <xs:annotation>
      <xs:appinfo>
        <GenericType Name="CollectionOf{0}" Namespace="http://MailupSoa.Ws.Schema.API" xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
          <GenericParameter Name="ConsoleRecipientDetailsItem" Namespace="http://MailupSoa.Ws.Schema.API.Console" />
        </GenericType>
      </xs:appinfo>
    </xs:annotation>
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q1="http://MailupSoa.Ws.API.Schema" base="q1:BaseDataContract">
        <xs:sequence>
          <xs:element name="IsPaginated" type="xs:boolean" />
          <xs:element minOccurs="0" name="Items" nillable="true" xmlns:q2="http://MailupSoa.Ws.Schema.API.Console" type="q2:ArrayOfConsoleRecipientDetailsItem" />
          <xs:element name="PageNumber" type="xs:int" />
          <xs:element name="PageSize" type="xs:int" />
          <xs:element name="Skipped" type="xs:int" />
          <xs:element name="TotalElementsCount" type="xs:int" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="CollectionOfConsoleRecipientDetailsItem" nillable="true" type="tns:CollectionOfConsoleRecipientDetailsItem" />
</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://MailupSoa.Ws.API.Schema" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.API.Schema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="BaseDataContract">
    <xs:sequence />
  </xs:complexType>
  <xs:element name="BaseDataContract" nillable="true" type="tns:BaseDataContract" />
</xs:schema>

<xs:schema xmlns:tns="http://MailupSoa.Ws.Schema.API.Console" elementFormDefault="qualified" targetNamespace="http://MailupSoa.Ws.Schema.API.Console" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <xs:import namespace="http://MailupSoa.Ws.API.Schema" />
  <xs:complexType name="ArrayOfConsoleRecipientDetailsItem">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="ConsoleRecipientDetailsItem" nillable="true" type="tns:ConsoleRecipientDetailsItem" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfConsoleRecipientDetailsItem" nillable="true" type="tns:ArrayOfConsoleRecipientDetailsItem" />
  <xs:complexType name="ConsoleRecipientDetailsItem">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:ConsoleRecipientItem">
        <xs:sequence>
          <xs:element name="PendingOnEmailChannel" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfint" />
          <xs:element name="PendingOnSmsChannel" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfint" />
          <xs:element name="SubscribedOnEmailChannel" nillable="true" xmlns:q3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q3:ArrayOfint" />
          <xs:element name="SubscribedOnSmsChannel" nillable="true" xmlns:q4="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q4:ArrayOfint" />
          <xs:element name="UnsubscribedOnEmailChannel" nillable="true" xmlns:q5="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q5:ArrayOfint" />
          <xs:element name="UnsubscribedOnSmsChannel" nillable="true" xmlns:q6="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q6:ArrayOfint" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="ConsoleRecipientDetailsItem" nillable="true" type="tns:ConsoleRecipientDetailsItem" />
  <xs:complexType name="ConsoleRecipientItem">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:BaseAnagraphicItem">
        <xs:sequence>
          <xs:element name="Email" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="MobileNumber" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="MobilePrefix" nillable="true" type="xs:string" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="ConsoleRecipientItem" nillable="true" type="tns:ConsoleRecipientItem" />
  <xs:complexType name="BaseAnagraphicItem">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q7="http://MailupSoa.Ws.API.Schema" base="q7:BaseDataContract">
        <xs:sequence>
          <xs:element minOccurs="0" name="Fields" nillable="true" type="tns:ArrayOfConsoleRecipientDynamicFieldItem" />
          <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
          <xs:element minOccurs="0" name="idRecipient" type="xs:int" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="BaseAnagraphicItem" nillable="true" type="tns:BaseAnagraphicItem" />
  <xs:complexType name="ArrayOfConsoleRecipientDynamicFieldItem">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="ConsoleRecipientDynamicFieldItem" nillable="true" type="tns:ConsoleRecipientDynamicFieldItem" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfConsoleRecipientDynamicFieldItem" nillable="true" type="tns:ArrayOfConsoleRecipientDynamicFieldItem" />
  <xs:complexType name="ConsoleRecipientDynamicFieldItem">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:ConsoleDynamicFieldItem">
        <xs:sequence>
          <xs:element name="Value" nillable="true" type="xs:string" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="ConsoleRecipientDynamicFieldItem" nillable="true" type="tns:ConsoleRecipientDynamicFieldItem" />
  <xs:complexType name="ConsoleDynamicFieldItem">
    <xs:complexContent mixed="false">
      <xs:extension xmlns:q8="http://MailupSoa.Ws.API.Schema" base="q8:BaseDataContract">
        <xs:sequence>
          <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
          <xs:element name="Id" type="xs:int" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="ConsoleDynamicFieldItem" nillable="true" type="tns:ConsoleDynamicFieldItem" />
</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="ArrayOfint">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" />
</xs:schema>

<xs:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="schema">
    <xs:complexType />
  </xs:element>
</xs:schema>