HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Lift Cell Lock

Endpoint

INTERFACE_SIMULATION_API_ENDPOINT

Request Parameters

ParameterMandatory?Data typeDescription
xTrueIntSpecifies the x value of the cell.
yTrueIntSpecifies the y value of the cell.
clearFalseBooleanClear lock flag. Default false.

Request Example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the task interface
string url = "http://" + ip + ":44002/api/v1/simulation";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>lift_cell_lock</name>
  <params>
    <x>3</x>
    <y>50</y>
    <clear>true</clear>
  </params>
</methodcall>");
//POST to interface
HttpResponseMessage response = await new HttpClient().PostAsync(url, new StringContent(xmlData,
        Encoding.UTF8, "application/xml"));
string responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
# Interface installation location (IP address)
ip = "127.0.0.1"
# The URL to the task interface
url = f"http://{ip}:44002/api/v1/simulation"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>lift_cell_lock</name>
  <params>
    <x>3</x>
    <y>50</y>
    <clear>true</clear>
  </params>
</methodcall>"""
# POST to interface
response = requests.post(url, data=xmlData.encode('utf-8'), headers={"Content-Type": "application/xml"})
print(response.text)
const ip = "127.0.0.1";
const url = `http://${ip}:44002/api/v1/simulation`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>lift_cell_lock</name>
  <params>
    <x>3</x>
    <y>50</y>
    <clear>true</clear>
  </params>
</methodcall>`;

fetch(url, {
    method: 'POST',
    body: xmlData,
    headers: {
        'Content-Type': 'application/xml'
    }
})
    .then(response => response.text())
    .then(responseString => console.log(responseString));
<?xml version="1.0"?>
<methodcall>
  <name>set_robot_cell_lock</name>
  <name>lift_cell_lock</name>
  <params>
    <x>3</x>
    <y>50</y>
    <clear>true</clear>
  </params>
</methodcall>

Response Parameters

This method has no response parameters.

Response Example

<?xml version="1.0"?>
<response>
  <params />
</response>

Error Codes

None