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

updated holidays api doc

Browse Source
This commit is contained in:
ashok-conflux
2013-11-22 15:31:04 +05:30
parent f4cb8101e8
commit 32a7323cbb
3 changed files with 146 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-docs/apiLive.htm
+138 -2
View File
@@ -918,6 +918,22 @@
<td></td> <td></td>
<td></td> <td></td>
</tr> </tr>
<tr class="alt">
<td></td>
<td>holidays/{holidayId}</td>
<td></td>
<td><a href="#holidays_retrieve">Retrieve a Holiday</a></td>
<td><a href="#holidays_update">Update a Holiday</a></td>
<td><a href="#holidays_delete">Delete a Holiday</a></td>
</tr>
<tr class="alt">
<td></td>
<td>holidays/{holidayId}?command=activate</td>
<td><a href="#holidays_activate">Activate a Holiday</a></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <tr>
<td><a href="#workingdays">Working days</a></td> <td><a href="#workingdays">Working days</a></td>
<td></td> <td></td>
@@ -9187,7 +9203,7 @@ GET https://DomainName/api/v1/holidays?officeId=1
</div> </div>
</div> </div>
<a id="holidays_create" name="offices_create" class="old-syle-anchor">&nbsp;</a> <a id="holidays_create" name="holiday_create" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Create a Holiday</h4> <h4>Create a Holiday</h4>
@@ -9196,7 +9212,7 @@ GET https://DomainName/api/v1/holidays?officeId=1
<td><div class="mifosXHeading2">Mandatory Fields</div></td> <td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr> </tr>
<tr class=alt> <tr class=alt>
<td>name, fromDate, toDate, repaymentsRescheduledTo, offices</td> <td>name, description, fromDate, toDate, repaymentsRescheduledTo, offices</td>
</tr> </tr>
</table> </table>
</div> </div>
@@ -9210,6 +9226,7 @@ Content-Type: application/json
Request Body: Request Body:
{ {
"name": "Good Friday", "name": "Good Friday",
"description": "Good Friday",
"dateFormat": "dd MMMM yyyy", "dateFormat": "dd MMMM yyyy",
"locale": "en", "locale": "en",
"fromDate": "25 October 2013", "fromDate": "25 October 2013",
@@ -9224,6 +9241,125 @@ Request Body:
<code class="method-response"> <code class="method-response">
{ {
"resourceId": 1 "resourceId": 1
}
</code>
</div>
</div>
<a id="holidays_activate" name="holidays_activate" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Activate a Holiday</h4>
<p>Always Holidays are created in pending state. This API allows to activate a holiday.</p>
<p>Only the active holidays are considered for rescheduling the loan repayment.</p>
</div>
<div class="method-example">
<code class="method-declaration">
POST https://DomainName/api/v1/holidays/{holidayId}?command=activate
</code>
<code class="method-request">
POST holidays
Content-Type: application/json
Request Body:
{
}
</code>
<code class="method-response">
{
"resourceId": 1
}
</code>
</div>
</div>
<a id="holidays_retrieve" name="holidays_retrieve"
class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Retrieve a Holiday</h4>
<p>Example Requests:</p>
<div class=apiClick>holidays/1</div>
<br>
</div>
<div class="method-example">
<code class="method-declaration">
GET https://DomainName/api/v1/holidays/{holidayId}
</code>
<code class="method-response">
{
"id": 1,
"name": "Good Friday",
"fromDate": [
2013,
10,
25
],
"toDate": [
2013,
10,
25
],
"repaymentsRescheduledTo": [
2013,
10,
26
]
}
</code>
</div>
</div>
<a id="holidays_update" name="holidays_update" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Update a Holiday</h4>
<p>If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.</p>
</div>
<div class="method-example">
<code class="method-declaration">
PUT https://DomainName/api/v1/holidays/{holidayId}
</code>
<code class="method-request">
PUT holidays/1
Content-Type: application/json
Request Body:
{
name:"Independence day",
description: "Holiday for Independence day celebration"
}
</code>
<code class="method-response">
{
"resourceId": 1,
"changes": {
"name": "Independence day",
"description": "Holiday for Independence day celebration"
}
}
</code>
</div>
</div>
<a id="holidays_delete" name="holidays_delete" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Delete a Holiday</h4>
<p>This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.</p>
</div>
<div class="method-example">
<code class="method-declaration">
DELETE https://DomainName/api/v1/holidays/{holidayId}
</code>
<code class="method-request">
DELETE holidays/1
Content-Type: application/json
Request Body:
{
}
</code>
<code class="method-response">
{
"resourceId": 1
} }
</code> </code>
</div> </div>
mifosng-provider/src/main/java/org/mifosplatform/organisation/holiday/data/HolidayData.java
+4 -1
View File
@@ -9,6 +9,8 @@ public class HolidayData {
@SuppressWarnings("unused") @SuppressWarnings("unused")
private final String name; private final String name;
@SuppressWarnings("unused") @SuppressWarnings("unused")
private final String description;
@SuppressWarnings("unused")
private final LocalDate fromDate; private final LocalDate fromDate;
@SuppressWarnings("unused") @SuppressWarnings("unused")
private final LocalDate toDate; private final LocalDate toDate;
@@ -17,10 +19,11 @@ public class HolidayData {
@SuppressWarnings("unused") @SuppressWarnings("unused")
private final Long officeId; private final Long officeId;
public HolidayData(final Long id, final String name, final LocalDate fromDate, final LocalDate toDate, public HolidayData(final Long id, final String name, final String description, final LocalDate fromDate, final LocalDate toDate,
final LocalDate repaymentsRescheduledTo) { final LocalDate repaymentsRescheduledTo) {
this.id = id; this.id = id;
this.name = name; this.name = name;
this.description = description;
this.fromDate = fromDate; this.fromDate = fromDate;
this.toDate = toDate; this.toDate = toDate;
this.repaymentsRescheduledTo = repaymentsRescheduledTo; this.repaymentsRescheduledTo = repaymentsRescheduledTo;
mifosng-provider/src/main/java/org/mifosplatform/organisation/holiday/service/HolidayReadPlatformServiceImpl.java
+4 -3
View File
@@ -38,7 +38,7 @@ public class HolidayReadPlatformServiceImpl implements HolidayReadPlatformServic
public HolidayMapper() { public HolidayMapper() {
final StringBuilder sqlBuilder = new StringBuilder(200); final StringBuilder sqlBuilder = new StringBuilder(200);
sqlBuilder.append("h.id as id, h.name as name, h.from_date as fromDate, h.to_date as toDate, "); sqlBuilder.append("h.id as id, h.name as name, h.description as description, h.from_date as fromDate, h.to_date as toDate, ");
sqlBuilder.append("h.repayments_rescheduled_to as repaymentsScheduleTO "); sqlBuilder.append("h.repayments_rescheduled_to as repaymentsScheduleTO ");
sqlBuilder.append("from m_holiday h "); sqlBuilder.append("from m_holiday h ");
this.schema = sqlBuilder.toString(); this.schema = sqlBuilder.toString();
@@ -52,11 +52,12 @@ public class HolidayReadPlatformServiceImpl implements HolidayReadPlatformServic
public HolidayData mapRow(final ResultSet rs, @SuppressWarnings("unused") final int rowNum) throws SQLException { public HolidayData mapRow(final ResultSet rs, @SuppressWarnings("unused") final int rowNum) throws SQLException {
final Long id = rs.getLong("id"); final Long id = rs.getLong("id");
final String name = rs.getString("name"); final String name = rs.getString("name");
final String description = rs.getString("description");
final LocalDate fromDate = JdbcSupport.getLocalDate(rs, "fromDate"); final LocalDate fromDate = JdbcSupport.getLocalDate(rs, "fromDate");
final LocalDate toDate = JdbcSupport.getLocalDate(rs, "toDate"); final LocalDate toDate = JdbcSupport.getLocalDate(rs, "toDate");
final LocalDate repaymentsScheduleTO = JdbcSupport.getLocalDate(rs, "repaymentsScheduleTO"); final LocalDate repaymentsScheduleTO = JdbcSupport.getLocalDate(rs, "repaymentsScheduleTO");
return new HolidayData(id, name, fromDate, toDate, repaymentsScheduleTO); return new HolidayData(id, name, description, fromDate, toDate, repaymentsScheduleTO);
} }
} }
@@ -104,7 +105,7 @@ public class HolidayReadPlatformServiceImpl implements HolidayReadPlatformServic
try { try {
final HolidayMapper rm = new HolidayMapper(); final HolidayMapper rm = new HolidayMapper();
final String sql = rm.schema() + " where h.id = ?"; final String sql = " select " + rm.schema() + " where h.id = ?";
return this.jdbcTemplate.queryForObject(sql, rm, new Object[] { holidayId }); return this.jdbcTemplate.queryForObject(sql, rm, new Object[] { holidayId });
} catch (final EmptyResultDataAccessException e) { } catch (final EmptyResultDataAccessException e) {