Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

verisurf-api/documentation/object_set_alignment.md

Go to file
 
 
Cannot retrieve contributors at this time
Command Description Parameters Return format Errors Sample Call Sample Response
50 lines (35 sloc) 1.16 KB
Raw Blame
Open in GitHub Desktop

Command

<Object_Set_Alignment id="" />

Description

Assigns a specified alignment to a single or multiple objects given the object ids.

Parameters

  • id(s) (required) — object id to be assigned an alignment
  • alignment id (required) — alignment to be used for assignment

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
    • 'object_set_alignment' — container for object information

Errors

  • 406 — Missing parameter "id(s)" in request

Sample Call

<object_set_alignment id="4"  alignment_id="7" />

 - Assigns Circle{4} to the first Auto-Alignment{7}. ID's are found from <Object_list />
 
<object_set_alignment ids="4,5,6"  alignment_id="7" />

 - Assigns a series of Features{4,5,6} to the first Auto-Alignment{7}. ID's are found from <Object_list />

Sample Response

<response>
    <success>
        <command_received>object_set_alignment</command_received>
        <acknowledgement />
        <request_id>1</request_id>
    </success>
</response>