Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

3.1.1   UML Diagram

...

3.1.2   Data Dictionary

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBEventPolling

 

OBEventPolling

 

OBEventPolling

 

 

maxEvents

0..1

OBEventPolling/maxEvents

Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available

Integer

 

 

returnImmediately

0..1

OBEventPolling/returnImmediately

Indicates whether an ASPSP should return a response immediately or provide a long poll

Boolean

 

 

ack

0..n

OBEventPolling/ack

An array of jti values of jti values indicating event notifications positively acknowledged by the TPP

Array:String

 

 

setErrs

0..1

OBEventPolling/setErrs

An object that encapsulates all negative acknowledgements transmitted by the TPP

OBEventPolling/setErrs

 

 

<jti>

0..n

OBEventPolling/setErrs/<jti>

A event notification error object entitled using the jti of the jti of the event notification

OBEventPolling/setErrs/<jti>

 

 

err

1..1

OBEventPolling/setErrs/<jti>/err

A value from the IANA "Security Event Token Delivery Error Codes" registry that identifies the error as defined here

String

 

 

description

1..1

OBEventPolling/setErrs/<jti>/description

A human-readable string that provides additional diagnostic information

String

 

 

 

3.2.     Aggregated Polling - Response

...

3.2.1   UML Diagram

...

3.2.2   Data Dictionary

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

Pattern

OBEventPollingResponse

1..1

OBEventPollingResponse

 

OBEventPollingResponse

 

 

moreAvailable

1..1

OBEventPollingResponse/moreAvailable

A JSON boolean value that indicates if more unacknowledged event notifications are available to be returned.

Boolean

 

 

sets

1..1

OBEventPollingResponse/sets

A JSON object that contains zero or more nested JSON attributes. If there are no outstanding event notifications to be transmitted, the JSON object SHALL be empty.

OBEventPollingResponse/sets

 

 

<jti>

0..n

OBEventPollingResponse/sets/<jti>

An object named with the jti of the jti of the event notification to be delivered. The value is the event notification, expressed as stringa string. The payload of the event should be defined in the OBEventNotification formatthe OBEventNotification format.

OBEventPollingResponse/sets/<jti>

 

 


4.     Usage Example

Note for the sake of readability the SETs shown in examples are shorted

...