From 18d02396b6e67033c699c8bd351f293dba48d946 Mon Sep 17 00:00:00 2001 From: ashok-conflux Date: Tue, 2 Apr 2013 19:07:29 +0530 Subject: [PATCH] MIFOSX-289 - update Search api doc --- api-docs/apiLive.htm | 139 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 137 insertions(+), 2 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 781539785..ca4b31fb5 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -902,6 +902,14 @@ + + SEARCH + search + + Search Resources + + + @@ -11826,10 +11834,129 @@ Content-Type: application/json - - + +   +
+
+

Search

+

Search API allows to search scoped resources clients, loans and groups on specified fields.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Scoped Resources
Scoped fields
ClientDisplay Name
Account Number
External Id
LoanAccount Number
Client IdentifiersDocument Key
GroupName
External Id
+
+
+   +
+
+

Search Resources

+

Example Requests:

+
search?query=000000001
+
+
search?query=Petra&resource=clients,groups
+
+ + + + + + + + + + + + + +
Parameters
Description
+ query +
(mandatory) + 		+ String which is searched on scoped resources +
+ resource +
(non-mandatory) + 		+ Scoped resources on which search can be performed. If there is no resource parameter passed then search will be performed on all scoped resources. +
+
+ + + + + + + + + + +
Order of Search results
+ List exact match results in following order +
    +
  1. 1. Clients
    2. +
  2. 2. Loans
    3. +
  3. 3. Client Identifiers
    4. +
  4. 4. Groups
    5. +
+
+ List partial match results in following order +
    +
  1. 1. Clients
    2. +
  2. 2. Loans
    3. +
  3. 3. Client Identifiers
    4. +
  4. 4. Groups
    5. +
+
+
+
+ +GET https://DomainName/api/v1/search?query=000000111 + + +[ + { + "entityId": 111, + "entityAccountNo": "000000111", + "entityName": "12-A Flat Loan", + "entityType": "LOAN", + "parentId": 65, + "parentName": "aaaa aaaaa" + } +] + +
+
+ @@ -12384,6 +12511,14 @@ Content-Type: application/json Update a Resource Note Delete a Resource Note + + SEARCH + search + + Search Resources + + + General Ledger Account glaccounts