POST api/v1/patients/downloadDicomFiles

Request Information

URI Parameters

None.

Body Parameters

DicomDownloadTaskDto
NameDescriptionTypeAdditional information
GlobalTaskId

string

None.

RequestId

string

None.

Source

string

None.

StudyInstanceId

string

None.

AccNo

string

None.

ZipResult

boolean

None.

CreateTime

date

None.

ReceiveTime

date

None.

ImageUrl

string

None.

Status

DicomDownloadTaskStatus

None.

FileName

string

None.

PatientType

string

None.

ModalityType

string

None.

DicomDownloadHistories

Collection of DicomDownloadHistory

None.

Request Formats

application/json, text/json

Sample:
{
  "globalTaskId": "sample string 1",
  "requestId": "sample string 2",
  "source": "sample string 3",
  "studyInstanceId": "sample string 4",
  "accNo": "sample string 5",
  "zipResult": true,
  "createTime": "2025-05-04T09:50:47.7754486+08:00",
  "receiveTime": "2025-05-04T09:50:47.7754486+08:00",
  "imageUrl": "sample string 8",
  "status": 1,
  "fileName": "sample string 9",
  "patientType": "sample string 10",
  "modalityType": "sample string 11",
  "dicomDownloadHistories": [
    {
      "uniqueId": "sample string 1",
      "id": "sample string 1",
      "globalTaskId": "sample string 2",
      "requestId": "sample string 3",
      "studyInstanceId": "sample string 4",
      "accNo": "sample string 5",
      "downloadTime": "2025-05-04T09:50:47.7754486+08:00",
      "retriveStartTime": "2025-05-04T09:50:47.7754486+08:00",
      "retriveEndTime": "2025-05-04T09:50:47.7754486+08:00",
      "patientType": "sample string 8",
      "modalityType": "sample string 9"
    },
    {
      "uniqueId": "sample string 1",
      "id": "sample string 1",
      "globalTaskId": "sample string 2",
      "requestId": "sample string 3",
      "studyInstanceId": "sample string 4",
      "accNo": "sample string 5",
      "downloadTime": "2025-05-04T09:50:47.7754486+08:00",
      "retriveStartTime": "2025-05-04T09:50:47.7754486+08:00",
      "retriveEndTime": "2025-05-04T09:50:47.7754486+08:00",
      "patientType": "sample string 8",
      "modalityType": "sample string 9"
    }
  ]
}

text/html

Sample:
{"globalTaskId":"sample string 1","requestId":"sample string 2","source":"sample string 3","studyInstanceId":"sample string 4","accNo":"sample string 5","zipResult":true,"createTime":"2025-05-04T09:50:47.7754486+08:00","receiveTime":"2025-05-04T09:50:47.7754486+08:00","imageUrl":"sample string 8","status":1,"fileName":"sample string 9","patientType":"sample string 10","modalityType":"sample string 11","dicomDownloadHistories":[{"uniqueId":"sample string 1","id":"sample string 1","globalTaskId":"sample string 2","requestId":"sample string 3","studyInstanceId":"sample string 4","accNo":"sample string 5","downloadTime":"2025-05-04T09:50:47.7754486+08:00","retriveStartTime":"2025-05-04T09:50:47.7754486+08:00","retriveEndTime":"2025-05-04T09:50:47.7754486+08:00","patientType":"sample string 8","modalityType":"sample string 9"},{"uniqueId":"sample string 1","id":"sample string 1","globalTaskId":"sample string 2","requestId":"sample string 3","studyInstanceId":"sample string 4","accNo":"sample string 5","downloadTime":"2025-05-04T09:50:47.7754486+08:00","retriveStartTime":"2025-05-04T09:50:47.7754486+08:00","retriveEndTime":"2025-05-04T09:50:47.7754486+08:00","patientType":"sample string 8","modalityType":"sample string 9"}]}

application/xml, text/xml

Sample:
<DicomDownloadTaskDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Csh.Hcis.GC.PatientCenter.Service.Dtos">
  <AccNo>sample string 5</AccNo>
  <CreateTime>2025-05-04T09:50:47.7754486+08:00</CreateTime>
  <DicomDownloadHistories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Csh.Hcis.GC.PatientCenter.Domain.Entities">
    <d2p1:DicomDownloadHistory>
      <UniqueId xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="http://schemas.datacontract.org/2004/07/Csh.Hcis.GC.PatientCenter.Domain">sample string 1</UniqueId>
      <d2p1:AccNo>sample string 5</d2p1:AccNo>
      <d2p1:DownloadTime>2025-05-04T09:50:47.7754486+08:00</d2p1:DownloadTime>
      <d2p1:GlobalTaskId>sample string 2</d2p1:GlobalTaskId>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:ModalityType>sample string 9</d2p1:ModalityType>
      <d2p1:PatientType>sample string 8</d2p1:PatientType>
      <d2p1:RequestId>sample string 3</d2p1:RequestId>
      <d2p1:RetriveEndTime>2025-05-04T09:50:47.7754486+08:00</d2p1:RetriveEndTime>
      <d2p1:RetriveStartTime>2025-05-04T09:50:47.7754486+08:00</d2p1:RetriveStartTime>
      <d2p1:StudyInstanceId>sample string 4</d2p1:StudyInstanceId>
    </d2p1:DicomDownloadHistory>
    <d2p1:DicomDownloadHistory>
      <UniqueId xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="http://schemas.datacontract.org/2004/07/Csh.Hcis.GC.PatientCenter.Domain">sample string 1</UniqueId>
      <d2p1:AccNo>sample string 5</d2p1:AccNo>
      <d2p1:DownloadTime>2025-05-04T09:50:47.7754486+08:00</d2p1:DownloadTime>
      <d2p1:GlobalTaskId>sample string 2</d2p1:GlobalTaskId>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:ModalityType>sample string 9</d2p1:ModalityType>
      <d2p1:PatientType>sample string 8</d2p1:PatientType>
      <d2p1:RequestId>sample string 3</d2p1:RequestId>
      <d2p1:RetriveEndTime>2025-05-04T09:50:47.7754486+08:00</d2p1:RetriveEndTime>
      <d2p1:RetriveStartTime>2025-05-04T09:50:47.7754486+08:00</d2p1:RetriveStartTime>
      <d2p1:StudyInstanceId>sample string 4</d2p1:StudyInstanceId>
    </d2p1:DicomDownloadHistory>
  </DicomDownloadHistories>
  <FileName>sample string 9</FileName>
  <GlobalTaskId>sample string 1</GlobalTaskId>
  <ImageUrl>sample string 8</ImageUrl>
  <ModalityType>sample string 11</ModalityType>
  <PatientType>sample string 10</PatientType>
  <ReceiveTime>2025-05-04T09:50:47.7754486+08:00</ReceiveTime>
  <RequestId>sample string 2</RequestId>
  <Source>sample string 3</Source>
  <Status>Created</Status>
  <StudyInstanceId>sample string 4</StudyInstanceId>
  <ZipResult>true</ZipResult>
</DicomDownloadTaskDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.