General Reference

Components

Request Component

Defines a request which is sent to the API.

• Request Component

Task Component

A task which is sent within a request.

• Task Component

Response Component

The answer which is sent from the API.

• Response Component

Result Component

Defines the structure of the result of an answer.

• Result Component

Status Component

Defines the status of a request.

• Status Component

Message Component

Merges different values into one message.

• Message Component

View Component

Defines the scale of a search (inquire) request.

• View Component

Where Component

Contains the search criteria for a search.

• Where Component

Order Component

Defines the sort order of the search result.

• Order Component

Data Component

Component which collects a list of strings.

• Data Component

SimpleObject Component

Represents a simple object.

• SimpleObject Component

Enums

OperatorType Enum

Defines the supported comparison operators.

• OperatorType Enum

OrderType Enum

Defines the possible sort order.

• OrderType Enum