From 8192e55942fce69081fe4f0f32fc845d3fc90b7b Mon Sep 17 00:00:00 2001 From: Mohammed Nafees Date: Sat, 13 Dec 2014 22:31:31 +0530 Subject: [PATCH] MIFOSX-969 Missing API Documentation for Collection Sheets --- api-docs/apiLive.htm | 132 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 125 insertions(+), 7 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 6329165db..ec491b809 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -5617,6 +5617,48 @@ GET https://DomainName/mifosng-provider/api/v1/centers?paged=true The individual client members that make up the group. The clients must be assigned to the same office as this group. + + calendarId + + + The identifier of the calendar to which the transaction is linked with. + + + transactionDate + + + The date on which the transaction took place. + + + role + + + The role to be assigned to a client. + + + actualDisbursementDate + + + The date on which the actual disbursement took place. + + + clientsAttendance + + + The clients attendance. + + + bulkRepaymentTransaction + + + The details of any bulk repayment transactions. + + + bulkDisbursementTransactions + + + The details of any bulk disbursement transactions. + @@ -5767,7 +5809,7 @@ GET https://DomainName/mifosng-provider/api/v1/groups/template?centerId=1
Optional Fields
- externalId,staffId,clientMembers + externalId, staffId, clientMembers @@ -5819,9 +5861,18 @@ Content-Type: application/json Request Body:  
-

Activate a Group

+

Activate a Group

Groups can be created in a Pending state. This API exists to enable group activation.

If the group happens to be already active this API will result in an error.

+ + + + + + + +
Mandatory Fields
activationDate
+
POST https://Domain Name/api/v1/groups/{groupId}?command=activate @@ -5847,10 +5898,19 @@ Request Body:  
-

Associate Clients

+

Associate Clients

This API allows to associate existing clients to a group.

The clients are listed from the office to which the group is associated.

If client(s) is already associated with group then API will result in an error.

+ + + + + + + +
Mandatory Fields
clientMembers
+
@@ -5875,9 +5935,18 @@ Request Body:  
-

Disassociate Clients

+

Disassociate Clients

This API allows to disassociate clients from a group.

Disassociating a client with active joint liability group loans results in an error.

+ + + + + + + +
Mandatory Fields
clientMembers
+
@@ -5903,7 +5972,7 @@ Request Body:  
-

Transfer Clients across groups

+

Transfer Clients across groups

This API allows to transfer clients from one group to another

@@ -5978,7 +6047,16 @@ Request Body:

Generate Collection Sheet

-

This api retrieves repayment details of all jlg loans of all members of a group on a specified meeting date.

+

This API retrieves repayment details of all jlg loans of all members of a group on a specified meeting date.

+
+
+ + + + + + +
Mandatory Fields
calendarId, transactionDate
POST https://Domain Name/api/v1/groups/{groupId}?command=generateCollectionSheet @@ -6086,7 +6164,23 @@ Request Body:

Save Collection Sheet

This api allows the loan officer to perform bulk repayments of JLG loans for a group on its meeting date.

- + + + + + + + +
Mandatory Fields
calendarId, transactionDate, actualDisbursementDate
+
+ + + + + + + +
Optional Fields
clientsAttendance, bulkRepaymentTransaction, bulkDisbursementTransactions
POST https://Domain Name/api/v1/groups/{groupId}?command=saveCollectionSheet @@ -6128,6 +6222,14 @@ Request Body:

Unassign a Staff

Allows you to unassign the Staff.

+ + + + + + + +
Mandatory Fields
staffId
POST https://Domain Name/api/v1/groups/{groupId}?command=unassignStaff @@ -6229,6 +6331,14 @@ Request Body:

Assign a Role

Allows you to assign a Role to an existing member of a group.

We can define the different roles applicable to group members by adding code values to the pre-defined system code GROUPROLE. Example:Group leader etc.

+ + + + + + + +
Mandatory Fields
clientId, role
POST https://Domain Name/api/v1/groups/{groupId}?command=assignRole @@ -6278,6 +6388,14 @@ Request Body:

Update a Role

Allows you to update the member Role.

+ + + + + + + +
Mandatory Fields
role
POST https://Domain Name/api/v1/groups/{groupId}?command=updateRole&roleId=2