Types

Types

findTypes

Find types based on their name

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key
Name	String	String to search for. If empty, all types will be returned
IgnoreAlias	Boolean	If the search should ignore types with aliases

Returns

Return	Type	Description
Types	Type[]	Array of all types (name and external id) matching the search criteria

Example

Request

XML

<tns:name></tns:name>
<tns:ignorealias>false</tns:ignorealias>

getTypes

Get types by external id

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key
Types	String[]	Array of external ids for the types to get
IgnoreAlias	Boolean	If the search should ignore types with aliases

Returns

Return	Type	Description
Types	Type[]	Array of all types matching the external ids provided

Example

Request

XML

<tns:types>
  <type>root</type>
</tns:types>
<tns:ignorealias>false</tns:ignorealias>

getTypeDefs

Get type defintions by external id

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key
Types	String[]	Array of external ids for the types to get definitions for
IgnoreAlias	Boolean	If the search should ignore types with aliases

Returns

Return	Type	Description
Types	TypeDef[]	Array of all type definitions (including sub types) matching the external ids provided

Example

Request

XML

<tns:types>
  <type>root</type>
</tns:types>
<tns:ignorealias>false</tns:ignorealias>

getSpecialTypes

Get core types based on classification (root, reservable, person, location)

Parameters

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key

Returns

Return	Type	Description
RootType	String[]	The root type from which all other types inherit
ReservableTypes	String[]	Types that can be part of a reservation
PersonTypes	String[]	Types representing a person
LocationTypes	String[]	Types representing a location

Example

Request

XML

-