Jump to

• Request
• Response

Filter 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: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Body ()

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(optional): string
  Application Code
• category(optional): string
  Represents the category of the filter
• eventCode(optional): string
  Represents the eventCode of the filter
• filterRecords(optional): array filterRecords

{
    "description":"Represents the input request of the final filter service call from transaction services",
    "type":"object",
    "properties":{
        "applicationCode":{
            "description":"Application Code",
            "type":"string"
        },
        "category":{
            "description":"Represents the category of the filter",
            "type":"string"
        },
        "eventCode":{
            "description":"Represents the eventCode of the filter",
            "type":"string"
        },
        "filterRecords":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfFilterRecords"
            }
        }
    }
}

Nested Schema : filterRecords

Type: array

Show Source

• Array of: object ScfFilterRecords
  Represents the records filtered in calling service using filter query

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfFilterRecords"
    }
}

Nested Schema : ScfFilterRecords

Type: object

Represents the records filtered in calling service using filter query

Show Source

• attributeList(optional): array attributeList

{
    "description":"Represents the records filtered in calling service using filter query",
    "type":"object",
    "properties":{
        "attributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfAttribute"
            }
        }
    }
}

Nested Schema : attributeList

Type: array

Show Source

• Array of: object ScfAttribute
  Represents each attribute of the records filtered in calling service using filter query

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfAttribute"
    }
}

Nested Schema : ScfAttribute

Type: object

Represents each attribute of the records filtered in calling service using filter query

Show Source

• attributeName(optional): string
  Name of the attribute representing DB column name
• attributeValue(optional): string
  Value of the corresponding column in DB

{
    "description":"Represents each attribute of the records filtered in calling service using filter query",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"Name of the attribute representing DB column name",
            "type":"string"
        },
        "attributeValue":{
            "description":"Value of the corresponding column in DB",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Best possible record from the filtered records

Body ()

Root Schema : ScfFilterOutput

Type: object

Represents the best possible combination for the given category

Show Source

• attributeList(optional): array attributeList

{
    "description":"Represents the best possible combination for the given category",
    "type":"object",
    "properties":{
        "attributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfAttribute"
            }
        }
    }
}

Nested Schema : attributeList

Type: array

Show Source

• Array of: object ScfAttribute
  Represents each attribute of the records filtered in calling service using filter query

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfAttribute"
    }
}

Nested Schema : ScfAttribute

Type: object

Represents each attribute of the records filtered in calling service using filter query

Show Source

• attributeName(optional): string
  Name of the attribute representing DB column name
• attributeValue(optional): string
  Value of the corresponding column in DB

{
    "description":"Represents each attribute of the records filtered in calling service using filter query",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"Name of the attribute representing DB column name",
            "type":"string"
        },
        "attributeValue":{
            "description":"Value of the corresponding column in DB",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top