Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

As REST API uses existing service facades it only need functional testing which is done by acceptance tests (see RESTAPITest.java)

API Documentation

Table of Contents
minLevel3
indent20px
styledisc

Clients

getClientByNumber

...

TYPE

...

GET

...

URL

...

No Format
 BASE_URL/client/num-{globalCustNum}.json

...

PATH ARGUMENTS

...

globalCustNum

...

REQUEST PARAMS

...

 

...

RETURNS

...

ClientInformationDto

...

EXAMPLE RESPONSE

...

REST

...

Personnel

getCurrentPersonnel

TYPE

GET

URL

No Format
 BASE_URL/personnel/id-current.json

PATH ARGUMENTS

 

REQUEST PARAMS

 

RETURNS

PersonnelInformationDto

EXAMPLE RESPONSE

No Format
{
    "id":1,
    "displayName":"mifos",
    "status":{
        "name":"Active",
        "id":1
    },
    "userName":"mifos",
    "title":1,
    "locked":false,
    "levelId":2,
    "personnelId":1,
    "officeId":1,
    "personnelRoles":[{
            "name":"Admin",
            "id":1
        }
    ],
    "officeName":"Mifos HO ",
    "personnelDetails":{
        "address":{
            "state":"Bangalore",
            "country":"Bangalore",
            "displayAddress":"Bangalore",
            "city":"Bangalore",
            "zip":"",
            "phoneNumber":"",
            "line1":"Bangalore",
            "line2":"",
            "line3":""
        },
        "governmentIdNumber":"123",
        "dob":313801200000,
        "maritalStatus":null,
        "gender":50,
        "dateOfJoiningMFI":1315864800000,
        "dateOfJoiningBranch":1315864800000,
        "dateOfLeavingBranch":1315864800000,
        "firstName":"Mifos",
        "middleName":null,
        "secondLastName":null,
        "lastName":"MFI"
    },
    "emailId":null,
    "customFields":[],
    "personnelNotes":[],
    "globalPersonnelNum":"1",
    "age":"31",
    "recentPersonnelNotes":[],
    "preferredLocaleLanguageName":"English - (English) : United Kingdom [en_GB]",
    "preferredLanguageId":1
}

Loans

repay

TYPE

POST

URL

No Format
 BASE_URL/account/loan/repay/num-{globalAccountNum}.json

PATH ARGUMENTS

globalAccountNum

REQUEST PARAMS

amount, client

RETURNS

Map:
* status
* clientName
* clientNumber
* loanDisplayName
* paymentDate
* paymentTime
* paymentAmount
* paymentMadeBy
* outstandingBeforePayment
* outstandingAfterPayment

EXAMPLE RESPONSE

No Format
{
    "outstandingAfterPayment": "1.0",
    "paymentAmount": "100.0",
    "paymentDate": "2011-09-13",
    "status": "success",
    "paymentTime": "23:24:00.013",
    "clientName": "Client REST API",
    "paymentMadeBy": "mifos",
    "outstandingBeforePayment": "101.0",
    "loanDisplayName": "REST Loan Product A",
    "clientNumber": "0002-000000003"
}

Savings

deposit

...

TYPE

...

POST

...

URL

...

No Format
 BASE_URL/account/savings/deposit/num-{globalAccountNum}.json

...

PATH ARGUMENTS

...

globalAccountNum

...

REQUEST PARAMS

...

amount, client

...

RETURNS

...

Map:
* status
* clientName
* clientNumber
* savingsDisplayName
* paymentDate
* paymentTime
* paymentAmount
* paymentMadeBy
* balanceBeforePayment
* balanceAfterPayment

...

EXAMPLE RESPONSE

...

API Reference