Jump to

• Request
• Response

Retrieves scf Application Parameters

get

/service/v1/appParams

This endpoint is used to get the scf Application Parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• key(optional): string
  Key of the parameter that needs to be fetched

Header Parameters

• appId: string
  App ID
• branchCode: string
  Branch Code
• userId: string
  User ID

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ScfApplicationParamModelCollection

Type: object

Collection of ScfApplicationParamModelKeyCollection.

Show Source

• ScfApplicationParamModelKeyCollection(optional): array ScfApplicationParamModelKeyCollection

{
    "description":"Collection of ScfApplicationParamModelKeyCollection.",
    "type":"object",
    "properties":{
        "ScfApplicationParamModelKeyCollection":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfApplicationParamModelKeyCollection"
            }
        }
    }
}

Nested Schema : ScfApplicationParamModelKeyCollection

Type: array

Show Source

• Array of: object ScfApplicationParamModelKeyCollection
  Collection of list of Parameters.

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

Nested Schema : ScfApplicationParamModelKeyCollection

Type: object

Collection of list of Parameters.

Show Source

• key(optional): string
  key of the Param
• ScfApplicationParamKeyModel(optional): array ScfApplicationParamKeyModel

{
    "description":"Collection of list of Parameters.",
    "type":"object",
    "properties":{
        "key":{
            "description":"key of the Param",
            "type":"string"
        },
        "ScfApplicationParamKeyModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfApplicationParamKeyModel"
            }
        }
    }
}

Nested Schema : ScfApplicationParamKeyModel

Type: array

Show Source

• Array of: object ScfApplicationParamKeyModel
  Scf Application Param model

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

Nested Schema : ScfApplicationParamKeyModel

Type: object

Scf Application Param model

Show Source

• code(optional): string
  Code for the Param.This is a unique constraint
• description(optional): string
  Configured value for the disbursement mode which will be used in rest of application.

{
    "description":"Scf Application Param model",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code for the Param.This is a unique constraint",
            "type":"string"
        },
        "description":{
            "description":"Configured value for the disbursement mode which will be used in rest of application.",
            "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