General Reference

The general reference describes the structure and elements of the requests, sent to the system, and of the system requests.

Requests - Elements and Structure

Request Element

Defines a request which is sent to the API.

• Request Element

Task Element

Defines the task element which is part of arequest.

• Task Element

View Element

Defines the scale of a search (inquire) request.

• View Element

Where Element

Contains the search criteria for a search.

• Where Element

Order Element

Defines the sort order of the search result.

• Order Element

SimpleObject Element

Represents a simple object.

• SimpleObject Element

OperatorType Enum

Defines the supported comparison operators.

• OperatorType Enum

OrderType Enum

Defines the possible sort order.

• OrderType Enum

Response - Elements and Structure

Response Element

The answer which is sent from the API.

• Response Element

Result Element

Defines the structure of the result of an answer.

• Result Element

Status Element

Defines the status of a request.

• Status Element

Message Element

Merges different values into one message.

• Message Element

Data Element

Element which collects a list of strings.

• Data Element