Get Card Content

Description

This method provides a way to retrieve the card design for a specified identity.

HTTP Method

GET

Path

/cards/{accountId}/identity/{identityId}/content

Authentication

Requires an authenticated user.

Parameters

Table 19.  Parameters for " Get Card Content "

NameTypeValue TypeDescription
accountIdPATHlongThe account id of the identity to retrieve the card design for.
identityIdPATHlongThe identity id of the identity to retrieve the card design for.

Error Codes

110000 ( Cards )

An unhanded exception occured.

110002 ( Cards )

No card content object found.

150001 ( Common )

The endpoint requires an authenticated account

40007 ( Identity )

Don't have the permission to access the identity.

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="card">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseCard">
          <xs:sequence>
            <xs:element name="campaign" type="xs:string" minOccurs="0"/>
            <xs:element name="line" type="tns:CardLine" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:element name="cardContent">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseCard">
          <xs:sequence>
            <xs:element name="line" type="tns:CardContentLine" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
            <xs:element name="socialNetworks">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="order" type="xs:string"/>
                  <xs:element name="network" type="tns:SNDetail" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="BaseCard">
    <xs:sequence>
      <xs:element name="accountId" type="xs:long" minOccurs="0"/>
      <xs:element name="identityId" type="xs:long" minOccurs="0"/>
      <xs:element name="campaignId" type="xs:long" minOccurs="0"/>
      <xs:element name="headerColor" type="xs:string" minOccurs="0"/>
      <xs:element name="textColor" type="xs:string"/>
      <xs:element name="backgroundCardUrl" type="xs:string" minOccurs="0"/>
      <xs:element name="thumbnailUrl" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="CardContentLine">
    <xs:sequence>
      <xs:element name="elements" type="tns:CardContentLineElement" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="CardContentLineElement">
    <xs:sequence>
      <xs:element name="index" type="xs:int" minOccurs="0"/>
      <xs:element name="osCoordinate" type="tns:OSCoordinateEnum"/>
      <xs:element name="values" type="tns:e" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="e">
    <xs:sequence/>
    <xs:attribute name="key" type="xs:string"/>
    <xs:attribute name="value" type="xs:string"/>
  </xs:complexType>

  <xs:complexType name="SNDetail">
    <xs:sequence>
      <xs:element name="id" type="xs:long"/>
      <xs:element name="nameId" type="xs:string"/>
      <xs:element name="addFriendUrl" type="xs:string"/>
      <xs:element name="viewFriendUrl" type="xs:string"/>
      <xs:element name="loginParameters">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="loginParameter" type="tns:LoginParameter" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LoginParameter">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="value" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="CardLine">
    <xs:sequence>
      <xs:element name="element" type="tns:CardLineElement" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="CardLineElement">
    <xs:sequence>
      <xs:element name="index" type="xs:int" nillable="true"/>
      <xs:element name="osCoordinate" type="tns:OSCoordinateEnum"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="OSCoordinateEnum">
    <xs:restriction base="xs:string">
      <xs:enumeration value="_Undefined"/>
      <xs:enumeration value="Headline"/>
      <xs:enumeration value="AboutMe"/>
      <xs:enumeration value="Name_Nickname"/>
      <xs:enumeration value="Name_HonorificPrefix"/>
      <xs:enumeration value="Name_GivenName"/>
      <xs:enumeration value="Name_AdditionalName"/>
      <xs:enumeration value="Name_FamilyName"/>
      <xs:enumeration value="Name_Birthday"/>
      <xs:enumeration value="Organization_Name"/>
      <xs:enumeration value="Organization_Title"/>
      <xs:enumeration value="Organization_Department"/>
      <xs:enumeration value="Organization_Industry"/>
      <xs:enumeration value="Organization_Category"/>
      <xs:enumeration value="Organization_Specialty"/>
      <xs:enumeration value="Organization_Region"/>
      <xs:enumeration value="CurrentLocation_StreetAddress"/>
      <xs:enumeration value="CurrentLocation_PostalCode"/>
      <xs:enumeration value="CurrentLocation_Locality"/>
      <xs:enumeration value="CurrentLocation_State"/>
      <xs:enumeration value="CurrentLocation_Country"/>
      <xs:enumeration value="URL"/>
      <xs:enumeration value="Email"/>
      <xs:enumeration value="Phone"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cardContent xmlns="http://xsd.poken.com">
  <accountId>614323</accountId>
  <identityId>614083</identityId>
  <campaignId>123</campaignId>
  <headerColor>#FFFFFF</headerColor>
  <textColor>#FEFEFE</textColor>
  <backgroundCardUrl>
    http://localhost/pokenfiles/profile2/f/2/b/9/614323gadd695_327x217.jpg
  </backgroundCardUrl>
  <thumbnailUrl>http://udata.doyoupoken.com/faces/f/2/b/9/614323g7bef9b.jpg
  </thumbnailUrl>
  <line>
    <elements>
      <index xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:nil="true" />
      <osCoordinate>Name_GivenName</osCoordinate>
      <values value="Tigruta" key="givenName" />
    </elements>
    <elements>
      <index xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:nil="true" />
      <osCoordinate>Name_FamilyName</osCoordinate>
      <values value="Tigrisor" key="familyName" />
    </elements>
  </line>
  <line />
  <line />
  <line>
    <elements>
      <index xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:nil="true" />
      <osCoordinate>CurrentLocation_Country
      </osCoordinate>
      <values value="RO" key="country" />
    </elements>
  </line>
  <line>
    <elements>
      <index>0</index>
      <osCoordinate>Email</osCoordinate>
      <values value="pcbdfsdfdan@yahoo.com" key="value" />
    </elements>
  </line>
  <line />
  <line />
  <socialNetworks>
    <order></order>
    <network>
      <id>12471669168</id>
      <nameId>facebook</nameId>
      <addFriendUrl>http://www.facebook.com/addfriend.php?id=15877036
      </addFriendUrl>
      <viewFriendUrl>http://www.facebook.com/profile.php?id=15877036&amp;ref=nf</viewFriendUrl>
      <loginParameters>
  <loginParameter>
    <name>NAME</name>
    <value>http://www.facebook.com/profile.php?id=1587797036&amp;ref=nf</value>
    </loginParameter>
  <loginParameter>
    <name>EMAIL</name>
    <value>http://www.facebook.com/profile.php?id=1587797036&amp;ref=nf</value>
    </loginParameter>
  </loginParameters>
 </network>
    <network>
  <id>1251120732806</id>
  <nameId>talk_msn</nameId>
  <addFriendUrl></addFriendUrl>
  <viewFriendUrl>http://spaces.live.com/profile.aspx?mem=test
  </viewFriendUrl>
  <loginParameters>
    <loginParameter>
      <name>NAME</name>
      <value>test</value>
    </loginParameter>
    <loginParameter>
      <name>EMAIL</name>
      <value>test</value>
    </loginParameter>
  </loginParameters>
</network>
  <network>
    <id>1251135765180</id>
    <nameId>badoo</nameId>
    <addFriendUrl></addFriendUrl>
    <viewFriendUrl>http://www.badoo.com/3423423
    </viewFriendUrl>
    <loginParameters>
      <loginParameter>
        <name>NAME</name>
        <value>3423423</value>
      </loginParameter>
      <loginParameter>
        <name>EMAIL</name>
        <value>3423423</value>
      </loginParameter>
    </loginParameters>
  </network>
  <network>
    <id>1251187932332</id>
    <nameId>ameba</nameId>
    <addFriendUrl></addFriendUrl>
    <viewFriendUrl>http://ameblo.jp/kitycat
    </viewFriendUrl>
    <loginParameters>
      <loginParameter>
        <name>NAME</name>
        <value>kitycat</value>
      </loginParameter>
      <loginParameter>
        <name>EMAIL</name>
        <value>kitycat</value>
      </loginParameter>
    </loginParameters>
  </network>
  </socialNetworks>
</cardContent>