Overview
The eTMS Partner API can be used by Colleges in place of the SFTP file exchange to provide secure exchange of XML documents.
Message Flow
Encryption
API connections are only allowed via HTTPS.
OAuth Tokens
OAuth tokens are used to ensure only the supplier is viewing their own data.
Actions and Routes
All prefixed with /api/
| Role | Action | Route |
|---|---|---|
| Any | Login | POST /auth/login |
| Supplier | Get transcript requests without a response | GET /transcriptrequests/no_response |
| Supplier | Get transcript request detail. | GET /transcriptrequests/:id |
| Supplier | Send transcript request response | POST /transcriptrequests/:id/response |
| Supplier | Send a transcript belonging to a transcript request | POST /transcriptrequests/:id/transcript |
| Consumer | Get a list of transcripts to receive | GET /transcripts/no_response |
| Consumer | Get a transcript | GET /transcripts/:id |
| Consumer | Send a transcript acknowledgment | POST /transcripts/:id/acknowledgment/ |
HTTP Responses
| Code | Meaning |
|---|---|
| 200 | The request has succeeded. |
| 400 | Bad request. |
| 401 | Unauthorized. |