Difference between revisions of "Summary of software interfaces"

From DE4A
Jump to navigation Jump to search
Line 33: Line 33:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
| rowspan="5" |Data Owner
 
| rowspan="5" |Data Owner
Line 42: Line 42:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
| rowspan="2" |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
| rowspan="2" |[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
Line 50: Line 50:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
|RequestUserRedirection
 
|RequestUserRedirection
Line 65: Line 65:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
|S&N
 
|S&N
Line 73: Line 73:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
| rowspan="5" |Data Requestor (Connector)
 
| rowspan="5" |Data Requestor (Connector)
Line 81: Line 81:
 
|/service/ial/
 
|/service/ial/
 
|XML REST
 
|XML REST
|Asynchronous
+
|Synchronous
 
|All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode.
 
|All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode.
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformationType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformationType]
Line 91: Line 91:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
Line 99: Line 99:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
|[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
 
|[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
Line 107: Line 107:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
|S&N
 
|S&N
Line 115: Line 115:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
 
| rowspan="4" |Data Transferor (Connector)
 
| rowspan="4" |Data Transferor (Connector)
Line 151: Line 151:
 
|Asynchronous
 
|Asynchronous
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
 
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|}
 
|}

Revision as of 07:35, 10 August 2022

Available interfaces

DE4A Components interfaces description (Iteration 2)
Component Pattern Service Referenced API Interface type Communication Input message Output
Data Evaluator USI * Forward evidence /requestForwardEvidence XML REST Asynchronous ResponseExtractMultiEvidenceType ACK
* Response user redirection /responseUserRedirection XML REST Asynchronous RedirectUserType HTTP Status 302/303 (Http/1 Http/2)
S&N Event Notificacion /notificationEvent XML REST Asynchronous EventNotificationType ACK
Data Owner IM Extract evidence IM /request/im/ XML REST Asynchronous RequestExtractMultiEvidenceIMType ACK
USI Extract evidence USI /request/usi/ XML REST Asynchronous RequestExtractMultiEvidenceUSIType ACK
RequestUserRedirection /requestUserRedirection XML REST Asynchronous RedirectUserType HTTP Status 302/303 (Http/1 Http/2)
LU Lookup /requestExtractMultiEvidenceLU XML REST Asynchronous RequestExtractMultiEvidenceLUType ACK
S&N Event Subscription /requestEventSubscription XML REST Asynchronous RequestEventSubscriptionType ACK
Data Requestor (Connector) IM

USI

Lookup Routing Information /service/ial/ XML REST Synchronous All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode. ResponseLookupRoutingInformationType
IM Extract evidence IM /request/im/ XML REST Asynchronous RequestExtractMultiEvidenceIMType ACK
USI Extract evidence USI /request/usi/ XML REST Asynchronous RequestExtractMultiEvidenceUSIType ACK
LU Lookup /requestTransferEvidenceLU XML REST Asynchronous RequestExtractMultiEvidenceLUType ACK
S&N Event Subscription /requestEventSubscription XML REST Asynchronous RequestEventSubscriptionType ACK
Data Transferor (Connector) USI

IM

LU

Response transfer evidence /responseTransferEvidence XML REST Asynchronous ResponseExtractMultiEvidenceType ACK
USI * Response user redirection /usiRedirectUser XML REST Asynchronous RedirectUserType ACK
S&N Event Subscription /responseEventSubscription XML REST Asynchronous ResponseEventSubscriptionType ACK
S&N Event Notificacion /notificationEvent XML REST Asynchronous EventNotificationType ACK