Retrieve Object extra contents

Description

This method provides a way to retrieve an object's extra contents. (Please note, the response can be quite big if the object contains many text aditional contents and there is no filtering o a certain content)

HTTP Method

GET

Path

/object/{objectId}/contents

Authentication

Does not require user authentication.

Parameters

Table 41.  Parameters for " Retrieve Object extra contents "

NameTypeValue TypeDescription
objectIdPATHlongThe id of the object.
objectContentIdQUERYlong(optional) the object content ID. If provided , only that object content will be returned, otherwise, all object contents, base on other params, will be returned.
excludeBasicContentQUERYboolean(optional) if objectContentId not provided, and this param is 'true', basic extra contents are not returned.
showSpecialContentQUERYboolean(optional) if objectContentId not provided, and this param is 'true', special extra contents are returned (an example of special extra content are speakers linked to a session object)
objectTypeIdQUERYLong(optional) only object extra contents will be returned that have this provided object type ID.
categoryIdQUERYlong(optional) allows even more refining of the filtering to only return extra content objects that have this provided category ID.
displayMediaSizeQUERYString(optional) returns a thumbnail having just the image size.(supported formats

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="objectContents">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="content" type="tns:BaseObjectContent" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

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

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectContents xmlns="http://xsd.poken.com">
  <content>
    <objectContentId>1</objectContentId>
    <title>Sample Text content</title>
    <type>TEXT</type>
    <text>This is a simple plain text object content section</text>
    <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>
</objectContents>