Jump to

• Request
• Response

Upload Inbound Document

post

/obcr-correspondence-services/inboundDocument/upload

This endpoint is used to upload Inbound Document.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Body ()

Request Body that contains data about the documents to be uploaded

Root Schema : FileTransferDtoCollection

Type: object

Show Source

• fileDetailsDto: object FileDetailsDto
• fileTransferDtoList: array fileTransferDtoList

{
    "type":"object",
    "properties":{
        "fileTransferDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FileTransferDto"
            }
        },
        "fileDetailsDto":{
            "$ref":"#/definitions/FileDetailsDto"
        }
    }
}

Nested Schema : FileDetailsDto

Type: object

Show Source

• accountId(required): string
  Account ID associated with the document
• caseId: string
  Case ID associated with the document
• documentCategoryCd: string
  Category code of the document
• documentCategoryDesc: string
  Category description of the document
• documentNameCd: string
  Name code of the document
• documentNameDesc(required): string
  Name description of the document
• remarks: string
  remarks
• uploadDate: string
  Date on which document was uploaded

{
    "type":"object",
    "properties":{
        "documentCategoryCd":{
            "type":"string",
            "description":"Category code of the document"
        },
        "documentCategoryDesc":{
            "type":"string",
            "description":"Category description of the document"
        },
        "documentNameDesc":{
            "type":"string",
            "description":"Name description of the document"
        },
        "documentNameCd":{
            "type":"string",
            "description":"Name code of the document"
        },
        "remarks":{
            "type":"string",
            "description":"remarks"
        },
        "uploadDate":{
            "type":"string",
            "description":"Date on which document was uploaded"
        },
        "accountId":{
            "type":"string",
            "description":"Account ID associated with the document"
        },
        "caseId":{
            "type":"string",
            "description":"Case ID associated with the document"
        }
    },
    "required":[
        "documentNameDesc",
        "accountId"
    ]
}

Nested Schema : fileTransferDtoList

Type: array

Show Source

• Array of: object FileTransferDto

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

Nested Schema : FileTransferDto

Type: object

Show Source

• fileContent: string
  Content of the file
• fileName: string
  Name of the file

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"Name of the file"
        },
        "fileContent":{
            "type":"string",
            "description":"Content of the file"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

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

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
  An array of response codes.
• getResponse: object NotesCollection
  Collection of Notes.
• id: string
  The ID of the response.
• requestId: string
  The ID of the request associated with the response.
• saveResponse: object inlineResponse201
  ID of the newly created order.
• status: string
  The status of the response.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the response."
        },
        "status":{
            "type":"string",
            "description":"The status of the response."
        },
        "codes":{
            "type":"array",
            "description":"An array of response codes.",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"The ID of the request associated with the response."
        },
        "saveResponse":{
            "$ref":"#/definitions/inlineResponse201"
        },
        "getResponse":{
            "$ref":"#/definitions/NotesCollection"
        }
    }
}

Nested Schema : codes

Type: array

An array of response codes.

Show Source

• Array of: object ResponseCode
  Response code for account.

{
    "type":"array",
    "description":"An array of response codes.",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : NotesCollection

Type: object

Collection of Notes.

Show Source

• notesList: array notesList

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

Nested Schema : inlineResponse201

Type: object

ID of the newly created order.

Show Source

• id: string

{
    "description":"ID of the newly created order.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseCode

Type: object

Response code for account.

Show Source

• arg: string
  The argument used in the response message.
• args: array args
  The arguments used in the response message.
• Code: string
  The code representing the response status.
• Desc: string
  The description of the response status.
• Language: string
  The language used for the response message.
• Type: string
  The type of the response status.

{
    "type":"object",
    "description":"Response code for account.",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The code representing the response status."
        },
        "Desc":{
            "type":"string",
            "description":"The description of the response status."
        },
        "Type":{
            "type":"string",
            "description":"The type of the response status."
        },
        "Language":{
            "type":"string",
            "description":"The language used for the response message."
        },
        "args":{
            "type":"array",
            "description":"The arguments used in the response message.",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"The argument used in the response message."
        }
    }
}

Nested Schema : args

Type: array

The arguments used in the response message.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The arguments used in the response message.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : notesList

Type: array

Show Source

• Array of: object NotesModel
  Notes model

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

Nested Schema : NotesModel

Type: object

Notes model

Show Source

• accountId: string
  The unique identifier of the account for which the note is created.
• actionId: string
  Action ID linked to the Note
• alert: string
  Alert Flag
• applyToAllAccounts: boolean
  Apply To All Accounts Flag
• capturedBy: string
  The unique identifier of the user who captured the note.
• caseId: string
  Case Id
• createdDate: string
  Created Date
• desc: string
  A description of the note.
• notesId: string
  The unique identifier of the note.
• notesType: string
  The type of the note.
• status: string
  The status of the note.

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"The unique identifier of the note.",
            "type":"string"
        },
        "accountId":{
            "description":"The unique identifier of the account for which the note is created.",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"The unique identifier of the user who captured the note.",
            "type":"string"
        },
        "status":{
            "description":"The status of the note.",
            "type":"string"
        },
        "notesType":{
            "description":"The type of the note.",
            "type":"string"
        },
        "desc":{
            "description":"A description of the note.",
            "type":"string"
        },
        "actionId":{
            "description":"Action ID linked to the Note",
            "type":"string"
        },
        "applyToAllAccounts":{
            "description":"Apply To All Accounts Flag",
            "type":"boolean"
        },
        "caseId":{
            "description":"Case Id",
            "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