TheraScan API (draft)
TheraScan generates certified electronic copies of source documents which can stand in for paper originals when auditing and monitoring clinical trials. The system has three components required to copy, certify and upload source documents copies to the system.
RESTful Requests
| TSRegister | Activate the biometric SmartCard account | |
|---|---|---|
| Verb | POST | |
| Header | LicenseID | Customer ID issiued by Therapeias |
| Parameter | UserID | User ID from provisioning process |
| Parameter | TmpPassword | Temporary password from provisioning process |
| Parameter | NewPassword | New password entered by user |
| Parameter | MD5Password | MD5 hash of new password |
| Parameter | SigPassword | Signature of MD5 hash |
| Parameter | SmartCardKey | Public key from SmartCard |
| Parameter | SmartCardID | Unique identifier from biometric smartcard |
| Return | Status Code | |
| TSSession | Initialize a TheraScan session using a SmartCard | |
|---|---|---|
| Verb | POST | |
| Header | LicenseID | Customer ID issiued by Therapeias |
| Parameter | UserID | User ID on system |
| Parameter | UserPassword | User password on system |
| Parameter | MD5Password | MD5 hash of password |
| Parameter | SigPassword | Signature of MD5 hash |
| Parameter | SmartCardKey | Public key from SmartCard |
| Parameter | SmartCardID | Unique identifier from biometric smartcard |
| Return | Session ID | |
| TSCreateXMP | Build a PDF from submitted multi-page TIFF and XML files | |
|---|---|---|
| Verb | POST | |
| Header | LicenseID | Customer ID issiued by Therapeias |
| Parameter | SessionID | Session ID from TSSession |
| Parameter | SubmitStr | Base64 encoded combination of TIFFs and XML |
| Return | Document | Document ID and PDF |
| TSCertify | Certify returned PDF with SmartCard | |
|---|---|---|
| Verb | POST | |
| Header | LicenseID | Customer ID issiued by Therapeias |
| Parameter | SessionID | Session ID from TSSession |
| Parameter | DocumentID | Document ID from TSCreateXMP |
| Parameter | MD5File | MD5 hash of document from TSCreateXMP |
| Parameter | SigDocument | Signature of MD5 hash |
| Parameter | SmartCardKey | Public key from SmartCard |
| Parameter | SmartCardID | Unique identifier from biometric smartcard |
| Parameter | ResponseType | Respond with HTML receipt or link |
| Return | Receipt | HTML receipt or link |
| TSRelease | Release TheraScan session | |
|---|---|---|
| Verb | GET | |
| Header | LicenseID | Customer ID issiued by Therapeias |
| Parameter | SessionID | Session ID from TSSession |
| Return | Status code | |
| TSRetreive | Access certified copy on repository | |
|---|---|---|
| Verb | POST | |
| Parameter | UserID | User ID on system |
| Parameter | UserPassword | User password on system |
| Parameter | DocumentID | Document ID from TSCreateXMP |
| Return | Document | PDF identified by DocumentID |