nexxOMNIA API
Search…
Response Object
Each API Call will return in a Response Object, unimportant, if the Call was successfull or not or to which API Section it belongs. The Response Object will consist of a Metadata Part, a Data Part (for Single Items and Item List Calls) and an optional Paging Part (for Item List Calls only).

Result Metadata

Key
Format
Description
status
HTTP Code
The HTTP Status for this Call
apiversion
String
Version of the API
verb
String
the used HTTP Verb
processingtime
Float
internal Duration, needed to create the Response
calledwith
String
the called Endoint and Parameter
calledfor
String
The cfo Parameter from the API Call
fordomain
Integer
the calling Domain ID
fromstage
[0, 1]
The result was created by a Stage or Productive Server
errorhint
String
If the Call failed, a Hint for the Failure Reason

Result Data

Every successfull API Call will have a "result" Object, that contains the Result for this Call. Technically, there are three different API Types, who all return slightly different Result Types.
Please notice, that we cannot outline the concrete Structure of each API Call. As the Concept of Streamtypes and Output Modifiers makes it impossible to create an exhausting Description of every possible Result Data Set.

Single Item Call

An API Call for a single Media Item, for example /videos/byid/123. The Result Data will be an Object, which represents the Media Item.

Item List Call

An API Call for a list of Media Items, for example /videos/all. The Result Data will be an Array, which represents the Media Item.

Operation Call

An API Call, that produces an Object within nexxOMNIA. This may be a Call to the Management API, but also Interaction Calls operate like this. In this Case, the Result Data will only consist of a Status String and mostly some Details of the created Object (for example, the ID of a new Comment).

Paging

Key
Format
Description
start
Int
The Start of the Query Range
limit
Int
The given maximal Item List Length
resultcount
Int
The maximally available Number of Items
Last modified 1yr ago