Retrieve Object

Description

This method provides a way to retrieve an object details.

HTTP Method

GET

Path

/object/{objectId}

Authentication

Does not require user authentication.

Parameters

Table 40.  Parameters for " Retrieve Object "

NameTypeValue TypeDescription
objectIdPATHlongThe id of the object.
forEditQUERYboolean(optional) 'true' if the object should be retrieved for editing, you need to own the object for this to work
extraContentQUERYboolean(optional) 'true' if the additional content should be retrieved
specialExtraContentQUERYboolean(optional) 'true' if the special additional content should be retrieved
showObjectReferencesQUERYboolean(optional) 'true' if objects referencing the current object should be retrieved
objectTypeIdQUERYLong(optional) only applies if 'showObjectReferences' is 'true', it will only return objects referencing this object and which have the specified object type ID
categoryIdQUERYlong(optional) only applies if 'showObjectReferences' is 'true', it will only return objects referencing this object in which the current object has the specified object category id
displayMediaSizeQUERYString(optional) returns a thumbnail having just the image size.(supported formats; xs,s,s2,m,l,xl . Default is 's2')
includeDeletedQUERYboolean(optional) 'true' to retrieve also if the object is deleted (default is 'false' )

Error Codes

130000 ( Object )

An unhanded exception occured.

130006 ( Object )

The oject Id specified does not exist.

130017 ( Object )

