Enterprise APIs

This is the basic version of Service Request microservice APIs. The V1.0.0 version of Service Request microservice APIs contains three functional groups with their respective operations as follows.

 

Functional Group API Description
Service Request Configuration
createServiceReqConfig
updateServiceReqConfig
getServiceReqConfig
This API creates a new Service Request Configuration record with the given details.
This API updates a new Service Request Configuration record with the existing details.
This API retrieves the Service Request Configuration records.
Service Request
createServiceReq
updateServiceReq
getRequestDetails
This API creates a new Service Request record against the Service Request Configuration with the given details.
This API updates the Service Request record.
This API retrieves the Service Request record.
ReTrigger Service Request reTriggerAwaitingSerReq This API performs a status check for awaiting order periodically.

 

To view the Swagger Spec of the Service Request microservice APIs, click here.

createServiceReqConfig
This API creates a new Service Request Configuration record with the given details.

POST/orders/type/{typeId}/subType/{subTypeId}/serviceRequestConfiguration/{requestConfigId}

Sample Response
{
  "id": "200722894",
  "status": "Success",
  "message": "Created/Updated Succesfully"
}
updateServiceReqConfig
This API updates a new Service Request Configuration record with the existing details.

PUT/orders/type/{typeId}/subType/{subTypeId}/serviceRequestConfiguration/{requestConfigId}

Sample Response
{
  "id": "200722894",
  "status": "Success",
  "message": "Created/Updated Succesfully"
}
getServiceReqConfig
This API retrieves the Service Request Configuration records.

GET/orders/serviceRequestConfigurations

Sample Response
{
  "serviceReqConfig": [
    {
      "requestConfigId": "replaceCard",
      "type": "Card",
      "subType": "replaceCard",
      "endPointCommandName": "T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS",
      "maxRetryAttempt": 15,
      "adminApprovalRequired": true,
      "notificationEnabled": true,
      "notificationStages": [
        "Initiated",
        "Processed"
      ],
      "awaitingEnabled": false,
      "awaitingEndPoint": "T24ISSTOPPAYMENTS_CREATECHEQUEBOOKREQUESTS",
      "awaitingMaxRetryAttempted": 15,
      "preSubmissionScript": "zhfuifnerDSAHRIOnjfsaduf+oHDSNFEO=UR184145+62",
      "requestAttribute": [
        {
          "attributeName": "ChequeIssueId/note",
          "mandatory": true,
          "dataType": "string",
          "maxLength": 15,
          "allowedValues": [
            "SB.2406",
            "SB.2568"
          ]
        }
      ],
      "realTime": false,
      "eventSource": "api",
      "product": "Card",
      "prefix": "CRD"
    }
  ]
}
createServiceReq
This API creates a new Service Request record against the Service Request Configuration with the given details.


POST/orders/party/{partyId}/type/{typeId}/subtype/{subtypeId}/serviceRequest

Sample Response
{
  "uuid": "390882aa-6453-4546-ad74-77dd33655f0c",
  "serviceReqConfId": "deleteCard",
  "account": "87907",
  "requestIn": {
    "checkIssueId": "SB.2406",
    "note": "CreateNew"
  }
}
updateServiceReq
This API updates the Service Request record.

PUT/orders/serviceRequest/{requestId}

Sample Request
{
  "request": "{'checkIssueId':'SB.2406','note':'CreateNew'}",
  "backendResponse": "{'httpStatus':'200','dbpError':''}",
  "serviceReqId": "ORD127REDFDSAS",
  "status": "Initiated/Success",
  "errorMessage": "Nil",
  "externalReference": "SB.1441"
}
Sample Response
{
  "id": "200722894",
  "status": "Success",
  "message": "Created/Updated Succesfully"
}
getRequestDetails
This API retrieves the Service Request record.

GET/orders/party/{partyId}

Sample Response
{
  "serviceReqs": [
    {
      "serviceReqId": "ORD127REDFDSAS",
      "externalserviceReqRef": "ORD12HNFU34I4N5",
      "description": "Status Initiated",
      "partyId": "GB0010001-100100",
      "accountId": "GB0010001-89707",
      "type": "Card",
      "subType": "replaceCard",
      "currentAttempt": 5,
      "requestConfigId": "replaceCard",
      "serviceReqRequestIn": {
        "checkIssueId": "SB.2406",
        "note": "CreateNew"
      },
      "serviceReqResponse": {
        "httpStatus": "200",
        "dbpError": ""
      },
      "errorDetails": "Nil",
      "serviceReqStatus": "Initiated/Success",
      "serviceReqProcessedTime": "2020-08-20T06:01:01.729Z"
    }
  ]
}
reTriggerAwaitingSerReq
This API performs a status check for awaiting order periodically.

PUT/orders/type/{typeId}/subType/{subTypeId}/status/statusCheck

Sample Request
{
  "dateFrom": "2020-08-20T06:01:01.729Z",
  "dateTo": "2020-08-20T06:01:01.729Z",
  "status": [
    "Initiated",
    "Awaiting"
  ],
  "uuid": "390882aa-6453-4546-ad74-77dd33655f0c"
}
Sample Response
{
  "id": "200722894",
  "status": "Success",
  "message": "Created/Updated Succesfully"
}

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?