Jump to

• Request
• Response

Query a Product Contract Schedule Components through a Backoffice Service

get

/backoffice-services/backoffice/loans/query/schedulecomponents/{productCode}

This operation queries the list of product contract schedule components through a Backoffice Service.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• productCode(required): string
  productCode as path param

Query Parameters

• scheduleType: string
  scheduleType as query param

Header Parameters

• branchCode(required): string
  branch code from headers

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ScheduleComponentsListDtoWrapper

Type: object

Product Schedule Components List Dto Wrapper

Show Source

• data: array data
• messages: object ResponseDto
  ResponseDto model

{
    "description":"Product Schedule Components List Dto Wrapper",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScheduleDetails"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ScheduleDetails
  ScheduleDetails Model

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

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes: string
  Codes
• httpStatusCode: array httpStatusCode
  Schedule Details
• keyId: string
  KeyId
• overrideAuthLevelsReqd: string
  OverrideAuthLevelsReqd
• requestId: string
  RequestId
• status: string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ScheduleDetails

Type: object

ScheduleDetails Model

Show Source

• amount: string
  Amount
• componentCurrency: string
  ComponentCurrency
• componentName: string
  ComponentName
• frequency: number
  Frequency
• noOfSchedules: number
  NoOfSchedules
• resetTenor: string
  ResetTenor
• scheduleType: string
  ScheduleType
• startDate: string
  StartDate
• unit: string
  Unit

{
    "description":"ScheduleDetails Model",
    "type":"object",
    "properties":{
        "amount":{
            "description":"Amount",
            "type":"string"
        },
        "scheduleType":{
            "description":"ScheduleType",
            "type":"string"
        },
        "startDate":{
            "description":"StartDate",
            "type":"string"
        },
        "unit":{
            "description":"Unit",
            "type":"string"
        },
        "componentName":{
            "description":"ComponentName",
            "type":"string"
        },
        "resetTenor":{
            "description":"ResetTenor",
            "type":"string"
        },
        "componentCurrency":{
            "description":"ComponentCurrency",
            "type":"string"
        },
        "noOfSchedules":{
            "description":"NoOfSchedules",
            "type":"number"
        },
        "frequency":{
            "description":"Frequency",
            "type":"number"
        }
    }
}

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code: string
  Code
• desc: string
  Description
• error: string
  Error
• info: string
  Info
• language: string
  Language
• override: string
  Override
• type: string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "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