View Selection

`VS_01`: Display 3D View

Version: 1.0.0
Interface: view_selection
Action: vs_01

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`VS_02`: Display Transverse View

Version: 1.0.0
Interface: view_selection
Action: vs_02

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00010`	This modality cannot be rendered for this view.
`F00011`	The payload supplied is invalid

`VS_03`: Display Sagittal View

Version: 1.0.0
Interface: view_selection
Action: vs_03

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00010`	This modality cannot be rendered for this view.
`F00011`	The payload supplied is invalid

`VS_04`: Display Coronal View

Version: 1.0.0
Interface: view_selection
Action: vs_04

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00010`	This modality cannot be rendered for this view.
`F00011`	The payload supplied is invalid

`VS_05`: Reset 2D / 3D View to Original Coordinates

Version: 1.0.0
Interface: view_selection
Action: vs_05

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`VS_06`: Reset All Views to Initial Values

Version: 1.0.0
Interface: view_selection
Action: vs_06

Payload Definition

Type: `EmptyPayload`

{
  "Version": "String"
}

Example definition

Type: `EmptyPayload`

{
  "Version": "0.0.1"
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid

`VS_07`: Toggle Visibility of each Individual Scan View

Version: 1.0.0
Interface: view_selection
Action: vs_07

Payload Definition

Type: `ViewToggleData`

{
  "Version": "String",
  "View": "ENUM: ScanView",
  "Visibility": "Boolean"
}

Example definition

Type: `ViewToggleData`

{
  "Version": "0.0.1",
  "View": 0,
  "Visibility": false
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid