LISTEN_STATUS

Overview

This can retrieve the status of listeners that are currently open, or that have been closed. The status of a listener can be retrieved through the listenId provided in the response of the START_LISTEN operation.

Request

Java
JSON

`DlcListenStatusRequest`

Key	Required	Type	Description
listenId	Y	`String`	The unique identifier of a listener.

Example:

DlcListenStatusRequest.builder()
    .listenId("234890")
    .build();

`DlcListenStatusRequestDTO`

Key	Required	Type	Description
listenId	Y	`String`	The unique identifier of a listener.

Example:

{
  "operation": "LISTEN_STATUS",
  "listenId": "234890"
}

Response

Java
JSON

`DlcListenStatusResponse`

Key	Type	Description
report	`ListenReport<E>`	Reports of all events that occurred while the listener was open.
status	`DlcStatus`	Overall status of the DLC Operation.

`ListenReport<E>`

Key	Type	Description
isOpen	`boolean`	Whether the listener is currently open or closed.
startTime	`LocalDateTime`	The time and date the listener was started. Uses the JVM’s time zone.
endTime	`LocalDateTime`	The time and date the listener was closed. Uses the JVM’s time zone. Will be null for open listeners.
events	`List<E>`	List of events that occurred while the listener was open. The type of event depends on the source.

`DlcListenStatusResponseDTO`

Key	Type	Description
isOpen	`boolean`	Whether the listener is currently open or closed.
startTime	`LocalDateTime`	The time and date the listener was started. Uses the JVM’s time zone.
endTime	`LocalDateTime`	The time and date the listener was closed. Uses the JVM’s time zone. Will be null for open listeners.
events	`List<DlcLoadResponse>`	List of events that occurred while the listener was open. The type of event depends on the source.

Example:

{
  "report": {
    "isOpen": true,
    "startTime": "2025-02-14T12:00:00",
    "endTime": null,
    "events": [
      {}
    ]
  },
  "status": "OK"
}

Expected event types

The type parameter of the ListenReport can vary depending on the type of source being listened on.

File sources: `ListenReport<DlcLoadResponse>`

When listening on a file source, the listen report will contain DlcLoadResponse events as the listen operation will perform many LOAD operations.

`DlcStatus`

A simple enum to capture if the DLC request was executed.

Key	Description
OK	Request was handled successfully.
ERROR	Request was not able to be performed correctly.

How it works

All listen operations are recorded and linked to a unique listenId. This ID can then be used to fetch the listener’s ListenReport<DlcLoadResponse>.

Operations

Request API

Configuration

Components

Functional

Extensions

Overview

Request

`DlcListenStatusRequest`

Example:

`DlcListenStatusRequestDTO`

Example:

Response

`DlcListenStatusResponse`

`ListenReport<E>`

`DlcListenStatusResponseDTO`

Example:

Expected event types

File sources: `ListenReport<DlcLoadResponse>`

`DlcStatus`

How it works

​Overview

​Request

​DlcListenStatusRequest

​Example:

​DlcListenStatusRequestDTO

​Example:

​Response

​DlcListenStatusResponse

​ListenReport<E>

​DlcListenStatusResponseDTO

​Example:

​Expected event types

​File sources: ListenReport<DlcLoadResponse>

​DlcStatus

​How it works

Overview

Request

`DlcListenStatusRequest`

Example:

`DlcListenStatusRequestDTO`

Example:

Response

`DlcListenStatusResponse`

`ListenReport<E>`

`DlcListenStatusResponseDTO`

Example:

Expected event types

File sources: `ListenReport<DlcLoadResponse>`

`DlcStatus`

How it works