GET api/medistreamapi/medistreams/{cleanRoomId}?active={active}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cleanRoomId

globally unique identifier

Required

active

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Collection of MediStreamViewModel
NameDescriptionTypeAdditional information
id

globally unique identifier

None.

cleanroom_id

globally unique identifier

Required

local_id

integer

Range: inclusive between 0 and ∞

name

string

Required

serial_number

string

Required

active

boolean

Required

door_status

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "334d3d1b-4ad7-4275-be85-09239414aa7a",
    "cleanroom_id": "a12d8610-9877-4882-9fd6-d6ee8a52197b",
    "local_id": 1,
    "name": "sample string 3",
    "serial_number": "sample string 4",
    "active": true,
    "door_status": true
  },
  {
    "id": "334d3d1b-4ad7-4275-be85-09239414aa7a",
    "cleanroom_id": "a12d8610-9877-4882-9fd6-d6ee8a52197b",
    "local_id": 1,
    "name": "sample string 3",
    "serial_number": "sample string 4",
    "active": true,
    "door_status": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfmedistream xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <medistream>
    <active>true</active>
    <cleanroom_id>a12d8610-9877-4882-9fd6-d6ee8a52197b</cleanroom_id>
    <door_status>true</door_status>
    <id>334d3d1b-4ad7-4275-be85-09239414aa7a</id>
    <local_id>1</local_id>
    <name>sample string 3</name>
    <serial_number>sample string 4</serial_number>
  </medistream>
  <medistream>
    <active>true</active>
    <cleanroom_id>a12d8610-9877-4882-9fd6-d6ee8a52197b</cleanroom_id>
    <door_status>true</door_status>
    <id>334d3d1b-4ad7-4275-be85-09239414aa7a</id>
    <local_id>1</local_id>
    <name>sample string 3</name>
    <serial_number>sample string 4</serial_number>
  </medistream>
</ArrayOfmedistream>