Difference between revisions of "Summary of software interfaces"

From DE4A
Jump to navigation Jump to search
(Created page with "description")
 
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
description
+
== Available interfaces ==
 +
{| class="wikitable"
 +
|+DE4A Components interfaces description (Iteration 2)
 +
!Component
 +
!Pattern
 +
!Service
 +
!Referenced API
 +
!Interface type
 +
!Communication
 +
!Input message
 +
!Output
 +
|-
 +
| rowspan="4" |Data Evaluator
 +
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 +
[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
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RedirectUserType RedirectUserType]
 +
|HTTP Status 302/303 (Http/1 Http/2)
 +
|-
 +
|S&N
 +
|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
 +
|/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
 +
|/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]
 +
|-
 +
|S&N
 +
|Event Subscription
 +
|/requestEventSubscription
 +
|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]
 +
|-
 +
| rowspan="5" |Data Requestor (Connector)
 +
|[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
 +
|/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.
 +
|[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]
 +
|-
 +
| rowspan="4" |Data Transferor (Connector)
 +
|[https://wiki.de4a.eu/index.php/User-supported_intermediation_pattern_communication_diagram USI]
 +
[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
 +
|Asynchronous
 +
|[https://wiki.de4a.eu/index.php/Data_Dictionary#RedirectUserType RedirectUserType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 +
|-
 +
|S&N
 +
|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
 +
|/event/notification
 +
|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]
 +
|}

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’