Skip to content
dalani257 edited this page Sep 30, 2019 · 18 revisions

The API doc for NIBSS self service portal (Work still in progress)

Base URI https://196.6.103.40/selfservicews/ws/tx

  1. Institution type 1.1 Add institution type Endpoint: https://196.6.103.40/selfservicews/ws/tx/addinstitutiontype/{institutiontypename} e.g: https://196.6.103.40/selfservicews/ws/tx/addinstitutiontype/registrar

Expected Response (Success): {"code":"registrar-2019-09-03-030435","message":"OK","status":"200"}

Expected Response (Failed): {"message":"Institution type failed to create!","status":"500"}

**1.2. Edit institution type Endpoint: e.g

**1.3. Delete institution type Endpoint: e.g

1.4. Fetch institution type Endpoint:

  1. Institution 2.1 Add institution Endpoint: https://196.6.103.40/selfservicews/ws/tx/addinstitution/{institutiontype}/{institutionname}/{code} e.g: https://196.6.103.40/selfservicews/ws/tx/addinstitution/17/datamax/923

Expected Response (Success): {"message":"OK","status":"200"} **2.2 Edit institution Endpoint: https e.g

2.3 Delete institution Endpoint: e.g:

2.4 Fetch institution Endpoint e.g

### ## # ### 3. Add role

**

1.2 Services

  1. Add service Endpoint: https://196.6.103.40/selfservicews/ws/tx/addservice

Sample Request: {"serviceName": "EPCCOS","serviceUrl":"https://apps.nibss-plc.com.ng/EPCCOS", "serviceDescription":"testing"}

Expected Result: { "code": "EPCC-2019-09-06-120227", "message": "Service successfully created!", "status": "200" }

  1. Edit service

Endpoint: https://196.6.103.40/selfservicews/ws/tx/editservice

Sample Request: Field (name): {"serviceCode": "ASV -2019-09-09-113208", "fieldName":"name","fieldNewValue":"ASV Portal test3"}

Field (url): {"serviceCode": "ASV -2019-09-09-113208", "fieldName":"url","fieldNewValue":"https://docs.spring.io/spring-boot/docs/2.2.0.M5/reference/html/getting-started.html#getting-started"}

Field (description): {"serviceCode": "ASV -2019-09-09-113208", "fieldName":"description","fieldNewValue":"testing!testing!!"}

Expected Result: { "message": "Service successfully edit!", "status": "200" }

  1. Delete service Endpoint: https://196.6.103.40/selfservicews/ws/tx/deleteservice

Sample Request: {"serviceCode": "EPCC-2019-09-06-031056"}

Expected Result: { "message": "Service successfully deleted!!", "status": "200" }

  1. Send feedback mail Endpoint: https://196.6.103.40/selfservicews/ws/tx/sendemail

Sample Request: {"senderName":"banky","mailTo": "bankyalani@gmail.com","subject":"Customer Feedback", "body":"Please give us an API for eDMMS"}

Expected Result: { "status": "200" }