Skip to content

Home

Jump to bottom
dalani257 edited this page Oct 1, 2019 · 18 revisions

Endpoint URL Action (GET,POST,PUT,PATCH,DELETE) Payload Success Error Base URI https://196.6.103.40/selfservicews/ws/tx

Service Add service https://196.6.103.40/selfservicews/ws/tx/addservice POST { "serviceName": "EPCCOS", "serviceUrl":"https://apps.nibss-plc.com.ng/EPCCOS", "serviceDescription":"testing" } 200 OK

{ "code": "EPCC-2019-09-06-120227", "message": "Service successfully created!", "status": "200" } 400 Bad Request

Edit service https://196.6.103.40/selfservicews/ws/tx/editservice POST 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!!"} 200 OK

{ "message": "Service successfully edit!", "status": "200" } 400 Bad Request

Delete service https://196.6.103.40/selfservicews/ws/tx/deleteservice DELETE {"serviceCode": "EPCC-2019-09-06-031056"} 200 OK

{ "message": "Service successfully deleted!!", "status": "200" } 400 Bad Request

Send Customer Feedback/Send Email notification API Send Customer feedback https://196.6.103.40/selfservicews/ws/tx/sendemail POST {"senderName":"banky","mailTo": "[email protected]","subject":"Customer Feedback", "body":"Please give us an API for eDMMS"} { "status": "200" }

Institution types Find institution types https://196.6.103.40/selfservicews/ws/tx/findinstitutiontypes GET https://196.6.103.40/selfservicews/ws/tx/findinstitutiontypes 200 OK 400 Bad Request

Add institution type https://196.6.103.40/selfservicews/ws/tx/addinstitutiontype POST { "institutionTypeName": "Bank” } 200 OK

{"code":"bank-2019-09-30-030435","message":"OK","status":"200"} 400 Bad Request

{"message":"Institution type failed to create!","status":"400"} Edit institution type https://196.6.103.40/selfservicews/ws/tx/editinstitutiontype PUT Field (name): {"institutiontypeCode": " bank-2019-09-30-030435", "fieldName":"name","fieldNewValue":"Commercial Bank"}

200 OK

{ "message": "Institution type successfully edited!", "status": "200" } 400 Bad Request

Delete institution type https://196.6.103.40/selfservicews/ws/tx/deleteinstitutiontype DELETE {"institutiontypeCode": " bank-2019-09-30-030435"} 200 OK

{ "message": "Institution type successfully deleted!!", "status": "200" } 400 Bad Request

Institutions Fetch institutions https://196.6.103.40/selfservicews/ws/tx/findinstitutions GET https://196.6.103.40/selfservicews/ws/tx/findinstitutions 200 Ok

[{"code":"923","name":"datamax","id":"3"},{"code":"gtb-2019-09-03-010021","name":"gtb","id":"2"}] 400 Bad Request

Add institution https://196.6.103.40/selfservicews/ws/tx/addinstitution POST {"code": "905", "fullName":"APEL REGISTRARS","institutionTypeId":"17"}

Note: ‘code’ is unique for every institution { "code": "", "message": "Institution successfully created!", "status": "200" } 400 Bad Request

{ "message": "Institution creation failed!", "status": "400" }

Edit institution https://196.6.103.40/selfservicews/ws/tx/editinstitution PUT {"code": "905", "fieldName":"institutionName","fieldNewValue":"NEW APEL"} 200 OK

{ "message": "Institution successfully edited!", "status": "200" } 400 Bad Request

{ "message": "Institution edit failed!", "status": "400" } Delete institution https://196.6.103.40/selfservicews/ws/tx/deleteinstitution DELETE {"code": "905"} { "message": "Institution successfully deleted!", "status": "200" } 400 Bad Request

{ "message": "Institution delete failed!", "status": "400" }

Branches (CRUD) Fetch branches https://196.6.103.40/selfservicews/ws/tx/findbranches GET 200 OK [{"branch_code":"1500","branch_name":"Adeola Odeku","id":"1","created_date":"2019-10-01 13:29:00"}] 400 Bad Request Add branch https://196.6.103.40/selfservicews/ws/tx/addbranch POST {"code": "1505", "name":"Akin Odesola", "location": "Akin Odesola Str,V/I","institution":"8"} { "code": "", "message": "Branch successfully created!", "status": "200" } { "message": "Branch creation failed!", "status": "400" }

Update branch https://196.6.103.40/selfservicews/ws/tx/editBranch PUT {"branch_code": "1501", "fieldName":"location","fieldNewValue":"Oyin Jolayemi Str,V/I"} { "message": "Branch successfully edited!", "status": "200" } { "message": "Branch editing failed!!!", "status": "400" }

Delete branch https://196.6.103.40/selfservicews/ws/tx/deletebranch POST {"code": "1505"} 200k { "message": "Branch successfully deleted!", "status": "200" } 400 bad Request

{ "message": "Branch delete failed!", "status": "400" }

ROLES (CRUD) Fetch roles https://196.6.103.40/selfservicews/ws/tx/findroles GET 200 OK { "message": "Role successfully created!", “code”:”role-admin-20190901” "status": "200" } 400 Bad Request Add role https://196.6.103.40/selfservicews/ws/tx/addrole POST {"name":"1500","institutiontype":"17","roleconfig":”1”} { "code": "", "message": "Role successfully created!", “code”:”role-NIBSS-admin-20190901”

"status": "200"

} { "message": "Role creation failed!", "status": "400" }

Update role https://196.6.103.40/selfservicews/ws/tx/editRole PUT {"role_code": " role-NIBSS-admin-20190901", "fieldName":"userRoleName","fieldNewValue":"NIBSS Special Admin"} { "message": "Role successfully edited!", "status": "200" } { "message": "Role editing failed!!!", "status": "400" }

Delete role https://196.6.103.40/selfservicews/ws/tx/deleteRole POST {"code": " role-NIBSS-admin-20190901"} 200k { "message": "Role successfully deleted!", "status": "200" } 400 bad Request { "message": "Role delete failed!", "status": "400" }

SwaggerUI

Clone this wiki locally