From f9e001f16b32d6950662c18bc80e120446df9156 Mon Sep 17 00:00:00 2001 From: Vishwas Babu A J Date: Tue, 20 Aug 2013 18:57:28 +0530 Subject: [PATCH] initial documentation stub for client transfers between groups --- api-docs/apiLive.htm | 120 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 45ad5dfe8..62b1bf2bb 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -575,6 +575,14 @@ + + + groups/{groupId}?command=transferClients + Transfer Clients + + + + @@ -3782,6 +3790,118 @@ Request Body: + +   +
+
+

Associate Clients

+

This API allows to associate existing clients to a group.

+

The clients are listed from the office to which the group is associated.

+

If client(s) is already associated with group then API will result in an error.

+
+ +
+ POST https://Domain Name/api/v1/groups/{groupId}?command=associateClients + POST groups/1?command=associateClients +Content-Type: application/json +Request Body: +{ + "clientMembers":[1,2] +} + + +{ + "officeId": 1, + "groupId": 1, + "resourceId": 1, + "clientMembers": [1,2] +} + +
+
+   +
+
+

Transfer Clients across groups

+

This API allows to transfer clients from one group to another

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Descriptions
destinationGroupId
The identifier of the group to which the clients are to be transferred.
clients
Identifiers of all clients who need to be transferred +
inheritDestinationGroupLoanOfficer
Flag specifies if the transferred clients (and all their active loans) + should be linked to the assigned loan officer for the group +
transferActiveLoans
Flag specifies if transfers should proceed when active loans are encountered. + If set to true, the schedules of the actives loans are updated to match that meeting schedule + of the destination Group +
+
+ + + + + + + +
Mandatory Fields
destinationGroupId, clients
+
+ + + + + + + +
Optional Fields
inheritDestinationGroupLoanOfficer (defaults to true), transferActiveLoans (defaults to true)
+ + +
+ + +
+ + POST https://Domain Name/api/v1/groups/{groupId}?command=transferClients + POST groups/1?command=transferClients +Content-Type: application/json +Request Body: +{ + destinationGroupId:2, + clients:[{id:1}] +} + + +{ + "resourceId": 1 +} + + + +
+