Versions Compared

Key

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

...

TYPE

GET

URL

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

PATH ARGUMENTS

globalCustNum

REQUEST PARAMS

 

RETURNS

ClientInformationDto

EXAMPLE RESPONSE

No Format
{
    "address": {
        "state": "",
        "country": "",
        "displayAddress": null,
        "city": "",
        "zip": "",
        "phoneNumber": ""
    },
    "customerMeeting": {
        "meetingSchedule": "Recur every 1 Week(s) on TuesdayMonday",
        "meetingPlace":"Test Office"}, "rest"
    },
    "customerFlags": [],
    "clientPerformanceHistory": {
        "loanCycleNumber":1, 0,
        "lastLoanAmount": "0.0",
        "noOfActiveLoans":1, 2,
        "delinquentPortfolioAmount": "0.70",
        "totalSavingsAmount": "180105.60",
        "meetingsAttended": 0,
        "meetingsMissed": 0,
        "loanCycleCounters": [
            {
                "counter": 1,
                "offeringName":"Small Business (WC) Loan"}]},"recentCustomerNotes":[{"commentDate":"2011-05-03","personnelName":"Test Officer","comment":"Text"}],"activeSurveys":false,"customerAccountSummary":{"globalAccountNum":"000300000000010","nextDueAmount":"10.0"},"savingsAccountsInUse":[{"globalAccountNum":"000300000000012","prdOfferingId":null,"prdOfferingName":"Mandatory Savings Account","accountStateName":"Active","accountStateId":16,"savingsBalance":"180.6"}],"customerSurveys":[],"loanAccountsInUse":[{"globalAccountNum":"000300000000011","prdOfferingName":"Small Business (WC) Loan","outstandingBalance":"1089.0","totalAmountDue":"794.0","accountStateName":"Active in Bad Standing","accountStateId":9}],"clientDisplay":{"age":19,"branchId":3,"customerId":10,"loanOfficerId":6,"dateOfBirth":"1992-01-01","governmentId":"A0007","maritalStatus":"UnMarried","globalCustNum":"0003-000000010","externalId":"","customerActivationDate":"2011-05-03","customerLevelId":1,"customerStatusName":"Active","spouseFatherName":"Johny M. Mnemonic","trainedDate":"2011-01-01","familyDetails":null,"businessActivities":"Production","citizenship":"Christian","educationLevel":"Only Client","handicapped":"No","numChildren":0,"povertyStatus":"Poor","customerStatusId":3,"loanOfficerName":"Test Officer","parentCustomerDisplayName":null,"customerFormedByDisplayName":"Test Officer","blackListed":false,"branchName":"Test Manota","clientUnderGroup":false,"ethnicity":"Ga","isCustomerPicture":false,"areFamilyDetailsRequired":false,"spouseFatherValue":"Father","displayName":"Valerie Mnemonic"},"address":{"displayAddress":null,"city":"","zip":"","phoneNumber":"","state":"","country":""} "REST Loan Product A"
            },
            {
                "counter": 1,
                "offeringName": "REST Loan Product B"
            }
        ]
    },
    "recentCustomerNotes": [
        {
            "comment": "Active",
            "commentDate": "2011-09-12",
            "personnelName": "mifos"
        }
    ],
    "activeSurveys": false,
    "customerAccountSummary": {
        "globalAccountNum": "000100000000003",
        "nextDueAmount": "0.0"
    },
    "savingsAccountsInUse": [
        {
            "globalAccountNum": "000100000000006",
            "prdOfferingId": null,
            "prdOfferingName": "Savings A",
            "accountStateName": "Active",
            "accountStateId": 16,
            "savingsBalance": "10.0"
        },
        {
            "globalAccountNum": "000100000000007",
            "prdOfferingId": null,
            "prdOfferingName": "Savings B",
            "accountStateName": "Active",
            "accountStateId": 16,
            "savingsBalance": "95.0"
        }
    ],
    "customerSurveys": [],
    "loanAccountsInUse": [
        {
            "globalAccountNum": "000100000000004",
            "prdOfferingName": "REST Loan Product A",
            "outstandingBalance": "101.0",
            "totalAmountDue": "10.0",
            "accountStateName": "Active in Good Standing",
            "accountStateId": 5
        },
        {
            "globalAccountNum": "000100000000005",
            "prdOfferingName": "REST Loan Product B",
            "outstandingBalance": "1032.0",
            "totalAmountDue": "103.0",
            "accountStateName": "Active in Good Standing",
            "accountStateId": 5
        }
    ],
    "clientDisplay": {
        "displayName": "Client REST API",
        "branchId": 2,
        "customerId": 3,
        "loanOfficerId": 2,
        "dateOfBirth": "1986-06-06",
        "governmentId": "",
        "maritalStatus": null,
        "globalCustNum": "0002-000000003",
        "externalId": "",
        "customerActivationDate": "2011-09-12",
        "customerLevelId": 1,
        "customerStatusName": "Active",
        "spouseFatherName": "first last",
        "trainedDate": null,
        "familyDetails": null,
        "age": 25,
        "businessActivities": null,
        "citizenship": null,
        "educationLevel": null,
        "handicapped": null,
        "numChildren": null,
        "povertyStatus": "Very poor",
        "customerStatusId": 3,
        "loanOfficerName": "loan officer",
        "parentCustomerDisplayName": "Group-REST",
        "customerFormedByDisplayName": "loan officer",
        "blackListed": false,
        "branchName": "Branch Office",
        "clientUnderGroup": true,
        "ethnicity": null,
        "areFamilyDetailsRequired": false,
        "spouseFatherValue": "Spouse"
    }
}

Personnel

getCurrentPersonnel

...