Get object types

Description

Retrieves all supported object types and their properties.

HTTP Method

GET

Path

/object/type/@all

Authentication

Does not require user authentication.

Parameters

No Parameters.

Error Codes

150000 ( Common )

An unhandled exception has occured.

Response Schema

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

  <xs:element name="objectTypes">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="objectType" nillable="true" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="id" type="xs:long"/>
              <xs:element name="name" type="xs:string"/>
              <xs:element name="hasParent" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasRule" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasCategory" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasSchedule" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasSpecialDisplay" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasLocation" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasMaxAttendance" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasOverBooking" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasOpenEnrollment" type="xs:boolean" minOccurs="0"/>
              <xs:element name="hasCollectObjectInParentWhenCollected" type="xs:boolean" minOccurs="0"/>
              <xs:element name="internal" type="xs:boolean" minOccurs="0"/>
              <xs:element name="position" type="xs:int" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectTypes xmlns="http://xsd.poken.com">
  <objectType>
    <id>1</id>
    <name>Product</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>1</position>
  </objectType>
  <objectType>
    <id>2</id>
    <name>Session</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>true</hasCategory>
    <hasSchedule>true</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>true</hasLocation>
    <internal>false</internal>
    <position>2</position>
  </objectType>
  <objectType>
    <id>4</id>
    <name>Place</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>4</position>
  </objectType>
  <objectType>
    <id>5</id>
    <name>Reward</name>
     <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>5</position>
  </objectType>
  <objectType>
    <id>6</id>
    <name>Activity</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>6</position>
  </objectType>
  <objectType>
    <id>7</id>
    <name>Achievement</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>7</position>
  </objectType>
  <objectType>
    <id>8</id>
    <name>Coupon</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>8</position>
  </objectType>
  <objectType>
    <id>9</id>
    <hasParent>false</hasParent>
    <name>Web Page</name>
    <hasRule>true</hasRule>
    <hasCategory>false</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>9</position>
  </objectType>
  <objectType>
    <id>10</id>
    <name>Event</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>true</hasCategory>
    <hasSchedule>true</hasSchedule>
    <hasSpecialDisplay>true</hasSpecialDisplay>
    <hasLocation>true</hasLocation>
    <internal>true</internal>
    <position>10</position>
  </objectType>
  <objectType>
    <id>11</id>
    <name>Speaker</name>
    <hasParent>true</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>true</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>false</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>11</position>
  </objectType>
  <objectType>
    <id>12</id>
    <name>Announcement</name>
    <hasParent>false</hasParent>
    <hasRule>true</hasRule>
    <hasCategory>true</hasCategory>
    <hasSchedule>true</hasSchedule>
    <hasSpecialDisplay>true</hasSpecialDisplay>
    <hasLocation>true</hasLocation>
    <internal>false</internal>
    <position>12</position>
  </objectType>
  <objectType>
    <id>13</id>
    <name>Meeting</name>
    <hasParent>false</hasParent>
    <hasRule>false</hasRule>
    <hasCategory>true</hasCategory>
    <hasSchedule>true</hasSchedule>
    <hasSpecialDisplay>true</hasSpecialDisplay>
    <hasLocation>true</hasLocation>
    <internal>false</internal>
    <position>13</position>
  </objectType>
  <objectType>
    <id>14</id>
    <name>Document</name>
    <hasParent>false</hasParent>
    <hasRule>false</hasRule>
    <hasCategory>true</hasCategory>
    <hasSchedule>false</hasSchedule>
    <hasSpecialDisplay>true</hasSpecialDisplay>
    <hasLocation>false</hasLocation>
    <internal>false</internal>
    <position>14</position>
  </objectType>
</objectTypes>