Get Profile

Description

This method retrieves the users profile data.

HTTP Method

GET

Path

/account/profile

Authentication

Requires an authenticated user.

Parameters

No Parameters.

Error Codes

10000 ( Account )

An unhandled exception has occured.

10019 ( Account )

The account specified is invalid.

150001 ( Common )

The endpoint requires an authenticated account

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="profile">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountId" type="xs:long"/>
        <xs:element name="defaultIdentityId" type="xs:long"/>
        <xs:element name="alias" type="xs:string"/>
        <xs:element name="email" type="xs:string"/>
        <xs:element name="timezone" type="xs:string"/>
        <xs:element name="timezoneId" type="xs:long"/>
        <xs:element name="mobilePhone" type="xs:string" minOccurs="0"/>
        <xs:element name="mobilePhoneCountry" type="xs:string" minOccurs="0"/>
        <xs:element name="lang" type="xs:string"/>
        <xs:element name="country" type="xs:string"/>
        <xs:element name="autoLogin" type="xs:boolean" minOccurs="0"/>
        <xs:element name="visibility" type="xs:string"/>
        <xs:element name="geolocationEnabled" type="xs:boolean" minOccurs="0"/>
        <xs:element name="tagCollectEnabled" type="xs:boolean" minOccurs="0"/>
        <xs:element name="shareActivity" type="xs:boolean" minOccurs="0"/>
        <xs:element name="emailPrefs">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="emailRecentCollected" type="xs:string"/>
              <xs:element name="emailNetworkUpdates" type="xs:string"/>
              <xs:element name="emailEventUpdates" type="xs:boolean" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name="ProfileVisibility">
    <xs:restriction base="xs:string">
      <xs:enumeration value="CONTACTS"/>
      <xs:enumeration value="EVENT_PARTICIPANTS"/>
      <xs:enumeration value="PUBLIC"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="EmailFrequency">
    <xs:restriction base="xs:string">
      <xs:enumeration value="INHERITED"/>
      <xs:enumeration value="DAILY"/>
      <xs:enumeration value="WEEKLY"/>
      <xs:enumeration value="NO_EMAIL"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<profile xmlns="http://xsd.poken.com">
  <accountId>614323</accountId>
  <defaultIdentityId>614083</defaultIdentityId>
  <alias>tigruta</alias>
  <email>tigruta@pokken.com</email>
  <timezone>GMT+2</timezone>
  <lang>en</lang>
  <country>RO</country>
  <autoLogin>true</autoLogin>
  <visibility>PUBLIC</visibility>
  <geolocationEnabled>true</geolocationEnabled>
  <shareActivity>true</shareActivity>
  <emailPrefs>
    <emailRecentCollected>DAILY</emailRecentCollected>
    <emailNetworkUpdates>NO_EMAIL</emailNetworkUpdates>
    <emailEventUpdates>true</emailEventUpdates>
  </emailPrefs>
</profile>