diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 147b266a9..e927d44fb 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -3499,8 +3499,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
DELETE https://Domain
- Name/api/v1/datatables/{datatable}/{apptableId}
+
+DELETE https://DomainName/api/v1/datatables/{datatable}/{apptableId}
+
DELETE datatables/Additional
Client Fields Data/1 Content-Type: application/json Request Body:
{ }
@@ -3517,8 +3518,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
one to many with the application table.
DELETE https://Domain
- Name/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
+
+DELETE https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
+
DELETE datatables/Extra Family
Details Data/1/2 Content-Type: application/json Request Body: { }
@@ -3574,8 +3576,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
GET https://Domain
- Name/api/v1/reports
+
+GET https://DomainName/api/v1/reports
+
{ "columnHeaders" : [ {
"columnName" : "report_id", "columnType" : "INT", "columnLength" :
null, "columnDisplayType" : null, "columnValues" : [ ] }, {
@@ -3696,8 +3699,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
(Pentaho)?output-type=PDF&R_officeId=1GET https://Domain
- Name/api/v1/reports/{reportName}
+
+GET https://DomainName/api/v1/reports/{reportName}
+
{ "columnHeaders" : [ {
"columnName" : "Office/Branch", "columnType" : "VARCHAR",
"columnLength" : null, "columnDisplayType" : null, "columnValues"
@@ -3770,8 +3774,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
of permissions allowed.
POST https://Domain
- Name/api/v1/authentication?username={username}&password={password}
+
+POST https://DomainName/api/v1/authentication?username={username}&password={password}
+
POST
authentication?username=mifos&password=password Content-Type:
application/json No Request Body
@@ -3814,8 +3819,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
GET https://Domain
- Name/api/v1/users
+
+GET https://DomainName/api/v1/users
+
[ { "id" : 6, "officeId" : 1,
"officeName" : "change super user", "username" : "committee1",
"firstname" : "Committee", "lastname" : "Member", "email" :
@@ -3843,8 +3849,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
users/template
GET https://Domain
- Name/api/v1/users/template
+
+GET https://DomainName/api/v1/users/template
+
{ "allowedOffices": [ { "id":
1, "name": "Head Office", "nameDecorated": "Head Office" }, {
"id": 10, "name": "Myanmar Regional Office", "nameDecorated":
@@ -3874,8 +3881,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
users/1?fields=username,officeName
GET https://Domain
- Name/api/v1/users/1
+
+GET https://DomainName/api/v1/users/{userId}
+
{ "id": 1, "username":
"mifos", "officeId": 1, "officeName": "Head Office", "firstname":
"App(test)", "lastname": "Administrator", "email":
@@ -3912,8 +3920,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
POST https://Domain
- Name/api/v1/users
+
+POST https://DomainName/api/v1/users
+
POST users Content-Type:
application/json Request body: { "username": "Another New User
zll", "firstname": "Test", "lastname": "User", "email":
@@ -3933,8 +3942,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
PUT https://Domain
- Name/api/v1/users/{userId)
+
+PUT https://DomainName/api/v1/users/{userId)
+
PUT users/3 Content-Type:
application/json Request body: { "firstname": "Test", "password":
"window75", "repeatPassword": "window75" }
@@ -3953,8 +3963,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
Removes the user and the associated roles and permissions.
DELETE https://Domain
- Name/api/v1/users/{userId}
+
+DELETE https://DomainName/api/v1/users/{userId}
+
DELETE users/20 Content-Type:
application/json No Request Body
{ "officeId": 1, "resourceId":
@@ -3985,8 +3996,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
roles?fields=name
GET https://Domain
- Name/api/v1/roles
+
+GET https://DomainName/api/v1/roles
+
[ { "id" : 1, "name" : "Super
user", "description" : "This role provides all application
permissions." }, { "id" : 2, "name" : "Field officer",
@@ -4014,8 +4026,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
roles/1?fields=name
GET https://Domain
- Name/api/v1/roles/{roleId}
+
+GET https://DomainName/api/v1/roles/{roleId}
+
{ "id" : 1, "name" : "Super
user", "description" : "This role provides all application
permissions." }
@@ -4036,8 +4049,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
POST https://Domain
- Name/api/v1/roles
+
+POST https://DomainName/api/v1/roles
+
POST roles Content-Type:
application/json Request body: { "name": "Another Role Name",
"description": "A description outlining the purpose of this role
@@ -4052,8 +4066,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
Update a Role
PUT https://Domain
- Name/api/v1/roles/{roleId}
+
+PUT https://DomainName/api/v1/roles/{roleId}
+
PUT roles/8 Content-Type:
application/json Request body: { "description": "some
description(changed)" }
@@ -4071,8 +4086,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
GET https://Domain
- Name/api/v1/roles/{roleId}/permissions
+
+GET https://DomainName/api/v1/roles/{roleId}/permissions
+
{ "id": 1, "name": "Super
user", "description": "This role provides all application
permissions.", "permissionUsageData": [ { "grouping":
@@ -4092,8 +4108,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
Update a Role's Permissions
PUT https://Domain
- Name/api/v1/roles/{roleId}/permissions
+
+PUT https://DomainName/api/v1/roles/{roleId}/permissions
+
PUT roles/8 Content-Type:
application/json Request body: { "permissions":
{"ALL_FUNCTIONS_READ": "true"} }
@@ -4124,8 +4141,9 @@ PUT https://DomainName/api/v1/datatables/{datatable}/{apptableId}/{datatableId}
GET https://Domain
- Name/api/v1/permissions
+
+GET https://DomainName/api/v1/permissions
+
[ { "grouping":
"authorisation", "code": "READ_PERMISSION", "entityName":
"PERMISSION", "actionName": "READ", "selected": true }, {