POST api/WorkflowEngine/Study/ReserveStudy

Reserves the study.

Request Information

URI Parameters

None.

Body Parameters

ReserveInfoRequest
NameDescriptionTypeAdditional information
StudyInfoList

Collection of StudyInfoRequest

None.

Assigner

string

None.

AssignedTo

string

None.

Duration

integer

None.

UserLogin

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StudyInfoList": [
    {
      "StudyInstanceId": "sample string 1",
      "DataSource": "sample string 2"
    },
    {
      "StudyInstanceId": "sample string 1",
      "DataSource": "sample string 2"
    }
  ],
  "Assigner": "sample string 1",
  "AssignedTo": "sample string 2",
  "Duration": 3,
  "UserLogin": "sample string 4"
}

application/octet-stream

Sample:
{"StudyInfoList":[{"StudyInstanceId":"sample string 1","DataSource":"sample string 2"},{"StudyInstanceId":"sample string 1","DataSource":"sample string 2"}],"Assigner":"sample string 1","AssignedTo":"sample string 2","Duration":3,"UserLogin":"sample string 4"}

application/xml, text/xml

Sample:
<ReserveInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Worklists">
  <AssignedTo>sample string 2</AssignedTo>
  <Assigner>sample string 1</Assigner>
  <Duration>3</Duration>
  <StudyInfoList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fujifilm.Synapse.Workflow.Engine.Models.Study">
    <d2p1:StudyInfoRequest>
      <d2p1:DataSource>sample string 2</d2p1:DataSource>
      <d2p1:StudyInstanceId>sample string 1</d2p1:StudyInstanceId>
    </d2p1:StudyInfoRequest>
    <d2p1:StudyInfoRequest>
      <d2p1:DataSource>sample string 2</d2p1:DataSource>
      <d2p1:StudyInstanceId>sample string 1</d2p1:StudyInstanceId>
    </d2p1:StudyInfoRequest>
  </StudyInfoList>
  <UserLogin>sample string 4</UserLogin>
</ReserveInfoRequest>

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, application/octet-stream

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>