Jump to

• Request
• Response

Initiate an application

post

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

This operation initiates an application using Syndication Application Service.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new application

Root Schema : NLPApplicationDetailsModel

Type: object

NLPApplicationDetails model

Show Source

• applicationBranch: string
  applicationBranch
• applicationChannel: string
  ApplicationChannel
• applicationDate: string
  ApplicationDate
• applicationInitiationDate: string
  applicationInitiationDate
• applicationNumber: string
  Application Number
• businessProductCode: string
  businessProductCode
• docId: string
• docType: string
• facilities: array facilities
  Facility Details
• id: string(int64)
  Id
• keyvals: array keyvals
• lifeCycleCode: string
  LifeCycleCode
• priority: string
  Allowed Values: [ "HIGH", "MEDIUM", "LOW" ]

  TaskPriority
• processRefNumber: string
  process refeernce Number
• remarks: string
  Remarks
• text: string
• transactionHeader: object TransactionHeader
  TransactionHeader
• updatedBy: string
  Updated By

{
    "description":"NLPApplicationDetails model",
    "type":"object",
    "properties":{
        "id":{
            "description":"Id",
            "type":"string",
            "format":"int64"
        },
        "docId":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "docType":{
            "type":"string"
        },
        "keyvals":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MltbNerKeyValObjDTO"
            }
        },
        "applicationNumber":{
            "description":"Application Number",
            "type":"string"
        },
        "processRefNumber":{
            "description":"process refeernce Number",
            "type":"string"
        },
        "businessProductCode":{
            "description":"businessProductCode",
            "type":"string"
        },
        "lifeCycleCode":{
            "description":"LifeCycleCode",
            "type":"string"
        },
        "applicationChannel":{
            "description":"ApplicationChannel",
            "type":"string"
        },
        "applicationDate":{
            "description":"ApplicationDate",
            "type":"string"
        },
        "remarks":{
            "description":"Remarks",
            "type":"string"
        },
        "applicationInitiationDate":{
            "description":"applicationInitiationDate",
            "type":"string"
        },
        "applicationBranch":{
            "description":"applicationBranch",
            "type":"string"
        },
        "priority":{
            "description":"priority",
            "$ref":"#/definitions/TaskPriority"
        },
        "transactionHeader":{
            "$ref":"#/definitions/TransactionHeader"
        },
        "facilities":{
            "description":"Facility Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FacilitiesModel"
            }
        },
        "updatedBy":{
            "description":"Updated By",
            "type":"string"
        }
    }
}

Nested Schema : facilities

Type: array

Facility Details

Show Source

• Array of: object FacilitiesModel
  Facilities Model

{
    "description":"Facility Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FacilitiesModel"
    }
}

Nested Schema : keyvals

Type: array

Show Source

• Array of: object MltbNerKeyValObjDTO
  tagdetails

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

Nested Schema : TransactionHeader

Type: object

TransactionHeader

Show Source

• applicationNo: string
  ApplicationNo
• branchCode: string
  BranchCode
• currentStage: string
  CurrentStage
• currentStageDescription: string
  CurrentStageDescription
• currentUser: string
  CurrentUser
• key1: string
  Key1
• processDescription: string
  ProcessDescription
• processName: string
  ProcessName
• processRefNo: string
  ProcessRefNo
• taskId: string
  TaskId
• taskOutcome: string
  TaskOutcome
• taskOutcomes: array taskOutcomes
  TaskOutcomes
• taskPrioirty: string
  TaskPrioirty
• workflowId: string
  QorkflowId

