Markups

`MU_01`: Create 2D Annotation (Unity-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_01

Payload Definition

Type: `InteractivityState`

{
  "Version": "String",
  "Value": "Boolean"
}

Example definition

Type: `InteractivityState`

{
  "Version": "0.0.1",
  "Value": true
}

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`S00004`	Markup object was created.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00031`	Return channel Id, {ID}, could not be found.
`I00004`	No longer waiting for return message with return id: {ID}

`MU_02`: Create 3D Annotation (Unity-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_02

Payload Definition

Type: `AnnotationCreationData`

{
  "Version": "String",
  "Title": "String",
  "Description": "String",
  "Position": {
    "Version": "String",
    "X": "Float",
    "Y": "Float",
    "Z": "Float"
  }
}

Example definition

Type: `AnnotationCreationData`

"AnnotationCreationData"

Response Codes

Code	Description
`S00000`	Action was received from Front End.
`S00001`	Action from Front End has completed.
`S00004`	Markup object was created.
`F00000`	Error executing the supplied function
`F00001`	Function is not defined
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00032`	String length exceeded limits defined

`MU_03`: Create Annotation(s) in 2D/3D (Front End-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_03

Payload Definition

Type: `DataOverlayData[]`

{
  "LongLength": "Int64",
  "IsFixedSize": "Boolean",
  "IsReadOnly": "Boolean",
  "IsSynchronized": "Boolean",
  "SyncRoot": {},
  "Length": "Int32",
  "Rank": "Int32"
}

Example definition

Type: `DataOverlayData[]`

"DataOverlayData[]"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`A00004`	Element was invalid for function. Element will be skipped.

`MU_04`: Move 2D Annotation(Unity-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_04

Payload Definition

Type: `ObjectBoolean`

{
  "Version": "String",
  "Id": "String",
  "Value": "Boolean"
}

Example definition

Type: `ObjectBoolean`

"ObjectBoolean"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.

`MU_05`: Move 3D Annotation(Unity - based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_05

Payload Definition

Type: `ObjectBoolean`

{
  "Version": "String",
  "Id": "String",
  "Value": "Boolean"
}

Example definition

Type: `ObjectBoolean`

"ObjectBoolean"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.

`MU_06`: Move Annotation(s) in 2D / 3D Views (Front End-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_06

Payload Definition

Type: `ObjectPosition[]`

{
  "LongLength": "Int64",
  "IsFixedSize": "Boolean",
  "IsReadOnly": "Boolean",
  "IsSynchronized": "Boolean",
  "SyncRoot": {},
  "Length": "Int32",
  "Rank": "Int32"
}

Example definition

Type: `ObjectPosition[]`

"ObjectPosition[]"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.
`A00004`	Element was invalid for function. Element will be skipped.

`MU_07`: Remove Annotation (Front End Based)

Version: 1.0.0
Interface: markups
Action: mu_07

Payload Definition

Type: `ObjectId`

{
  "Version": "String",
  "Id": "String"
}

Example definition

Type: `ObjectId`

"ObjectId"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`A00004`	Element was invalid for function. Element will be skipped.

`MU_08`: Edit Title of Annotations (Front End Based)

Version: 1.0.0
Interface: markups
Action: mu_08

Payload Definition

Type: `ObjectInfo`

{
  "Version": "String",
  "Id": "String",
  "Value": "String"
}

Example definition

Type: `ObjectInfo`

"ObjectInfo"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00032`	String length exceeded limits defined
`A00004`	Element was invalid for function. Element will be skipped.

`MU_09`: Edit Description of Annotations (Front End Based)

Version: 1.0.0
Interface: markups
Action: mu_09

Payload Definition

Type: `ObjectInfo`

{
  "Version": "String",
  "Id": "String",
  "Value": "String"
}

Example definition

Type: `ObjectInfo`

"ObjectInfo"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00032`	String length exceeded limits defined
`A00004`	Element was invalid for function. Element will be skipped.

`MU_10`: Edit Call to Action of Annotations (Front End Based)

Version: 1.0.0
Interface: markups
Action: mu_10

Payload Definition

Type: `ObjectInfo`

{
  "Version": "String",
  "Id": "String",
  "Value": "String"
}

Example definition

Type: `ObjectInfo`

"ObjectInfo"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`A00004`	Element was invalid for function. Element will be skipped.

`MU_16`: MU-16: Set 2D/3D Visibility of Individual Markups

Version: 1.0.0
Interface: markups
Action: mu_16

Payload Definition

Type: `ObjectDimensionalVisibility[]`

{
  "LongLength": "Int64",
  "IsFixedSize": "Boolean",
  "IsReadOnly": "Boolean",
  "IsSynchronized": "Boolean",
  "SyncRoot": {},
  "Length": "Int32",
  "Rank": "Int32"
}

Example definition

Type: `ObjectDimensionalVisibility[]`

"ObjectDimensionalVisibility[]"

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
`F00002`	Input data is not valid for function
`F00006`	Action did not execute within an allotted time
`F00008`	Function is not found
`F00011`	The payload supplied is invalid
`F00027`	Object with Id, {ID}, could not be found.
`A00004`	Element was invalid for function. Element will be skipped.

`MU_20`: 2D Length Tool (Unity-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_20

Payload Definition

Type: `InteractivityState`

{
  "Version": "String",
  "Value": "Boolean"
}

Example definition

Type: `InteractivityState`

{
  "Version": "0.0.1",
  "Value": true
}

Response Codes

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

`MU_21`: 2D Polygon Tool (Unity-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_21

Payload Definition

Type: `InteractivityState`

{
  "Version": "String",
  "Value": "Boolean"
}

Example definition

Type: `InteractivityState`

{
  "Version": "0.0.1",
  "Value": true
}

Response Codes

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

`MU_22`: 2D Angle Tool (Unity-based Interaction)

Version: 1.0.0
Interface: markups
Action: mu_22

Payload Definition

Type: `InteractivityState`

{
  "Version": "String",
  "Value": "Boolean"
}

Example definition

Type: `InteractivityState`

{
  "Version": "0.0.1",
  "Value": true
}

Response Codes

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