No permission to access the required object

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="object">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseObject">
          <xs:sequence>
            <xs:element name="points" type="xs:int"/>
            <xs:element name="publicUrl" type="xs:anyURI"/>
            <xs:element name="devices" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="device" nillable="true" minOccurs="0" maxOccurs="unbounded">
                    <xs:complexType>
                      <xs:sequence>
                        <xs:element name="id" type="xs:long"/>
                        <xs:element name="name" type="xs:string" minOccurs="0"/>
                      </xs:sequence>
                    </xs:complexType>
                  </xs:element>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="connection" type="tns:BaseObjectConnection" minOccurs="0"/>
            <xs:element name="extraContent" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="content" type="tns:BaseObjectContent" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="referencedByObjects" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="refObject" type="tns:ReferencingObject" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:element name="objectConnection">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseObjectConnection">
          <xs:sequence>
            <xs:element name="viewerAccountId" type="xs:long"/>
            <xs:element name="accountId" type="xs:long"/>
            <xs:element name="objectId" type="xs:long"/>
            <xs:element name="collectedCount" type="xs:long" minOccurs="0"/>
            <xs:element name="objectUpdatedDate" type="xs:dateTime" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:element name="objectMediaItem">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:MediaItem">
          <xs:sequence>
            <xs:element name="defaultMedia" type="xs:boolean" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="BaseObject">
    <xs:sequence>
      <xs:element name="objectId" type="xs:long"/>
      <xs:element name="accountId" type="xs:long"/>
      <xs:element name="campaignId" type="xs:long"/>
      <xs:element name="parentObjectId" type="xs:long" minOccurs="0"/>
      <xs:element name="ownerName" type="xs:string"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
      <xs:element name="contentName" type="xs:string"/>
      <xs:element name="link" type="xs:anyURI"/>
      <xs:element name="objectType" type="xs:string"/>
      <xs:element name="objectTypeId" type="xs:long"/>
      <xs:element name="visibility" type="xs:string"/>
      <xs:element name="deleted" type="xs:boolean" minOccurs="0"/>
      <xs:element name="refereceNo" type="xs:string" minOccurs="0"/>
      <xs:element name="referenceNo" type="xs:string" minOccurs="0"/>
      <xs:element name="group" type="xs:string" minOccurs="0"/>
      <xs:element name="createdDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="updatedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="numComments" type="xs:long" minOccurs="0"/>
      <xs:element name="numMedia" type="xs:long" minOccurs="0"/>
      <xs:element name="collectedCount" type="xs:long" minOccurs="0"/>
      <xs:element name="allowPostingComments" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowOverBooking" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowOpenEnrollment" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowIncludeInRegistration" type="xs:boolean" minOccurs="0"/>
      <xs:element name="shareContactInfo" type="xs:boolean" minOccurs="0"/>
      <xs:element name="startDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="endDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="timezoneId" type="xs:long" minOccurs="0"/>
      <xs:element name="maxAttendance" type="xs:long"/>
      <xs:element name="location" type="xs:string" minOccurs="0"/>
      <xs:element name="notes" type="xs:string" minOccurs="0"/>
      <xs:element name="displayType" type="xs:string" minOccurs="0"/>
      <xs:element name="socialNetworks" type="tns:SocialNetwork" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="defaultMediaItem" type="xs:long"/>
      <xs:element name="mediaItems" type="tns:MediaItem" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="facebookLikeInteraction" type="tns:FacebookLikeInteraction" minOccurs="0"/>
      <xs:element name="twitterFollowInteraction" type="tns:TwitterFollowInteraction" minOccurs="0"/>
      <xs:element name="comments" type="tns:Comment" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="barcodeUrl" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="category" type="tns:BaseObjectCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="systemCategory" type="tns:BaseObjectCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="BaseObjectConnection">
    <xs:sequence>
      <xs:element name="type" type="xs:string"/>
      <xs:element name="status" type="xs:string"/>
      <xs:element name="note" type="xs:string"/>
      <xs:element name="keywords" type="tns:Keywords" minOccurs="0"/>
      <xs:element name="firstCollectedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="lastCollectedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="firstViewedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="lastViewedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="latitude" type="xs:double" minOccurs="0"/>
      <xs:element name="longitude" type="xs:double" minOccurs="0"/>
      <xs:element name="favorite" type="xs:boolean" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="Keywords">
    <xs:sequence>
      <xs:element name="keyword" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="BaseObjectContent">
    <xs:sequence>
      <xs:element name="objectContentId" type="xs:long"/>
      <xs:element name="title" type="xs:string"/>
      <xs:element name="type" type="xs:string"/>
      <xs:element name="typeInfo1" type="xs:string" minOccurs="0"/>
      <xs:element name="typeInfo2" type="xs:string" minOccurs="0"/>
      <xs:element name="targetId" type="xs:long" minOccurs="0"/>
      <xs:element name="categoryId" type="xs:long" minOccurs="0"/>
      <xs:element name="text" type="xs:string" minOccurs="0"/>
      <xs:element name="thumbnail" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="startDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="endDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="special" type="xs:boolean" minOccurs="0"/>
      <xs:element name="deleted" type="xs:boolean" minOccurs="0"/>
      <xs:element name="position" type="xs:int"/>
      <xs:element name="categories" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="category" type="tns:BaseObjectContentCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="systemCategories" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="category" type="tns:BaseObjectContentCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="BaseObjectContentCategory">
    <xs:sequence>
      <xs:element name="categoryId" type="xs:long"/>
      <xs:element name="systemPath" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="ReferencingObject">
    <xs:sequence>
      <xs:element name="objectId" type="xs:long"/>
      <xs:element name="campaignId" type="xs:long"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="objectType" type="xs:string"/>
      <xs:element name="objectTypeId" type="xs:long"/>
      <xs:element name="category" type="tns:BaseObjectCategory" minOccurs="0"/>
      <xs:element name="categories" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="category" type="tns:BaseObjectCategory" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="systemCategories" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="category" type="tns:BaseObjectCategory" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="startDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="endDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="timezoneId" type="xs:long" minOccurs="0"/>
      <xs:element name="thumbnail" type="xs:anyURI" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="BaseObjectCategory">
    <xs:sequence>
      <xs:element name="id" type="xs:long"/>
      <xs:element name="parentId" type="xs:long" minOccurs="0"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="namePlural" type="xs:string"/>
      <xs:element name="system" type="xs:boolean" minOccurs="0"/>
      <xs:element name="systemPath" type="xs:string" minOccurs="0"/>
      <xs:element name="position" type="xs:int"/>
      <xs:element name="badgeColor" type="xs:string" minOccurs="0"/>
      <xs:element name="usedCount" type="xs:long" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="SocialNetwork">
    <xs:sequence>
      <xs:element name="id" type="xs:long"/>
      <xs:element name="socialNetworkId" type="xs:long"/>
      <xs:element name="profileURL" type="xs:string"/>
      <xs:element name="remoteId" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="MediaItem">
    <xs:sequence>
      <xs:element name="mediaItemid" type="xs:long"/>
      <xs:element name="source" type="xs:string"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="mediatype" type="xs:string"/>
      <xs:element name="extRefId" type="xs:string"/>
      <xs:element name="images" type="tns:Image" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="Image">
    <xs:sequence>
      <xs:element name="source" type="xs:string"/>
      <xs:element name="height" type="xs:long"/>
      <xs:element name="width" type="xs:long"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="FacebookLikeInteraction">
    <xs:sequence>
      <xs:element name="websitePageToLike" type="xs:string"/>
      <xs:element name="displayFriendlyMessage" type="xs:boolean" minOccurs="0"/>
      <xs:element name="friendlyMessage" type="xs:string"/>
      <xs:element name="canSendPage" type="xs:boolean" minOccurs="0"/>
      <xs:element name="showCount" type="xs:boolean" minOccurs="0"/>
      <xs:element name="showFaces" type="xs:boolean" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="TwitterFollowInteraction">
    <xs:sequence>
      <xs:element name="twitterUsername" type="xs:string"/>
      <xs:element name="displayFriendlyMessage" type="xs:boolean" minOccurs="0"/>
      <xs:element name="friendlyMessage" type="xs:string"/>
      <xs:element name="showCount" type="xs:boolean" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="Comment">
    <xs:sequence>
      <xs:element name="commentId" type="xs:long"/>
      <xs:element name="text" type="xs:string"/>
      <xs:element name="createdDate" type="xs:dateTime"/>
      <xs:element name="accountId" type="xs:long"/>
      <xs:element name="displayName" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="ConnectionType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Contact"/>
      <xs:enumeration value="Object"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ConnectionStatus">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Uncollected"/>
      <xs:enumeration value="New"/>
      <xs:enumeration value="Collected"/>
      <xs:enumeration value="Sponsor"/>
      <xs:enumeration value="Demo"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ObjectContentType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Text"/>
      <xs:enumeration value="Object"/>
      <xs:enumeration value="Person"/>
    </xs:restriction>
  </xs:simpleType>

  <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:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object xmlns="http://xsd.poken.com">
		<objectId>22620170</objectId>
		<accountId>21628434</accountId>
		<campaignId>19116504</campaignId>
		<name>Nokia C7</name>
		<description>The Nokia C7-00 is a powerful combination of internet, video,
				photos, music, maps with Symbian^3 operating system.</description>
		<link>http://www.nokia.ch/produits/tous-les-modeles/nokia-c7-00/specifications
		</link>
		<objectType>Product</objectType>
		<visibility>CONTACTS</visibility>
		<createdDate>2011-03-09T09:46:38.649+01:00</createdDate>
		<updatedDate>2011-07-29T17:14:53.215+02:00</updatedDate>
		<numComments>58</numComments>
		<numMedia>5</numMedia>
		<collectedCount>9</collectedCount>
		<defaultMediaItem>22619927</defaultMediaItem>
		<socialNetworks>
				<id>22607918</id>
				<socialNetworkId>54</socialNetworkId>
				<profileURL>http://twitter.com/j_dumm</profileURL>
				<remoteId>j_dumm</remoteId>
		</socialNetworks>
		<socialNetworks>
				<id>41081888</id>
				<socialNetworkId>35</socialNetworkId>
				<profileURL>skype:j_dumm?add</profileURL>
				<remoteId>j_dumm</remoteId>
		</socialNetworks>
		<mediaItems>
				<mediaItemid>22619926</mediaItemid>
				<source>http://www.nokia.ch/produits/tous-les-modeles/nokia-c7-00/specifications
				</source>
				<name>Specifications</name>
				<mediatype>LINK</mediatype>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/700x700.png
						</source>
						<height>700</height>
						<width>700</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/300x300.png
						</source>
						<height>300</height>
						<width>300</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/150x150.png
						</source>
						<height>150</height>
						<width>150</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/100x100.png
						</source>
						<height>100</height>
						<width>100</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/75x75.png
						</source>
						<height>75</height>
						<width>75</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/30x30.png
						</source>
						<height>30</height>
						<width>30</width>
				</images>
		</mediaItems>
		<mediaItems>
				<mediaItemid>22619941</mediaItemid>
				<source>https://d3759s1c6gf66q.cloudfront.net/u/21628434/22620170/PBRC7G6pcrR2h2EppsGuKceXVRp2/C7datasheet
				</source>
				<name>C7 datasheet</name>
				<mediatype>application/pdf</mediatype>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/700x700.png
						</source>
						<height>700</height>
						<width>700</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/300x300.png
						</source>
						<height>300</height>
						<width>300</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/150x150.png
						</source>
						<height>150</height>
						<width>150</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/100x100.png
						</source>
						<height>100</height>
						<width>100</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/75x75.png
						</source>
						<height>75</height>
						<width>75</width>
				</images>
				<images>
						<source>http://test-media.poken.com.s3.amazonaws.com/u/default-images/30x30.png
						</source>
						<height>30</height>
						<width>30</width>
				</images>
		</mediaItems>
		<comments>
				<commentId>45828519</commentId>
				<text>Super</text>
				<createdDate>2012-01-03T15:00:39.450+02:00</createdDate>
				<accountId>22599605</accountId>
				<displayName>Anna DeLuca</displayName>
		</comments>
		<comments>
				<commentId>45810524</commentId>
				<text>Relaxing</text>
				<createdDate>2011-12-29T12:38:40.750+02:00</createdDate>
				<accountId>22599605</accountId>
				<displayName>Anna DeLuca</displayName>
		</comments>
		<allowPostingComments>true</allowPostingComments>
		<points>0</points>
		<connection>
				<type>Object</type>
				<status>New</status>
				<firstCollectedDate>2011-03-09T11:08:32.997+01:00</firstCollectedDate>
				<lastCollectedDate>2011-03-09T11:08:32.997+01:00</lastCollectedDate>
				<favorite>false</favorite>
		</connection>
		<FacebookLikeInteraction>
				<websitePageToLike>http://www.poken.com</websitePageToLike>
				<displayFriendlyMessage>true</displayFriendlyMessage>
				<friendlyMessage>Like us on Facebook!</friendlyMessage>
				<canSendPage>false</canSendPage>
				<showCount>true</showCount>
				<showFaces>true</showFaces>
		</FacebookLikeInteraction>
		<TwitterFollowInteraction>
				<twitterUsername>poken</twitterUsername>
				<displayFriendlyMessage>true</displayFriendlyMessage>
				<friendlyMessage>follow us on Twitter!</friendlyMessage>
				<showCount>true</showCount>
		</TwitterFollowInteraction>
		 <extraContent>
		    <content>
		      <objectContentId>1</objectContentId>
		      <title>Sample Text content</title>
		      <type>TEXT</type>
		      <position>1</position>
		    </content>
		    <content>
		      <objectContentId>2</objectContentId>
		      <title>Ref to Object</title>
		      <type>OBJECT</type>
		      <targetId>64063633</targetId>
		      <position>2</position>
		    </content>
		    <content>
		      <objectContentId>3</objectContentId>
		      <title>Ref to Person</title>
		      <type>PERSON</type>
		      <targetId>614323</targetId>
		      <position>3</position>
		    </content>
		  </extraContent>
		   <referencedByObjects>
		    <refObject>
		      <objectId>76272001</objectId>
		      <campaignId>1736703</campaignId>
		      <name>test speaker session</name>
		      <objectType>Conference Session</objectType>
		      <objectTypeId>2</objectTypeId>
		    </refObject>
		  </referencedByObjects> 
</object>