CBSNexora/cbsnexora-backend
4
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

MIFOSX-1701 Add option to display only active group members

Browse Source 
Complete documentation for the retrieving group call
This commit is contained in:
Alex Ivanov
2014-12-15 21:59:57 +02:00
parent 6e07b83075
commit 312f016a56
4 changed files with 86 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-docs/apiLive.htm
+45 -22
View File
@@ -6300,19 +6300,42 @@ Request Body:
<a id="groups_retrieve" name="groups_retrieve" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Retrieve a Group</h4>
<p>Example Requests:</p>
<div class=apiClick>groups/1</div>
<br/>
<div class=apiClick>groups/1?associations=clientMembers</div>
</div>
<div class="method-example">
<p>Group without details of Client associations.</p>
<code class="method-declaration">
<div class="method-description">
<h4>Retrieve a Group</h4>
<p>Retrieve group information.</p>
<dl class="argument-list">
<dt>associations</dt>
<dd>
String <span>optional</span>
</dd>
<dd>
One of, or comma separated of <span>clientMembers, activeClientMembers, groupRoles, calendars, collectionMeetingCalendar</span>
<br>
or <span>all</span> for all associations.
</dd>
<dt>staffInSelectedOfficeOnly</dt>
<dd>
Boolean <span>optional</span>, defaults to false
</dd>
<dd>If <strong>staffInSelectedOfficeOnly=true</strong> only staff
who are associated with the selected branch are returned.</dd>
<dt>roleId</dt>
<dd>
Long <span>optional</span>
</dd>
<dd>If present, will retrieve group role information</dd>
</dl>
<p>Example Requests:</p>
<div class=apiClick>groups/1</div>
<br/>
<div class=apiClick>groups/1?associations=clientMembers</div>
</div>
<div class="method-example">
<p>Group without any associations.</p>
<code class="method-declaration">
GET https://DomainName/mifosng-provider/api/v1/groups/1
</code>
<code class="method-response">
</code>
<code class="method-response">
{
"id": 1,
"name": "First Group",
@@ -6331,14 +6354,14 @@ GET https://DomainName/mifosng-provider/api/v1/groups/1
"activatedByLastname": "Administrator"
}
}
</code>
</div>
<div class="method-example">
<p>Group along with all its Clients.</p>
<code class="method-declaration">
</code>
</div>
<div class="method-example">
<p>Group along with all its Clients.</p>
<code class="method-declaration">
GET https://DomainName/mifosng-provider/api/v1/groups/1?associations=clientMembers
</code>
<code class="method-response">
</code>
<code class="method-response">
{
"id": 1,
"name": "First Group",
@@ -6374,9 +6397,9 @@ GET https://DomainName/mifosng-provider/api/v1/groups/1?associations=clientMembe
}
]
}
</code>
</div>
</div>
</code>
</div>
</div>
<!--Start of Group account summary -->
<a id="groups_accounts" name="groups_accounts" class="old-syle-anchor">&nbsp;</a>