cupa-ceil-proxy-xapi
home
CEIL Proxy Experience API
Ceil proxy xapi is act as a proxy to connect CEIL so that Consumers can consume the API securely.
Architecture Diagram:


Sequence Diagram:

Sequence Diagram Description:
| No. | Steps | Description |
|---|---|---|
| 1. | Request | Http client invokes the mule services along with credentials (client id and client secret) and X-TRANSACTION-ID(A code to track API calls end to end) via Mule Soft Secure API layer |
| 2. | Validate Credentials | Client id and Client secret credentials are validated by the security API mule gateway layer |
| 3. | If Validation fails, service returns specific fault response | If Validation fails, service returns specific fault response |
| 4. | Request | Request forward and behave like a passthrough API |
| 5. | Response | Response from CEIL |
| 6. | Return Response | Returns the success response. |
Endpoints:
1. Health Check
GET: /status
To check the health of the API.
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | Check the current status of API |
| 2. | URI | /api/v1/status |
| 3. | Method | GET |
| 4. | Response | { "application": "cupa-ceil-proxy-xapi", "version": "v1", "environment": "dev", "status": "Running", "timestamp": "2023-02-02T07:41:43.227Z+00:00" } |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPS |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/status |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
2. To Get Products
GET: /products
This endpoint retrieve product detail from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Get product details |
| 2. | URI | /v1/products |
| 3. | Method | GET |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/products |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
3. To create update products detail
Post: /products
This endpoint post product details to non mule system Ceil Marking API, payload in below format.
{
}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post products details |
| 2. | URI | /v1/products |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/products |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
4. To Get User Role Access
Post: /role/access
This endpoint is used to Get User Role details to non mule system, payload in below format.
{}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post user role access |
| 2. | URI | /v1/role/access |
| 3. | Method | Post |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/role/access |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
5. To Get marks details
GET: /marks/minmax/{posid}
This endpoint is used to mark details using pos id to non mule system, Using Unique URI parameters posid payload in below format.
{}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Get marks using Pos Id |
| 2. | URI | /v1/marks/minmax/{posid} |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/marks/minmax/{posid} |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
6. To Post mark adjustment
POST: /markadjustment/adjustMarks
This endpoint is used to post mark adjust to non mule system, payload in below format.
{}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post mark adjust |
| 2. | URI | /v1/markadjustment/adjustMarks |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/markadjustment/adjustMarks |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
7. To Post Mark Fetch
POST: /markadjustment/fetchMarks
This endpoint is used to post Marks fetch to non mule system, payload in below format.
{}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post mark Fetch |
| 2. | URI | /v1/markadjustment/fetchMarks |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/markadjustment/fetchMarks |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
8. To Post markadjustment bulk upload
POST: /markadjustment/bulkUpload
This endpoint is used to upload file to non mule system, payload in below format.
{}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post bulk in a single go |
| 2. | URI | /v1/markadjustment/bulkUpload |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/markadjustment/bulkUpload |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
9. To templates
GET: /elit/text/templates
This endpoint is used templates from non mule system, Using Auth in header.
{}| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Get templates from elit |
| 2. | URI | /v1/elit/text/templates |
| 3. | Method | GET |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/elit/text/templates |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
10. To Get Markadjustment Download Template Details
GET: markadjustment/downloadTemplateDetails
This endpoint downlaod teamplate detail of markadjustment from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Get product details |
| 2. | URI | /v1/markadjustment/downloadTemplateDetails |
| 3. | Method | GET |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/markadjustment/downloadTemplateDetails |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
11. To Get Result Audit
GET: /resultAudit
This endpoint retrieve result audit detail from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Get product details |
| 2. | URI | /v1/resultAduit |
| 3. | Method | GET |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/resutAudit |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
12. To POST Result Audit
POST: /resultAudit
This endpoint post result audit detail from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post product details |
| 2. | URI | /v1/resultAduit |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/resutAudit |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
13. To GET briefing comments for RMA
GET: /briefingCommentsForRma/getComments
This endpoint retrieve get briefing comments from RMA detail from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Get Briefing comments from RMA details |
| 2. | URI | /v1//briefingCommentsForRma/getComments |
| 3. | Method | GET |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1//briefingCommentsForRma/getComments |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
14. To POST Briefing comments from RMA Upload
POST: /briefingCommentsForRma/upload
This endpoint post briefing Comments For Rma upload detail from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post briefing Comments For Rma upload |
| 2. | URI | /v1/briefingCommentsForRma/upload |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/briefingCommentsForRma/upload |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
15. To POST Briefing comments from RMA Update
POST: /briefingCommentsForRma/update
This endpoint post briefing Comments For Rma update detail from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post briefing Comments For Rma update |
| 2. | URI | /v1/briefingCommentsForRma/update |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/briefingCommentsForRma/update |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
16. To POST Set AccountInfo
POST: /accounts.setAccountInfo
This endpoint post set accountInfo from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post set accountInfo |
| 2. | URI | /v1/accounts.setAccountInfo |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/accounts.setAccountInfo |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
17. To POST Enquiry candidate Details
POST: /candidateenquiry/candidatedetails
This endpoint post enquiry candidate details from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post enquiry candidate details |
| 2. | URI | /v1/candidateenquiry/candidatedetails |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/candidateenquiry/candidatedetails |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
18. To POST Candidate enquiry result details
POST: /candidateenquiry/resultdetails
This endpoint post enquiry result details from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post enquiry result details |
| 2. | URI | /v1/candidateenquiry/resultdetails |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/candidateenquiry/resultdetails |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
19. To POST mark transfer
POST: /markTransfer
This endpoint mark transfer from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post mark transfer |
| 2. | URI | /v1/markTransfer |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/markTransfer |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
20. To POST search candidate
POST: /searchCandidate
This endpoint search candidate from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post search candidate |
| 2. | URI | /v1/searchCandidate |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/searchCandidate |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
21. To POST GDPR Remarking
POST: /GDPRRemarking
This endpoint gdpr remarking from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post GDPR remarking |
| 2. | URI | /v1/GDPRRemarking |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/GDPRRemarking |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
22. To POST Monitoring overview
POST: /monitoring/overview
This endpoint monitoring overview from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post monitoring overview |
| 2. | URI | /v1/monitoring/overview |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/monitoring/overview |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
23. To POST monitoring records
POST: /monitoring/records
This endpoint monitoring records from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post monitoring records |
| 2. | URI | /v1/monitoring/records |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/monitoring/records |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
24. To POST monitoring record details
POST: /monitoring/recorddetails
This endpoint monitoring record details from non mule system Ceil Marking API.
```
{
}
```
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | To Post monitoring record details |
| 2. | URI | /v1/monitoring/recorddetails |
| 3. | Method | POST |
| 6. | Synchronous/Asynchronous | Synchronous |
| 7. | Protocol | HTTPS |
| 8. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-ceil-proxy-xapi-dev/api/v1/monitoring/recorddetails |
| 9. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 10. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |