Difference between revisions of "Summary of software interfaces"
Jump to navigation
Jump to search
Hugo.berdon (talk | contribs) |
Hugo.berdon (talk | contribs) |
||
| Line 13: | Line 13: | ||
| rowspan="2" |Data Evaluator | | rowspan="2" |Data Evaluator | ||
| rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI] | | rowspan="2" |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DE1-USI.xsd USI] | ||
| − | |Forward evidence | + | |* Forward evidence |
|/requestForwardEvidence | |/requestForwardEvidence | ||
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | |[https:// | + | |[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://github.com/de4a-wp5/xml-schemas/blob/4d074ee82355255293a0c9e071d9507920f0af02/XSD/de4a/common-types.xsd#L191 ACK] | ||
|- | |- | ||
| − | |Response user redirection | + | |* Response user redirection |
|/responseUserRedirection | |/responseUserRedirection | ||
|XML REST | |XML REST | ||
| Line 42: | Line 42: | ||
|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# | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType] |
|- | |- | ||
|RequestUserRedirection | |RequestUserRedirection | ||
| Line 54: | Line 54: | ||
| [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI] | | [https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DT1-IDK.xsd IM/USI] | ||
|Lookup Routing Information | |Lookup Routing Information | ||
| − | |/ | + | |/service/ial/ |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | | | + | |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://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] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd IM] | ||
| − | | | + | |Extract evidence IM |
| − | |/ | + | |/request/im/ |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceIMType RequestExtractMultiEvidenceIMType] |
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType] |
|- | |- | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DR-DE1-IM.xsd USI] | ||
| − | | | + | |Extract evidence USI |
| − | |/ | + | |/request/usi/ |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType] |
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType] |
|- | |- | ||
|Data Transferor (Connector) | |Data Transferor (Connector) | ||
|[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI] | |[https://github.com/de4a-wp5/xml-schemas/blob/iteration1/XSD/DT1-USI.xsd USI] | ||
|Response transfer evidence USI | |Response transfer evidence USI | ||
| − | |/ | + | |/response/evidence/ |
|XML REST | |XML REST | ||
|Asynchronous | |Asynchronous | ||
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#RequestExtractMultiEvidenceUSIType RequestExtractMultiEvidenceUSIType] |
| − | |[https:// | + | |[https://wiki.de4a.eu/index.php/Data_Dictionary#ResponseExtractMultiEvidenceType ResponseExtractMultiEvidenceType] |
|} | |} | ||
Revision as of 15:30, 17 May 2022
Available interfaces
| Component | Pattern | Service | Referenced API | Interface type | Communication | Input message | Output |
|---|---|---|---|---|---|---|---|
| Data Evaluator | USI | * Forward evidence | /requestForwardEvidence | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ACK |
| * Response user redirection | /responseUserRedirection | XML REST | Asynchronous | ResponseUserRedirectionType | HTTP Status 302/303 (Http/1 Http/2) | ||
| Data Owner | IM | Extract evidence IM | /request/im/ | XML REST | Asynchronous | RequestExtractMultiEvidenceIMType | ResponseExtractMultiEvidenceType |
| USI | Extract evidence USI | /request/usi/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ResponseExtractMultiEvidenceType | |
| RequestUserRedirection | /requestUserRedirection | XML REST | Asynchronous | RequestUserRedirectionType | HTTP Status 302/303 (Http/1 Http/2) | ||
| Data Requestor (Connector) | IM/USI | Lookup Routing Information | /service/ial/ | XML REST | Asynchronous | 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 | ResponseExtractMultiEvidenceType | |
| USI | Extract evidence USI | /request/usi/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ResponseExtractMultiEvidenceType | |
| Data Transferor (Connector) | USI | Response transfer evidence USI | /response/evidence/ | XML REST | Asynchronous | RequestExtractMultiEvidenceUSIType | ResponseExtractMultiEvidenceType |