Update users api docs with staff details

This commit is contained in:
Madhukar
2014-05-10 13:39:33 +05:30
parent 7ff989dbe0
commit 0a9de45ced
+34 -1
View File
@@ -26154,6 +26154,17 @@ GET https://DomainName/api/v1/users
"firstname": "App",
"lastname": "Administrator",
"email": "demomfi@mifos.org",
"staff": {
"id": 1,
"firstname": "Test",
"lastname": "123",
"displayName": "123, Test",
"mobileNo": "12312312",
"officeId": 1,
"officeName": "Head Office",
"isLoanOfficer": true,
"isActive": true
}
"selectedRoles": [
{
"id": 1,
@@ -26234,6 +26245,17 @@ GET https://DomainName/api/v1/users/{userId}
"firstname": "App",
"lastname": "Administrator",
"email": "demomfi@mifos.org",
"staff": {
"id": 1,
"firstname": "Test",
"lastname": "123",
"displayName": "123, Test",
"mobileNo": "12312312",
"officeId": 1,
"officeName": "Head Office",
"isLoanOfficer": true,
"isActive": true
}
"availableRoles": [],
"selectedRoles": [
{
@@ -26262,10 +26284,19 @@ GET https://DomainName/api/v1/users/{userId}
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr>
<tr class=alt>
<tr>
<td>username, firstname, lastname, email, officeId, roles, sendPasswordToEmail</td>
</tr>
</table>
<br>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Optional Fields</div></td>
</tr>
<tr>
<td>staffId</td>
</tr>
</table>
</div>
<div class="method-example">
<code class="method-declaration">
@@ -26281,6 +26312,7 @@ Request body:
"lastname": "User",
"email": "whatever@mifos.org",
"officeId": 1,
"staffId": 1,
"roles": [2,3],
"sendPasswordToEmail": true
}
@@ -26301,6 +26333,7 @@ Request body:
"lastname": "User",
"email": "whatever@mifos.org",
"officeId": 1,
"staffId": 1,
"roles": [2,3],
"sendPasswordToEmail": false,
"password": "123",