{
    "description":"TransactionHeader",
    "type":"object",
    "properties":{
        "processRefNo":{
            "description":"ProcessRefNo",
            "type":"string"
        },
        "applicationNo":{
            "description":"ApplicationNo",
            "type":"string"
        },
        "currentUser":{
            "description":"CurrentUser",
            "type":"string"
        },
        "taskPrioirty":{
            "description":"TaskPrioirty",
            "type":"string"
        },
        "branchCode":{
            "description":"BranchCode",
            "type":"string"
        },
        "taskOutcome":{
            "description":"TaskOutcome",
            "type":"string"
        },
        "processName":{
            "description":"ProcessName",
            "type":"string"
        },
        "currentStage":{
            "description":"CurrentStage",
            "type":"string"
        },
        "currentStageDescription":{
            "description":"CurrentStageDescription",
            "type":"string"
        },
        "key1":{
            "description":"Key1",
            "type":"string"
        },
        "workflowId":{
            "description":"QorkflowId",
            "type":"string"
        },
        "taskId":{
            "description":"TaskId",
            "type":"string"
        },
        "taskOutcomes":{
            "description":"TaskOutcomes",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "processDescription":{
            "description":"ProcessDescription",
            "type":"string"
        }
    }
}

Nested Schema : FacilitiesModel

Type: object

Facilities Model

Show Source

• availableAmount: number
  Minimum Value: 0

  Available Amount
• facilityAmount: number
  Minimum Value: 0

  Facility Amount
• facilityCurrency: string
  Maximum Length: 4

  Facility Currency
• facilityName: string
  Maximum Length: 35

  Facility Name
• facilityRefNo: string
  Maximum Length: 16

  Facility Reference No
• tranches: array tranches
  Facility Tranches Details

{
    "description":"Facilities Model",
    "type":"object",
    "properties":{
        "facilityRefNo":{
            "description":"Facility Reference No",
            "type":"string",
            "maxLength":"16"
        },
        "facilityName":{
            "description":"Facility Name",
            "type":"string",
            "maxLength":"35"
        },
        "facilityCurrency":{
            "description":"Facility Currency",
            "type":"string",
            "maxLength":"4"
        },
        "facilityAmount":{
            "description":"Facility Amount",
            "type":"number",
            "minimum":"0"
        },
        "availableAmount":{
            "description":"Available Amount",
            "type":"number",
            "minimum":"0"
        },
        "tranches":{
            "description":"Facility Tranches Details",
            "type":"array",
            "items":{
                "$ref":"#/definitions/FacilityTranchesModel"
            }
        }
    }
}

Nested Schema : tranches

Type: array

Facility Tranches Details

Show Source

• Array of: object FacilityTranchesModel
  Facility Tranches Model

{
    "description":"Facility Tranches Details",
    "type":"array",
    "items":{
        "$ref":"#/definitions/FacilityTranchesModel"
    }
}

Nested Schema : FacilityTranchesModel

Type: object

Facility Tranches Model

Show Source

• availableAmount: number
  Minimum Value: 0

  Available Amount
• trancheAmount: number
  Minimum Value: 0

  Tranche Amount
• trancheCurrency: string
  Maximum Length: 4

  Tranche Currency
• trancheName: string
  Maximum Length: 35

  Tranche Name
• trancheRefNo: string
  Maximum Length: 16

  Tranche Reference No

{
    "description":"Facility Tranches Model",
    "type":"object",
    "properties":{
        "trancheRefNo":{
            "description":"Tranche Reference No",
            "type":"string",
            "maxLength":"16"
        },
        "trancheName":{
            "description":"Tranche Name",
            "type":"string",
            "maxLength":"35"
        },
        "trancheCurrency":{
            "description":"Tranche Currency",
            "type":"string",
            "maxLength":"4"
        },
        "trancheAmount":{
            "description":"Tranche Amount",
            "type":"number",
            "minimum":"0"
        },
        "availableAmount":{
            "description":"Available Amount",
            "type":"number",
            "minimum":"0"
        }
    }
}

Nested Schema : MltbNerKeyValObjDTO

Type: object

tagdetails

Show Source

• annotateTag: string
• displayLabel: string
• end_index: number
• start_index: number
• tagDfltVal: string
• tagDispSeq: number
• tagName: string
• value: string

{
    "description":"tagdetails",
    "type":"object",
    "properties":{
        "tagDispSeq":{
            "type":"number"
        },
        "displayLabel":{
            "type":"string"
        },
        "tagName":{
            "type":"string"
        },
        "annotateTag":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "start_index":{
            "type":"number"
        },
        "end_index":{
            "type":"number"
        },
        "tagDfltVal":{
            "type":"string"
        }
    }
}

Nested Schema : taskOutcomes

Type: array

TaskOutcomes

Show Source

• Array of: string

{
    "description":"TaskOutcomes",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the Id of the newly created NLP application

Headers

• Location: string
  URL of newly created NLP application

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: ResponseResourceSupport
• messages: object ResponseDto
  ResponseDto model

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Match All

Show Source

• object ResponseResourceSupport-allOf[0]
  Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

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 : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

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.

405 Response

Invalid input

500 Response

Internal error

Back to Top