Uploaded image for project: 'Document Management System'
  1. Document Management System
  2. DMS-1170

CBES - API to get details and download files of candidate

    Details

    • Type: New Feature
    • Status: Done
    • Priority: Medium
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: Enhancements - Fall
    • Labels:
      None

      Description

      API that can be used to download files related to a specific candidate.

        Attachments

        1. DMS-1170_API_Updated.doc
          24 kB
        2. DMS-1170_API.doc
          24 kB
        3. DMS-1170_ETA.xls
          7 kB
        4. DMS-1170.xls
          11 kB
        5. Screenshot 2019-04-09 at 5.26.41 PM.png
          Screenshot 2019-04-09 at 5.26.41 PM.png
          189 kB
        6. Screenshot 2019-04-10 at 11.38.47 AM.png
          Screenshot 2019-04-10 at 11.38.47 AM.png
          207 kB
        7. Screenshot 2019-04-10 at 11.39.39 AM.png
          Screenshot 2019-04-10 at 11.39.39 AM.png
          211 kB

          Activity

          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          Hi Jilna,

          We have below queries for API to get details and download files of candidate:

          1. In case of candidate file 'Delete' action , does system need to delete file permanently from file server and database (hard deletion) or system will keep file but its 'Isdeleted' flag will set to yes (soft deletion)?
          2. For candidate file 'Open' action, what exactly API needs to perform?

          Can you please provide your input on same?

          Thanks,
          Komal

          CC:Samir, Swapnil Pandhare, Rohan J Khandave, Ganesh Sadawarte, Narendra Kumar

          Show
          komal.barde Komal Barde (Inactive) added a comment - Hi Jilna , We have below queries for API to get details and download files of candidate: In case of candidate file 'Delete' action , does system need to delete file permanently from file server and database (hard deletion) or system will keep file but its 'Isdeleted' flag will set to yes (soft deletion)? For candidate file 'Open' action, what exactly API needs to perform? Can you please provide your input on same? Thanks, Komal CC: Samir , Swapnil Pandhare , Rohan J Khandave , Ganesh Sadawarte , Narendra Kumar
          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          Hi

          Please find attached DMS-1170_ETA.xls document that contains ETA for DMS-1170.
          For 'Delete' and 'Open' action we have some queries as mentioned in above comment, so ETA for both will vary depending on client input.

          Thanks,
          Komal
          CC:Samir, Swapnil Pandhare, Ganesh Sadawarte, Rohan J Khandave, Narendra Kumar

          Show
          komal.barde Komal Barde (Inactive) added a comment - Hi Please find attached DMS-1170_ETA.xls document that contains ETA for DMS-1170 . For 'Delete' and 'Open' action we have some queries as mentioned in above comment, so ETA for both will vary depending on client input. Thanks, Komal CC: Samir , Swapnil Pandhare , Ganesh Sadawarte , Rohan J Khandave , Narendra Kumar
          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          Task Done:

          1. Analysis to get candidate file details
          2.  Analysis to download candidate file details
          3. Discussion with Swapnil
          4. Prepare ETA
          Show
          komal.barde Komal Barde (Inactive) added a comment - Task Done: Analysis to get candidate file details  Analysis to download candidate file details Discussion with Swapnil Prepare ETA
          Hide
          Jilna Jilna (Inactive) added a comment -

          Hi Komal Barde

           

          Please find my answers inline.

           

          1. In case of candidate file 'Delete' action , does system need to delete file permanently from file server and database (hard deletion) or system will keep file but its 'Isdeleted' flag will set to yes (soft deletion)? Jilna: This action will be removed, that means we will no longer be showing the delete option to the candidate, the mock up's needs to be updated.
          2. For candidate file 'Open' action, what exactly API needs to perform? Jilna: "Open" opens document in browser's native preview app

           

          Samir Swapnil Pandhare Ganesh Sadawarte Rohan J Khandave Narendra Kumar **

          Show
          Jilna Jilna (Inactive) added a comment - Hi Komal Barde   Please find my answers inline.   In case of candidate file 'Delete' action , does system need to delete file permanently from file server and database (hard deletion) or system will keep file but its 'Isdeleted' flag will set to yes (soft deletion)? Jilna: This action will be removed, that means we will no longer be showing the delete option to the candidate, the mock up's needs to be updated. For candidate file 'Open' action, what exactly API needs to perform? Jilna: "Open" opens document in browser's native preview app   Samir Swapnil Pandhare Ganesh Sadawarte Rohan J Khandave Narendra Kumar   **
          Hide
          komal.barde Komal Barde (Inactive) added a comment - - edited

          Task status:

          1. Download action: Completed
          2. Get details : Pagination and searching is Completed
          3. Get details : Sorting is in-progress
          4. Test case writing in current integration API - Not started

          CC: Swapnil Pandhare,Ganesh Sadawarte, Samir

          Show
          komal.barde Komal Barde (Inactive) added a comment - - edited Task status: Download action: Completed Get details : Pagination and searching is Completed Get details : Sorting is in-progress Test case writing in current integration API - Not started CC: Swapnil Pandhare , Ganesh Sadawarte , Samir
          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          Hi

          Please find DMS-1170_API.doc document for API details of get details and download or open files of candidate.

          This API contains below action:

          1. Get details of files : This will return list of candidate uploaded files and total no of records
          2. Download candidate file and open candidate file: This will return file content for given file ID. (Note: We have a added common code for 'Download' and 'Open' action, as both need to return file content).

          Thanks,
          Komal
          CC:Samir, Swapnil Pandhare,Ganesh Sadawarte

          Show
          komal.barde Komal Barde (Inactive) added a comment - Hi Please find DMS-1170_API.doc document for API details of get details and download or open files of candidate. This API contains below action: 1. Get details of files : This will return list of candidate uploaded files and total no of records 2. Download candidate file and open candidate file : This will return file content for given file ID. ( Note : We have a added common code for 'Download' and 'Open' action, as both need to return file content). Thanks, Komal CC: Samir , Swapnil Pandhare , Ganesh Sadawarte
          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          List of modified/added files:

          1. DMS/DMS.App/src/DMS_AppLogic/IntegrationLogic/ProvisioningApiLogic.cs
          2. DMS/DMS.App/src/DMS_AppLogic/Repository/IGenRepository.cs
          3. DMS/DMS.App/src/DMS_WebApi/Controllers/IntegrationAPI/ProvisioningAPIController.cs
          4. DMS/DMS.App/src/Entities/IntegrationDtos/CandidateFileDTO.cs
          5. DMS/DMS_App_Tests/ProvisioningApiTest.cs
          Show
          komal.barde Komal Barde (Inactive) added a comment - List of modified/added files : DMS/DMS.App/src/DMS_AppLogic/IntegrationLogic/ProvisioningApiLogic.cs DMS/DMS.App/src/DMS_AppLogic/Repository/IGenRepository.cs DMS/DMS.App/src/DMS_WebApi/Controllers/IntegrationAPI/ProvisioningAPIController.cs DMS/DMS.App/src/Entities/IntegrationDtos/CandidateFileDTO.cs DMS/DMS_App_Tests/ProvisioningApiTest.cs
          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          Task Done:

          1. Get details : Sorting is 
          2. Test case writing in current integration API 
          3. Unit testing
          4. Code merge

          CC: Samir, Swapnil Pandhare, Ganesh Sadawarte

          Show
          komal.barde Komal Barde (Inactive) added a comment - Task Done: Get details : Sorting is  Test case writing in current integration API  Unit testing Code merge CC: Samir , Swapnil Pandhare , Ganesh Sadawarte
          Hide
          komal.barde Komal Barde (Inactive) added a comment -

          Hi Swapnil Pandhare,

          I have done suggested code changes in 'DMS-1170_Final' branch and assigned it to you for code review.

          Thanks,
          Komal
          CC:Ganesh Sadawarte

          Show
          komal.barde Komal Barde (Inactive) added a comment - Hi Swapnil Pandhare , I have done suggested code changes in ' DMS-1170 _Final' branch and assigned it to you for code review. Thanks, Komal CC: Ganesh Sadawarte
          Hide
          komal.barde Komal Barde (Inactive) added a comment - - edited

          Hi Jilna,

          Please find updated  DMS-1170_API_Updated.doc  document for API details of get details and download files for a candidate.

          Thanks,
          Komal

          CC: Samir, Swapnil Pandhare,Ganesh Sadawarte

          Show
          komal.barde Komal Barde (Inactive) added a comment - - edited Hi Jilna , Please find updated  DMS-1170_API_Updated.doc  document for API details of get details and download files for a candidate. Thanks, Komal CC: Samir , Swapnil Pandhare , Ganesh Sadawarte
          Hide
          Jilna Jilna (Inactive) added a comment - - edited

          Hi Komal Barde

           

          There will be issues with the "Get details of files related to a specific candidate" when a specific candidate has two release associated with his email address.

          When I fetch documents it will give me all files related to both the releases. What we need would be to fetch files by

          releaseId

          Also, can we have another endpoint to fetch(not download) files by Id?

          Mason Michael Samir Swapnil Pandhare

           

          Show
          Jilna Jilna (Inactive) added a comment - - edited Hi Komal Barde   There will be issues with the "Get details of files related to a specific candidate"  when a specific candidate has two release associated with his email address. When I fetch documents it will give me all files related to both the releases. What we need would be to fetch files by releaseId Also, can we have another endpoint to fetch(not download) files by Id? Mason Michael Samir   Swapnil Pandhare  
          Hide
          komal.barde Komal Barde (Inactive) added a comment - - edited

          Hi Harshveer Singh,

          Please find below details of get file data of candidate API:

          API Endpoint details:
          HTTP Method : GET
          URL : /api/get/candidate/upload/hbcandidate@hb.com/2/1/DMS/filename/ desc

          API Input:

          1. PersonEmail (Required):This will contain person email address whose uploaded file list needs to provide.
          2. PageSize: This will contain no of records to be provided for given page.
          3. PageNumber: This will contain page no to be provided.
          4. SearchTerm: This will contain string that will be used to search data in list.
          5. Sortcolumn: This will be used to sort candidates uploaded file(s) list by specific column and this will contain – filename, uploadedby, datetime, description, orderID, releaseID .
          6. Sortby: This will be used to sort candidates uploaded file(s) list in ascending or descending order and this will contain – asc, desc .

          API Return value:

          List of candidate uploaded files and total no of records

          API Success Response:
          On success following response will be returned:
          HTTP/1.1 200
          {
          "data": [
          {
          "UploadFileobj":

          { "file_name": "CandiadateProfile.doc", "file_description": "Candidate Profile File", "file_content": null, "orderID": 1, "releaseID": 2, "uploaderusername": "Career Builder" }

          ,

          "attchementID": 231,
          "CreatedDateTime": "2019-04-29T12:19:47"
          },
          {
          "UploadFileobj":

          { "file_name": "CandiadateEmplyment.pdf", "file_description": "Candidate Emplyment File", "file_content": null, "orderID": 3, "releaseID": 4, "uploaderusername": "You" }

          ,
          "attchementID": 232,
          "CreatedDateTime": "2019-04-29T12:22:32"
          }
          ],
          "noofrecords": 5
          }

          Thanks,
          Komal
          CC:Swapnil Pandhare, Ganesh Sadawarte,Samir

          Show
          komal.barde Komal Barde (Inactive) added a comment - - edited Hi  Harshveer Singh , Please find below details of get file data of candidate API: API Endpoint details: HTTP Method : GET URL : /api/get/candidate/upload/hbcandidate@hb.com/2/1/DMS/filename/ desc API Input: PersonEmail (Required):This will contain person email address whose uploaded file list needs to provide. PageSize: This will contain no of records to be provided for given page. PageNumber: This will contain page no to be provided. SearchTerm: This will contain string that will be used to search data in list. Sortcolumn: This will be used to sort candidates uploaded file(s) list by specific column and this will contain – filename, uploadedby, datetime, description, orderID, releaseID . Sortby: This will be used to sort candidates uploaded file(s) list in ascending or descending order and this will contain – asc, desc . API Return value : List of candidate uploaded files and total no of records API Success Response: On success following response will be returned: HTTP/1.1 200 { "data": [ { "UploadFileobj": { "file_name": "CandiadateProfile.doc", "file_description": "Candidate Profile File", "file_content": null, "orderID": 1, "releaseID": 2, "uploaderusername": "Career Builder" } , "attchementID": 231, "CreatedDateTime": "2019-04-29T12:19:47" }, { "UploadFileobj": { "file_name": "CandiadateEmplyment.pdf", "file_description": "Candidate Emplyment File", "file_content": null, "orderID": 3, "releaseID": 4, "uploaderusername": "You" } , "attchementID": 232, "CreatedDateTime": "2019-04-29T12:22:32" } ], "noofrecords": 5 } Thanks, Komal CC: Swapnil Pandhare , Ganesh Sadawarte , Samir
          Show
          komal.barde Komal Barde (Inactive) added a comment - Hi  Harshveer Singh , Can you please look into Jilna 's  https://jira.workterra.net/browse/DMS-1170?focusedCommentId=264175&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-264175  comment ? Thanks, Komal CC:  Swapnil Pandhare ,  Ganesh Sadawarte ,  Samir ,  Jilna
          Hide
          harshveer.singh Harshveer Singh (Inactive) added a comment - - edited

          Created PR: https://github.com/cbdr/DMS/pull/612

          API EndPoint is : /api/candidateattachments?page=1&count=10&sortorder=asc&sortcolumn=&searchterm=&releaseid=0&orderid=0

          Above specified are the query string parameters supported with default values. Either releaseid or orderid parameter must be specified to filter otherwise no results will be retured.

          Values for sortOrder is 'asc' or 'desc', and possible values for sortcolumn are: filename, uploadedby, datetime, description, orderid, releaseid

           

           CC Samir, Jilna

          Show
          harshveer.singh Harshveer Singh (Inactive) added a comment - - edited Created PR:  https://github.com/cbdr/DMS/pull/612 API EndPoint is : /api/candidateattachments?page=1&count=10&sortorder=asc&sortcolumn=&searchterm=&releaseid=0&orderid=0 Above specified are the query string parameters supported with default values. Either releaseid or orderid parameter must be specified to filter otherwise no results will be retured. Values for sortOrder is 'asc' or 'desc', and possible values for sortcolumn are: filename, uploadedby, datetime, description, orderid, releaseid    CC Samir , Jilna
          Hide
          priya.dhamande Priya Dhamande (Inactive) added a comment -

          No Testing required from Qa end, So, marking jira done.

          Show
          priya.dhamande Priya Dhamande (Inactive) added a comment - No Testing required from Qa end, So, marking jira done.

            People

            Assignee:
            priya.dhamande Priya Dhamande (Inactive)
            Reporter:
            swapnil.pandhare Swapnil Pandhare (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 24h
                24h
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 22h Time Not Required
                22h