Skip to content

Latest commit

 

History

History
68 lines (56 loc) · 2.08 KB

inspect_object_info.md

File metadata and controls

68 lines (56 loc) · 2.08 KB

Command

<Inspect_Object_Info id="" />

Description

Returns current measurement information for object with specific id

Parameters

  • id (required) — object id to be retrieved
  • fullData — return all property data regardless of settings

Return format

A XML response with the following format:

  • response — default wrapper for all API responses
    • data — default wrapper for all secondary data API responses
    • 'inspect_object_info' — container for object information

Errors

  • 406 — Missing parameter "id" in request

Sample Response

<!-- RESPONSE 1 -->
<response>
    <success>
        <command_received>inspect_object_info</command_received>
        <acknowledgement />
        <request_id>1</request_id>
    </success>
</response>
<!-- RESPONSE 2 -->
<response>
    <success>
        <command_received>inspect_object_info</command_received>
        <acknowledgement />
        <request_id>31</request_id>
    </success>
</response>
<response>
    <success>
        <command_received>inspect_object_info</command_received>
        <data>
            <inspect_object_info>
                <object id="0" type="Circle">Circle1
			<property name="X" nominal="1.7036102732138081" tolmin="-0.01" tolmax="0.01" measured="1.7036102732138081" deviation="0" />
			<property name="Y" nominal="-0.77498499447846503" tolmin="-0.01" tolmax="0.01" measured="-0.77498499447846503" deviation="0" />
			<property name="Z" nominal="0" tolmin="-0.01" tolmax="0.01" measured="0" deviation="0" />
			<property name="Diameter" nominal="1.0730330585783212" tolmin="-0.01" tolmax="0.01" measured="1.0730330585783212" deviation="0" />
			<property name="Alignments" value="Auto-Align1" />
			<property name="Transformation" value="Translation: X:-0.1818 Y:0.0039 Z:0.0150 / Rotation: A:0.0000 B:-0.0000 C:0.8451" /></object>
			<property name="Position" nominal="0" tolmax="0.01" measured="0" deviation="0" /></object>
            </inspect_object_info>
        </data>
        <completed />
        <request_id>31</request_id>
    </success>
</response>