diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm
index 13b9b1446..3d527db70 100644
--- a/api-docs/apiLive.htm
+++ b/api-docs/apiLive.htm
@@ -208,6 +208,98 @@
+
+
+
+
+
+
+
+
+
Groups
+
Groups are collection of clients for specific purpose (JLG,SHG, Program etc)
+
+
+ Field Descriptions |
+
+
+ | office_id |
+
+
+ | It stores the officeid of office, to this officer Group belongs. |
+
+
+ | loan_officer_id |
+
+
+ | Id of the officer who manages this group. |
+
+
+ | name |
+
+
+ | Human friendly identity of the Group (Name given to the group). |
+
+
+ | externalId |
+
+
+ A place to put an external reference for
+ this group e.g. The ID another system uses.
If
+ provided, it must be unique.
+ |
+
+
+ | is_deleted |
+
+
+ | Indicator for active or archived groups.
+ |
+
+
+
+
+
+
Create a Group
+
+
+ Mandatory Fields |
+
+
+ name
+ officeId
+ clients
+ |
+
+
+
+
+
+ POST https://DomainName/mifosng-provider/api/v1/groups
+
+
+ POST groups
+ Content-Type: application/json Request Body:
+ {
+ "officeId":"1",
+ "name":"TA Group",
+ "externalId":"",
+ "clientMembers":["82","83","84"]
+ }
+
+
+ {"resourceId":24,"changes":{}}
+
+
+
+
+
List Groups
+
Example Requests:
+
groups
+
+
+
+GET https://DomainName/mifosng-provider/api/v1/groups
+
+
+[{
+ "id": 1,
+ "name": "GWT_2",
+ "externalId": "GWT_EX_ID_2",
+ "officeId": 7,
+ "officeName": "Z2"
+}, {
+ "id": 2,
+ "name": "group22",
+ "externalId": "11234",
+ "officeId": 1,
+ "officeName": "Head Office"
+}, {
+ "id": 3,
+ "name": "PlusOne",
+ "officeId": 22,
+ "officeName": "North Point Office"
+}]
+
+
+
+
+
Retrieve a Group
+
Example Requests:
+
groups/10
+
+
+
+GET https://DomainName/mifosng-provider/api/v1/groups/10
+
+
+{
+ "id": 10,
+ "name": "test123",
+ "externalId": "tejjjst",
+ "officeId": 1,
+ "officeName": "Head Office",
+ "clientMembers": [{
+ "id": 1,
+ "displayName": "Willie O\u0027Meara"
+ }]
+}
+
+
+
+
+
Retrieve a Groups's Loan Account Summary
+
+ An example of how a loan portfolio summary can be provided. This
+ one contains quite a bit of redundant data (like the counts)
+
+
Example Requests:
+
groups/7/loans
+
+
+
+GET https://DomainName/mifosng-provider/api/v1/groups/7/loans
+
+
+{
+ "anyLoanCount": 1,
+ "pendingApprovalLoanCount": 0,
+ "pendingApprovalLoans": [],
+ "awaitingDisbursalLoanCount": 0,
+ "awaitingDisbursalLoans": [],
+ "activeLoanCount": 1,
+ "openLoans": [{
+ "id": 79,
+ "productId": 1,
+ "productName": "1-PORetailLoan",
+ "accountStatusId": 300
+ }],
+ "closedLoanCount": 0,
+ "closedLoans": [],
+ "anyIndividualLoanCount": 3,
+ "pendingApprovalIndividualLoanCount": 0,
+ "pendingApprovalIndividualLoans": [],
+ "awaitingDisbursalIndividualLoanCount": 0,
+ "awaitingDisbursalIndividualLoans": [],
+ "activeIndividualLoanCount": 3,
+ "openIndividualLoans": [{
+ "id": 80,
+ "productId": 17,
+ "productName": "17-Intrasoft Business Loan",
+ "accountStatusId": 300
+ }, {
+ "id": 81,
+ "productId": 1,
+ "productName": "1-PORetailLoan",
+ "accountStatusId": 300
+ }, {
+ "id": 82,
+ "productId": 13,
+ "productName": "13-A Flat Loan",
+ "accountStatusId": 300
+ }],
+ "closedIndividualLoanCount": 0,
+ "closedIndividualLoans": []
+}
+
+
+
+
+
Update a Group
+
+
+
+PUT https://DomainName/mifosng-provider/api/v1/groups/{groupid}
+
+
+PUT groups/7
+Content-Type: application/json
+Request Body:
+{
+ "officeId": "26",
+ "name": "Laxmi SSG U",
+ "externalId": "Unq 2--124",
+ "clientMembers": ["91", "93", "94"]
+}
+
+
+{
+ "resourceId":7,
+ "changes":{}
+}
+
+
+
+
+
Assign a Loan Officer to Group
+
+
+
+POST https://DomainName/mifosng-provider/api/v1/groups/{groupid}/command/assign_loanofficer
+
+
+POST groups/20/command/assign_loanofficer
+Content-Type: application/json
+Request Body:
+{
+{"loanOfficerId":"1"}
+}
+
+
+{
+ "resourceId":20,
+ "changes":{}
+}
+
+
+
+
+
Unassign a loan officer to a Group
+
+
+
+POST https://DomainName/mifosng-provider/api/v1/groups/{groupid}/command/assign_loanofficer
+
+
+POST groups/20/command/unassign_loanofficer
+Content-Type: application/json
+Request Body:
+{
+{"loanOfficerId":"1"}
+}
+
+
+{
+ "resourceId":20,
+ "changes":{}
+}
+
+
+
+
+
Delete a Group
+
+
+
+POST https://DomainName/mifosng-provider/api/v1/groups/{groupid}
+
+
+DELETE groups/7
+
+
+{
+ "resourceId":7,
+ "changes":{}
+}
+
+
+