Difference between revisions of "Summary of software interfaces"

From DE4A
Jump to navigation Jump to search
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== Available interfaces ==
 
== Available interfaces ==
 
{| class="wikitable"
 
{| class="wikitable"
−
|+DE4A Components interfaces description (Iteration 1)
+
|+DE4A Components interfaces description (Iteration 2)
 
!Component
 
!Component
 
!Pattern
 
!Pattern
Line 11: Line 11:
 
!Output
 
!Output
 
|-
 
|-
−
| rowspan="2" |Data Evaluator
+
| rowspan="4" |Data Evaluator
−
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI]
+
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
−
|Forward evidence
+
[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
−
|/requestForwardEvidence
+
 
 +
[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
 +
|Response transfer evidence
 +
|/response/evidence
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L567 RequestForwardEvidenceType]
+
|[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://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]
 
|Response user redirection
 
|Response user redirection
−
|/responseUserRedirection
+
|/response/usi/redirectUser
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L601 ResponseUserRedirectionType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RedirectUserType RedirectUserType]
 
|HTTP Status 302/303 (Http/1 Http/2)
 
|HTTP Status 302/303 (Http/1 Http/2)
 
|-
 
|-
−
| rowspan="3" |Data Owner
+
|S&N
−
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM]
+
|Event Subscription
 +
|/response/subscription
 +
|XML REST
 +
|Asynchronous
 +
|[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]
 +
|-
 +
|S&N
 +
|Event Notificacion
 +
|/notificationEvent
 +
|XML REST
 +
|Asynchronous
 +
|[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="4" |Data Owner
 +
|[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
 
|Extract evidence IM
 
|Extract evidence IM
−
|/requestExtractEvidenceIM
+
|/request/im/
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L523 RequestExtractEvidenceIMType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L537 ResponseExtractEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
−
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI]
+
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|Extract evidence USI
 
|Extract evidence USI
−
|/requestExtractEvidenceUSI
+
|/request/usi/
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L509 RequestExtractEvidenceUSIType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType]
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
+
|[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]
 +
|Lookup
 +
|/requestExtractMultiEvidenceLU
 +
|XML REST
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
−
|RequestUserRedirection
+
|S&N
−
|/requestUserRedirection
+
|Event Subscription
 +
|/requestEventSubscription
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L595 RequestUserRedirectionType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
−
|HTTP Status 302/303 (Http/1 Http/2)
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
−
| rowspan="3" |Data Requestor (Connector)
+
| rowspan="5" |Data Requestor (Connector)
−
| [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI]
+
|[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
 +
[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 
|Lookup Routing Information
 
|Lookup Routing Information
−
|/lookupRountingInformation
+
|/service/ial/
 
|XML REST
 
|XML REST
 
|Synchronous
 
|Synchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L580 RequestLookupRoutingInformationType]
+
|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://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L589 ResponseLookupRoutingInformationType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseLookupRoutingInformationType ResponseLookupRoutingInformationType]
 +
|-
 +
|[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
 +
|Extract evidence IM
 +
|/request/im/
 +
|XML REST
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType]
 +
|[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]
 +
|Extract evidence USI
 +
|/request/usi/
 +
|XML REST
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType]
 +
|[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]
 +
|Lookup
 +
|/requestTransferEvidenceLU
 +
|XML REST
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceLUType RequestExtractMultiEvidenceLUType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 +
|-
 +
|S&N
 +
|Event Subscription
 +
|/request/subscription
 +
|XML REST
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestEventSubscriptionType RequestEventSubscriptionType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
−
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM]
+
| rowspan="4" |Data Transferor (Connector)
−
|Request transfer evidence
+
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
−
|/requestTransferEvidenceIM
+
[https://wiki.de4a.eu/index.php/Intermediation_pattern_communication_diagram IM]
 +
 
 +
[https://wiki.de4a.eu/index.php/Lookup_pattern_communication_diagram LU]
 +
|Response transfer evidence
 +
|/response/evidence
 +
|XML REST
 +
|Asynchronous
 +
|[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]
 +
|Response user redirection
 +
|/response/usi/redirectUser
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RedirectUserType RedirectUserType]
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L546 ResponseTransferEvidenceType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
−
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI]
+
|S&N
−
|Request transfer evidence USI
+
|Event Subscription
−
|/requestTransferEvidenceUSI
+
|/response/subscription
 
|XML REST
 
|XML REST
 
|Asynchronous
 
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseEventSubscriptionType ResponseEventSubscriptionType]
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|-
 
|-
−
|Data Transferor (Connector)
+
|S&N
−
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI]
+
|Event Notificacion
−
|Response transfer evidence USI
+
|/event/notification
−
|/requestTransferEvidenceUSIDT
 
 
|XML REST
 
|XML REST
−
|Synchronous
+
|Asynchronous
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L477 RequestTransferEvidenceUSIDTType]
+
|[https://wiki.de4a.eu/index.php/Data_Dictionary#EventNotificationType EventNotificationType]
−
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
+
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 
|}
 
|}

Latest revision as of 14:10, 20 December 2022

Available interfaces

DE4A Components interfaces description (Iteration 2)
Component Pattern Service Referenced API Interface type Communication Input message Output
Data Evaluator USI

IM

LU

Response transfer evidence /response/evidence XML REST Asynchronous ResponseExtractMultiEvidenceType ACK
USI Response user redirection /response/usi/redirectUser XML REST Asynchronous RedirectUserType HTTP Status 302/303 (Http/1 Http/2)
S&N Event Subscription /response/subscription XML REST Asynchronous ResponseEventSubscriptionType ACK
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
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 /request/subscription XML REST Asynchronous RequestEventSubscriptionType ACK
Data Transferor (Connector) USI

IM

LU

Response transfer evidence /response/evidence XML REST Asynchronous ResponseExtractMultiEvidenceType ACK
USI Response user redirection /response/usi/redirectUser XML REST Asynchronous RedirectUserType ACK
S&N Event Subscription /response/subscription XML REST Asynchronous ResponseEventSubscriptionType ACK
S&N Event Notificacion /event/notification XML REST Asynchronous EventNotificationType ACK
Retrieved from ‘https://wiki.de4a.eu/index.php?title=Summary_of_software_interfaces&oldid=5715’