From commits-return-10248-archive-asf-public=cust-asf.ponee.io@fineract.apache.org Sat Jun 13 15:22:00 2020 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 9A87218064C for ; Sat, 13 Jun 2020 17:22:00 +0200 (CEST) Received: (qmail 86335 invoked by uid 500); 13 Jun 2020 15:22:00 -0000 Mailing-List: contact commits-help@fineract.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@fineract.apache.org Delivered-To: mailing list commits@fineract.apache.org Received: (qmail 86326 invoked by uid 99); 13 Jun 2020 15:21:59 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 13 Jun 2020 15:21:59 +0000 From: =?utf-8?q?GitBox?= To: commits@fineract.apache.org Subject: =?utf-8?q?=5BGitHub=5D_=5Bfineract=5D_nikpawar89_commented_on_a_change_in_pu?= =?utf-8?q?ll_request_=231051=3A_gsim=5Fglim=5Fdocumentation_?= Message-ID: <159206171979.8807.12899144626037315064.asfpy@gitbox.apache.org> Date: Sat, 13 Jun 2020 15:21:59 -0000 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit In-Reply-To: References: nikpawar89 commented on a change in pull request #1051: URL: https://github.com/apache/fineract/pull/1051#discussion_r439746770 ########## File path: fineract-provider/src/main/resources/static/api-docs/apiLive.htm ########## @@ -9438,170 +9585,1409 @@

Retrieve Group accounts overview

} ] } - - - - + + + + + +   +
+
+

Update a Group

+
+
+ +PUT https://DomainName/fineract-provider/api/v1/groups/{groupid} + + +PUT groups/1 +Content-Type: application/json +Request Body: +{ + "name": "First Group (changed)" +} + + +{ + "officeId": 1, + "groupId": 1, + "resourceId": 1, + "changes": { + "name": "First Group (changed)" + } +} + +
+
+ +   +
+
+

Delete a Group

+

A group can be deleted if it is in pending state and has no associations - clients, loans or savings

+
+
+ +POST https://DomainName/fineract-provider/api/v1/groups/{groupid} + + +DELETE groups/2 + + +{ + "officeId": 1, + "groupId": 2, + "resourceId": 2 +} + +
+
+ +   +
+
+

List Groups

+

The default implementation of listing Groups returns 200 entries with support for pagination and sorting. Using the parameter limit with value -1 returns all entries.

+
Optional Arguments
+
+
paged
+
+ Boolean optional, defaults to false +
+
If paged is true then results will be paginated.
+
offset
+
+ Integer optional, defaults to 0 +
+
Indicates from what result to start from.
+ +
limit
+
+ Integer optional, defaults to 200 +
+
Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1
+ +
orderBy
+
+ String optional, one of displayName, accountNo, officeId, officeName +
+
Orders the results by the field indicated.
+ +
sortBy
+
+ String optional, one of ASC, DESC +
+
Indicates what way to order results if orderBy is used.
+ +
officeId
+
+ Integer optional +
+
Provides ability to restrict list of groups returned based on the office there associated with.
+
underHierarchy
+
+ String optional +
+
Use the office hierarchy string to return all groups under a given hierarchy.
+ +
name
+
+ String optional +
+
Use name of groups to restrict results.
+ +
externalId
+
+ String optional +
+
Use externalId of groups to restrict results.
+ +
sqlSearch
+
+ String optional +
+
Use an sql fragment valid for the underlying group schema to filter results. e.g. display_name like %K%
+
orphansOnly
+
+ Boolean optional, defaults to false +
+
Use orphansOnly as true to list groups which are not associated to any center/parent.
+
+

Example Requests:

+
groups
+
+
groups?fields=name,officeName,joinedDate
+
+
groups?offset=10&limit=50
+
+
groups?orderBy=name&sortOrder=DESC
+
+
+ +GET https://DomainName/fineract-provider/api/v1/groups?paged=true + + +{ + "totalFilteredRecords": 2, + "pageItems": [ + { + "id": 4, + "name": "AnotherGroup", + "status": { + "id": 100, + "code": "clientStatusType.pending", + "value": "Pending" + }, + "active": false, + "officeId": 1, + "officeName": "Head Office", + "hierarchy": ".4." + } + ] +} + +
+
+ + + +   +
+
+

Retrieve a GSIM Application

+

Associations: String optional + One of, or comma separated of GSIM Applications or all for all associations +

+ +
+
+ +GET https://DomainName/fineract-provider/api/v1/groups/{groupId}/gsimaccounts + + + + +[{ Review comment: check the formatting of other apis and align it accordingly. you may also use this tool for formatting the JSON body: https://jsonformatter.curiousconcept.com/ ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: users@infra.apache.org