From ae6d43fe67e5ced0b2e58046ff7391dbb178d433 Mon Sep 17 00:00:00 2001 From: Stoyan Zlatev Date: Mon, 19 Jun 2023 11:41:24 +0000 Subject: [PATCH] Update README.md --- .../LaaProductionWeb/Controllers/API/Search/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/LaaProductionWeb/LaaProductionWeb/Controllers/API/Search/README.md b/LaaProductionWeb/LaaProductionWeb/Controllers/API/Search/README.md index 3cb81efe..6562e7eb 100644 --- a/LaaProductionWeb/LaaProductionWeb/Controllers/API/Search/README.md +++ b/LaaProductionWeb/LaaProductionWeb/Controllers/API/Search/README.md @@ -4,15 +4,19 @@ Production API's 1. **Base address** - http://sla12iis01.emea.sensus.net/LaaProductionWeb 1. **Authentication & Authorization** - each user has his own set of roles and allowed functions to access within his employee account's. Authentication succeeds over username, password and software name. + 1. **POST: /api/personalization/login** - in order to authenticate particular user and obtain an authorization token use following parameters in the request body in json format: - **Username** - required string. Should match a username saved in the database. - **Password** - required hash string. Should match the password hash for the above entered username. - **Software** - required string. As software name use the assembly name that calls this API. - only if authentication succeeds you will receive in response a string (**{token}**) that should be used for further authorization else error message is received. + 1. **Authorization: Bearer {token}** - is the scheme to use within the authorization and furtherAPI calls. 1. **Wildcard search:** + 1. **GET: /api/search/wildcard** - returns a list of possible fields to return when searching. Default are all fields returned to the client. + 1. **POST: /api/search/wildcard** - returns a list of found results. Within the searching you should use following parameters in the request body in json format: - **Token** - search string. Requires from 3 up to 50 - letters, digits and or (" ", "-") charachters. - **Fields** - optional. List of fields to return.