Jump to

• Request
• Response

Retrieve the list of Drawdown Notices

get

/syndicationapplication-services/service/api/v1/syndicationapplications/drawdownnotice

This operation retrieves the list of Drawdown Notices using Syndication Application Service.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• applicationNumber(optional): string
  applicationNumber of the user that needs to be fetched
• drawdownInitiated(optional): boolean
  drawdownInitiated flag that to fetch the data.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the List of Drawdown Notices.

Body ()

Root Schema : ResponseCollectionModel

Type: object

Response collectionModel

Show Source

• responseCodes(optional): array responseCodes
  Schedule Details

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

Nested Schema : responseCodes

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(optional): string
  Code
• desc(optional): string
  Description
• error(optional): string
  Error
• info(optional): string
  Info
• language(optional): string
  Language
• override(optional): string
  Override
• type(optional): 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.

405 Response

Invalid input

500 Response

Internal error

Back to Top