cupa-access-arrangement-xapi
home
Overview:
• Access Arrangement API to post candidate details, and mail notifications from front end to Appian Web API.
| API Method | REST Endpoint | Description | Consumers | |
|---|---|---|---|---|
| 1. | POST | /{version}/candidates | post candidate details to Appian | Desktop / Web User |
| 2. | GET | /{version}/requestDetails | Retrieve the request details from Appian | Desktop / Web User |
| 3. | POST | /{version}/mails/notifications | post the mail notifications to Appian | Desktop / Web User |
| 4. | GET | /{version}/centres/{centreId} | Retrieve the Centre Details from SAP | Desktop / Web User |
| 5. | GET | /{version}/candidatesList | Retrieve the candidate details from Appian | Desktop / Web User |
| 6. | POST | /{version}/candidatesList | post the candidate details to Appian | Desktop / Web User |
Flow Diagram and Description:
- This API can be utilized to send candidate details to Appian with specified message in request body.
Sequence Diagram:
Steps In Sequence Diagram
| No | Steps | Description |
|---|---|---|
| 1. | Input Request Message | Script Validation get service invokes the mule services along with credentials via Mule Soft Secure API layer . |
| 2. | Validate the Bearer token credentials | If the token is authorized the request is sent to the endpoint. |
| 3. | If validation fails, service returns specific fault response | If validation fails, service returns specific fault response to the caller. |
| 4. | If the request succeeds after calling the Endpoint | A success response is sent to the Xapi which sends the success response to the caller. |
| 5. | If the request fails after calling the System layer | A failed response or a message is sent to Xapi which send the messages to the caller. |
End Point details:
Access Arrangement Experience API : /v1/candidates
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Send candidate details to Appian |
| 2. | URI | /v1/candidates |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | Appian |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/candidates |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Access Arrangement Experience API : /v1/mails/notifications
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Send mail notifications to Appian |
| 2. | URI | /v1/mails/notifications |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | Appian |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/mails/notifications |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Access Arrangement Experience API : /v1/requestDetails
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Retrieve request details from Appian |
| 2. | URI | /v1/requestDetails |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | Appian |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/requestDetails |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Access Arrangement Experience API : /v1/centres/{centreId}
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Retrieve centres details from SAP |
| 2. | URI | /v1/mails/notifications |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | SAP |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/centres/{centreId} |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Access Arrangement Experience API : /v1/candidatesList (GET)
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Retrieve candidate list from Appian |
| 2. | URI | /v1/candidatesList |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | Appian |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/candidatesList |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Comment:
To retrieve single candidate details candidateId query param is mandatory
To retrieve Summary page requestId and isSummary is mandatory
Access Arrangement Experience API : /v1/candidatesList (POST)
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • post the candidates list to Appian |
| 2. | URI | /v1/candidatesList |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | Appian |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/candidatesList |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Access Arrangement Experience API : /v1/candidateDetails (GET)
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Retrieve candidate Details from Appian |
| 2. | URI | /v1/candidateDetails |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | Appian |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/candidateDetails |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |
Comment: requestid is mandatory param.
Comment: parentCentreNumber, isParent, isOther to get the parent details
Access Arrangement Experience API : /v1/centres/(centreId)/headCentres (GET)
| Topic | Details | |
|---|---|---|
| 1. | Operation Description | • Retrieve the headCentres and centreId |
| 2. | URI | /v1/centres/(centreId)/headCentres |
| 3. | Interface Source | Desktop / Web User |
| 4. | Interface Target | salesforce sapi |
| 5. | Synchronous/Asynchronous | Synchronous |
| 6. | Protocol | HTTPs |
| 7. | URL | https://apis-sandbox.cambridgeassessment.org.uk/cupa-access-arrangement-xapi-dev/api/v1/centres/(centreId)/headCentres |
| 8. | Mode of Communication | ☐ Batch ☐ Message ☒ Real Time |
| 9. | Interface Pattern | ☐ Publish / Subscribe ☒ Request / Reply |