cupa-ceil-proxy-xapi

(0 reviews)

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:

resources/cupa-ceil-webhook-xapi-integration-diagram-1550bd21-ecfb-4046-ad75-1d0b11970467.jpg

resources/image-a2b2e94c-33f1-4f27-8207-d05dd82ce391.png


Sequence Diagram:

resources/Untitled%20%2831%29-cb435aaa-8b8d-46bb-9cd2-2eac3354cffe.png

Sequence Diagram Description:

No.StepsDescription
1.RequestHttp 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 CredentialsClient id and Client secret credentials are validated by the security API mule gateway layer
3.If Validation fails, service returns specific fault responseIf Validation fails, service returns specific fault response
4.RequestRequest forward and behave like a passthrough API
5.ResponseResponse from CEIL
6.Return ResponseReturns the success response.

Endpoints:

1. Health Check

GET: /status

To check the health of the API.

TopicDetails
1.Operation DescriptionCheck the current status of API
2.URI/api/v1/status
3.MethodGET
4.Response{ "application": "cupa-ceil-proxy-xapi", "version": "v1", "environment": "dev", "status": "Running", "timestamp": "2023-02-02T07:41:43.227Z+00:00" }
5.Synchronous/AsynchronousSynchronous
6.ProtocolHTTPS
7.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Get product details
2.URI/v1/products
3.MethodGET
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{

}
TopicDetails
1.Operation DescriptionTo Post products details
2.URI/v1/products
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{}
TopicDetails
1.Operation DescriptionTo Post user role access
2.URI/v1/role/access
3.MethodPost
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{}
TopicDetails
1.Operation DescriptionTo Get marks using Pos Id
2.URI/v1/marks/minmax/{posid}
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{}
TopicDetails
1.Operation DescriptionTo Post mark adjust
2.URI/v1/markadjustment/adjustMarks
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{}
TopicDetails
1.Operation DescriptionTo Post mark Fetch
2.URI/v1/markadjustment/fetchMarks
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{}
TopicDetails
1.Operation DescriptionTo Post bulk in a single go
2.URI/v1/markadjustment/bulkUpload
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.

{}
TopicDetails
1.Operation DescriptionTo Get templates from elit
2.URI/v1/elit/text/templates
3.MethodGET
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Get product details
2.URI/v1/markadjustment/downloadTemplateDetails
3.MethodGET
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Get product details
2.URI/v1/resultAduit
3.MethodGET
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post product details
2.URI/v1/resultAduit
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Get Briefing comments from RMA details
2.URI/v1//briefingCommentsForRma/getComments
3.MethodGET
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post briefing Comments For Rma upload
2.URI/v1/briefingCommentsForRma/upload
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post briefing Comments For Rma update
2.URI/v1/briefingCommentsForRma/update
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post set accountInfo
2.URI/v1/accounts.setAccountInfo
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post enquiry candidate details
2.URI/v1/candidateenquiry/candidatedetails
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post enquiry result details
2.URI/v1/candidateenquiry/resultdetails
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post mark transfer
2.URI/v1/markTransfer
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post search candidate
2.URI/v1/searchCandidate
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post GDPR remarking
2.URI/v1/GDPRRemarking
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post monitoring overview
2.URI/v1/monitoring/overview
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post monitoring records
2.URI/v1/monitoring/records
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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.
```
{

}
```

TopicDetails
1.Operation DescriptionTo Post monitoring record details
2.URI/v1/monitoring/recorddetails
3.MethodPOST
6.Synchronous/AsynchronousSynchronous
7.ProtocolHTTPS
8.URLhttps://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

Reviews