Jump to

• Request
• Response

Fetch details of all Inbound Document uploaded

get

/obcr-correspondence-services/inboundDocument/getDetails

This endpoint is used to fetch details of the already uploaded Inbound documents for this accountId.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId(required): string
  Account Id
• caseId(required): string
  Case Id
• limit: integer
  Limit is maximum number of records to be fetched.
• mode: boolean
  Mode is total results count to be fetched.
• offset: integer
  Offset is starting number of records to be fetched.

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.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : InboundDocDtlsDtoCollection

Type: object

Show Source

• docCategoryDtoList: array docCategoryDtoList
• inboundDocDtlsDtoList: array inboundDocDtlsDtoList
• paging: object PagingDto

{
    "type":"object",
    "properties":{
        "inboundDocDtlsDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InboundDocDtlsDto"
            }
        },
        "docCategoryDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocCategoryDto"
            }
        },
        "paging":{
            "description":"Paging",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : docCategoryDtoList

Type: array

Show Source

• Array of: object DocCategoryDto

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

Nested Schema : inboundDocDtlsDtoList

Type: array

Show Source

• Array of: object InboundDocDtlsDto

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : DocCategoryDto

Type: object

Show Source

• docCategoryCd: string
  Look Up Code for the document category
• docCategoryDesc: string
  Look Up Code description for the document category
• docNameDtoList: array docNameDtoList

{
    "type":"object",
    "properties":{
        "docCategoryCd":{
            "type":"string",
            "description":"Look Up Code for the document category"
        },
        "docCategoryDesc":{
            "type":"string",
            "description":"Look Up Code description for the document category"
        },
        "docNameDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocNameDto"
            }
        }
    }
}

Nested Schema : docNameDtoList

Type: array

Show Source

• Array of: object DocNameDto

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

Nested Schema : DocNameDto

Type: object

Show Source

• docNameCd: string
  Look Up Code for the document name
• docNameDesc: string
  Look Up Code description for the document name

{
    "type":"object",
    "properties":{
        "docNameCd":{
            "type":"string",
            "description":"Look Up Code for the document name"
        },
        "docNameDesc":{
            "type":"string",
            "description":"Look Up Code description for the document name"
        }
    }
}

Nested Schema : InboundDocDtlsDto

Type: object

Show Source

• docCtgry: string
  Category of the document
• docName: string
  Name of the document
• docRefId: string
  Document Id of the document to be used to search the file in DMS
• id: string
  ID of the record
• remarks: string
  Remarks of the uploaded document
• uploadDate: string
  Date on which document was uploaded

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the record"
        },
        "docRefId":{
            "type":"string",
            "description":"Document Id of the document to be used to search the file in DMS"
        },
        "docCtgry":{
            "type":"string",
            "description":"Category of the document"
        },
        "docName":{
            "type":"string",
            "description":"Name of the document"
        },
        "uploadDate":{
            "type":"string",
            "description":"Date on which document was uploaded"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks of the uploaded document"
        }
    }
}

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