Filter the input
post
/service/v1/filterValues
This endpoint is used to get the best possible result for the given category as per the applicable filter criteria.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
Application Id
-
branchCode(required): string
Branch Code
-
userId(required): string
User Id
Request of the API with attribute values for different filter criteria
Root Schema : ScfFilterInput
Type:
object
Represents the input request of the final filter service call from transaction services
Show Source
-
applicationCode:
string
Application Code
-
category:
string
Represents the category of the filter
-
eventCode:
string
Represents the eventCode of the filter
-
filterRecords:
array filterRecords
Nested Schema : filterRecords
Type:
Show Source
array
-
Array of:
object ScfFilterRecords
Represents the records filtered in calling service using filter query
Nested Schema : ScfFilterRecords
Type:
object
Represents the records filtered in calling service using filter query
Show Source
Nested Schema : attributeList
Type:
Show Source
array
-
Array of:
object ScfAttribute
Represents each attribute of the records filtered in calling service using filter query
Nested Schema : ScfAttribute
Type:
object
Represents each attribute of the records filtered in calling service using filter query
Show Source
-
attributeName:
string
Name of the attribute representing DB column name
-
attributeValue:
string
Value of the corresponding column in DB
Response
Supported Media Types
- application/json
- application/xml
200 Response
Best possible record from the filtered records
Root Schema : ScfFilterOutput
Type:
object
Represents the best possible combination for the given category
Show Source
Nested Schema : attributeList
Type:
Show Source
array
-
Array of:
object ScfAttribute
Represents each attribute of the records filtered in calling service using filter query
Nested Schema : ScfAttribute
Type:
object
Represents each attribute of the records filtered in calling service using filter query
Show Source
-
attributeName:
string
Name of the attribute representing DB column name
-
attributeValue:
string
Value of the corresponding column in DB
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error