Service Request
Service Request microservice is a generic order management system. It helps to capture the customer’s different service requests that are raised by the Digital Retail Banking channels. Service Request microservice maintains the life cycle of all the service requests.
The user must perform additional configurations in the Quantum Fabric before consuming the Service Request APIs. For more information, click here.
The following are the Experience APIs that are associated with the Service Request microservice.
| Name | Description | Introduced In |
|---|---|---|
| createOrder | This API allows the user to create an order or request in Service Request Microservice. | 2020.10 |
| getOrderDetails | This API allows the user to fetch the order or service request details from the Service Request Microservice. | 2020.10 |
| triggerForStatus | This API allows the user to trigger the service request based on certain user criteria and update the status in Service Request Microservice. | 2020.10 |
createOrder
| Description: | This API allows the user to create an order or request in Service Request Microservice | |||
| Method: | Integration Service | |||
| URL: | /services/ServiceRequestJavaService/createOrder | |||
| Security Level: | Authenticated App User | |||
| Header Request: | X-Kony-Authorization | |||
| Body Request: |
Parameters accountId (Mandatory) Specifies the unique ID of the account. type (Mandatory) Specifies the type of the Service Request Configuration. subtype (Mandatory) Specifies the sub-type of the Service Request Configuration. requestBody (Mandatory) Specifies the body request. The request must contain all the mandatory attributes that are in the format of a single-quoted key-value pair schema. All the attributes must be separated by a comma. {
"accountId":"80942",
"type":"AccountCheck",
"subtype":"ChequeBookTest",
"requestBody":"{'chequeIssueId':'SB.80942','note':'sandy'}"
}
|
|||
| Response: |
Parameters /code Specifies the code received from the Service Request microservice. /orderId Specifies the unique ID of the service request. /message Specifies the message received from the Service Request microservice. /status Specifies the status of the service request. {
"code": "",
"orderId": "SR20278UG7PB",
"opstatus": 0,
"message": "Service Request created successfully",
"status": "Initiated",
"httpStatusCode": 0
}
|
|||
| Error Code(s): |
|
|||
| Service Flow: |
|
getOrderDetails
| Description: | This API allows the user to fetch the order or service request details from the Service Request Microservice | ||
| Method: | Integration Service | ||
| URL: | /services/ServiceRequestJavaService/getOrderDetails | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters accountId (Mandatory) Specifies the unique ID of the account. type Specifies the type of the Service Request Configuration. subtype Specifies the sub-type of the Service Request Configuration. requestBody Specifies the body request. The request must contain all the mandatory attributes that are in the format of a single-quoted key-value pair schema. All the attributes must be separated by a comma. dateTo Specifies the upper limit of the date range for the Service Request to fetch (Format: yyyy-mm-dd). dateFrom Specifies the lower limit of the date range for the Service Request to fetch (Format: yyyy-mm-dd). {
"accountId":"80942",
"type":"AccountCheck",
"subtype":"ChequeBookTest",
"requestBody":"{'chequeIssueId':'SB.80942','note':'sandy'}",
"dateTo":"2020-09-30",
"dateFrom":"2020-08-30",} |
||
| Response: |
Parameters /serviceReqs Specifies an array of service requests and the corresponding details . /serviceReqs/serviceReqRequestIn Specifies the service request input. /serviceReqs/serviceReqRequestIn/note Specifies the additional notes for the request input. /serviceReqs/serviceReqRequestIn/chequeIssueId Specifies the unique ID of the issued cheque. /serviceReqs/serviceReqStatus Specifies the status of the response fetched from the microservice. /serviceReqs/serviceReqProcessedTime Specifies the time required for processing the service request. /serviceReqs/currentAttempt Specifies the current attempt for fetching the response. /serviceReqs/type Specifies the type of service request. /serviceReqs/externalserviceReqRef Specifies the reference number of the external service request. /serviceReqs/accountId Specifies the unique ID of the account. /serviceReqs/requestConfigId Specifies the unique ID of the request config. /serviceReqs/serviceReqResponse Specifies the response of the service request. /serviceReqs/subType Specifies the /serviceReqs/serviceReqId Specifies the sub-type of the Service Request Configuration. /serviceReqs/partyId Specifies the unique ID of the Party. /serviceReqs/errorDetails Specifies the error details. {
"serviceReqs": [
{
"serviceReqRequestIn": {
"note": "sandy",
"chequeIssueId": "SB.80942"
},
"serviceReqStatus": "Initiated",
"serviceReqProcessedTime": "2020-10-04T11:52:01.067Z",
"currentAttempt": 1,
"type": "AccountCheck",
"externalserviceReqRef": "",
"accountId": "80942",
"requestConfigId": "ChequeBookRequest",
"serviceReqResponse": "",
"subType": "ChequeBookTest",
"serviceReqId": "SR20278PAEVH",
"partyId": "157750289",
"errorDetails": ""
}] ,
"opstatus": 0,
"httpStatusCode": 200}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
triggerForStatus
| Description: | This API allows the user to trigger the service request based on certain user criteria and update the status in Service Request Microservice. | ||
| Method: | Integration Service | ||
| URL: | /services/ServiceRequestJavaService/triggerForStatus | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters type Specifies the type of the Service Request Configuration. subtype Specifies the sub-type of the Service Request Configuration. requestBody Specifies the body request. The request must contain all the mandatory attributes that are in the format of a single-quoted key-value pair schema. All the attributes must be separated by a comma. dateTo Specifies the upper limit of the date range for the Service Request to fetch (Format: yyyy-mm-dd). dateFrom Specifies the lower limit of the date range for the Service Request to fetch (Format: yyyy-mm-dd). {
"dateTo":"2020-09-30",
"dateFrom":"2020-08-30",
"type":"AccountCheck",
"subtype":"ChequeBookTest",
"status": "REQUEST RECIEVED"
}
|
||
| Response: |
Parameters /code Specifies the code received from the Service Request microservice. /statusmessage Specifies the status message received for the retrigger Operation. /message Specifies the message for the trigger request. {
"code": "",
"opstatus": 0,
"message": "Service Request created successfully",
"status": "Initiated",
"httpStatusCode": 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
In this topic