Get object system categories

Description

Retrieves a 2 level hierarchy of object system categories. The system category ID is unique inside of the first level and inside of every main object system category.

HTTP Method

GET

Path

/common/objectSysCat/@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:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="objectSystemCategories">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="category" type="tns:ObjectSystemCategory" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="ObjectSystemCategory">
    <xs:sequence>
      <xs:element name="systemPath" type="xs:string"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="position" type="xs:long"/>
      <xs:element name="category" type="tns:ObjectSystemCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectSystemCategories xmlns="http://xsd.poken.com">
		<category>
				<systemPath>/1</systemPath>
				<name>Invitation</name>
				<position>1</position>
				<category>
						<systemPath>/1/1</systemPath>
						<name>Requested</name>
						<position>1</position>
				</category>
				<category>
						<systemPath>/1/2</systemPath>
						<name>Declined</name>
						<position>2</position>
				</category>
				<category>
						<systemPath>/1/3</systemPath>
						<name>Tentative</name>
						<position>3</position>
				</category>
				<category>
						<systemPath>/1/4</systemPath>
						<name>Accepted</name>
						<position>4</position>
				</category>
		</category>
		<category>
				<systemPath>/2</systemPath>
				<name>Rating</name>
				<position>2</position>
				<category>
						<systemPath>/2/1</systemPath>
						<name>Very poor</name>
						<position>1</position>
				</category>
				<category>
						<systemPath>/2/2</systemPath>
						<name>Poor</name>
						<position>2</position>
				</category>
				<category>
						<systemPath>/2/3</systemPath>
						<name>Average</name>
						<position>3</position>
				</category>
				<category>
						<systemPath>/2/4</systemPath>
						<name>Good</name>
						<position>4</position>
				</category>
				<category>
						<systemPath>/2/5</systemPath>
						<name>Very good</name>
						<position>5</position>
				</category>
		</category>
		<category>
				<systemPath>/3</systemPath>
				<name>Attendance</name>
				<position>3</position>
				<category>
						<systemPath>/3/1</systemPath>
						<name>Attended</name>
						<position>1</position>
				</category>
				<category>
						<systemPath>/3/2</systemPath>
						<name>Not Attended</name>
						<position>2</position>
				</category>
		</category>
</objectSystemCategories>