Difference between revisions of "Summary of software interfaces"

From DE4A
Jump to navigation Jump to search
(Created page with "description")
 
Line 1: Line 1:
description
+
== Available interfaces ==
 +
{| class="wikitable"
 +
|+DE4A Components interfaces description (Iteration 1)
 +
!Component
 +
!Pattern
 +
!Service
 +
!Referenced API
 +
!Interface type
 +
!Communication
 +
!Input message
 +
!Output
 +
|-
 +
| rowspan="2" |Data Evaluator
 +
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI]
 +
|Forward evidence
 +
|/requestForwardEvidence
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L567 RequestForwardEvidenceType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK]
 +
|-
 +
|Response user redirection
 +
|/responseUserRedirection
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L601 ResponseUserRedirectionType]
 +
|HTTP Status 302/303 (Http/1 Http/2)
 +
|-
 +
| rowspan="3" |Data Owner
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT-DO1-IM.xsd IM]
 +
|Extract evidence IM
 +
|/requestExtractEvidenceIM
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L523 RequestExtractEvidenceIMType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L537 ResponseExtractEvidenceType]
 +
|-
 +
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DO1-USI.xsd USI]
 +
|Extract evidence USI
 +
|/requestExtractEvidenceUSI
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L509 RequestExtractEvidenceUSIType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
 +
|-
 +
|RequestUserRedirection
 +
|/requestUserRedirection
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L595 RequestUserRedirectionType]
 +
|HTTP Status 302/303 (Http/1 Http/2)
 +
|-
 +
| rowspan="3" |Data Requestor (Connector)
 +
| [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI]
 +
|Lookup Routing Information
 +
|/lookupRountingInformation
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L580 RequestLookupRoutingInformationType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L589 ResponseLookupRoutingInformationType]
 +
|-
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM]
 +
|Request transfer evidence
 +
|/requestTransferEvidenceIM
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L546 ResponseTransferEvidenceType]
 +
|-
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI]
 +
|Request transfer evidence USI
 +
|/requestTransferEvidenceUSI
 +
|XML REST
 +
|Asynchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L495 RequestTransferEvidenceType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
 +
|-
 +
|Data Transferor (Connector)
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI]
 +
|Response transfer evidence USI
 +
|/requestTransferEvidenceUSIDT
 +
|XML REST
 +
|Synchronous
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L477 RequestTransferEvidenceUSIDTType]
 +
|[https://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L608 ResponseErrorType]
 +
|}

Revision as of 11:06, 17 May 2022

Available interfaces

DE4A Components interfaces description (Iteration 1)
Component Pattern Service Referenced API Interface type Communication Input message Output
Data Evaluator USI Forward evidence /requestForwardEvidence XML REST Synchronous RequestForwardEvidenceType ACK
Response user redirection /responseUserRedirection XML REST Synchronous ResponseUserRedirectionType HTTP Status 302/303 (Http/1 Http/2)
Data Owner IM Extract evidence IM /requestExtractEvidenceIM XML REST Synchronous RequestExtractEvidenceIMType ResponseExtractEvidenceType
USI Extract evidence USI /requestExtractEvidenceUSI XML REST Synchronous RequestExtractEvidenceUSIType ResponseErrorType
RequestUserRedirection /requestUserRedirection XML REST Synchronous RequestUserRedirectionType HTTP Status 302/303 (Http/1 Http/2)
Data Requestor (Connector) IM/USI Lookup Routing Information /lookupRountingInformation XML REST Synchronous RequestLookupRoutingInformationType ResponseLookupRoutingInformationType
IM Request transfer evidence /requestTransferEvidenceIM XML REST Synchronous RequestTransferEvidenceType ResponseTransferEvidenceType
USI Request transfer evidence USI /requestTransferEvidenceUSI XML REST Asynchronous RequestTransferEvidenceType ResponseErrorType
Data Transferor (Connector) USI Response transfer evidence USI /requestTransferEvidenceUSIDT XML REST Synchronous RequestTransferEvidenceUSIDTType ResponseErrorType