Expose Service schemas

The Expose namespace has common entities to all other namespaces or things that does not fit under any other namespace.

ErrorMessages

No entities. See NameValue

File

An Entity used where information about files are needed.

Id
integer <int32>

The internal id of the File.

Type
integer <int32>

The type id of the File. Depending on context and Client. Can be used by Applications to differentiate files for different usages.

Name
string

The Name of the File. MaxLength: 50

Description
string

The Description of the File. MaxLength: max

Key
string or null <guid>

A unique id for the File at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

IdNameDescription

An Entity used where Id, Name and Description is needed. It also has an optional ImageKey that gets populated when existing. Mostly used for lookup data.

Id
integer <int32>

The internal Id of the Entity.

Name
string

The Name of the Entity. MaxLength: 50

Description
string

The Description of the Entity. MaxLength: 500

ImageKey
string or null <guid>

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Code
string

The Code of the Entity. MaxLength: 50

IdValue

An Entity used where Id and Value is needed. Mostly used for lookup data.

Id
integer <int32>

The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

Value
string

The Value of the Entity. MaxLength: max

Code
string

The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255

NameValue

An Entity used where Name and Value is needed. Mostly used for lookup data.

Name
string

The Name of the Entity. MaxLength: 50

Value
string

The Value of the Entity. MaxLength: max

Ping

No entities.

Process

No entities.