This function is used to add location objects to the system.
Required Information | |
---|---|
Name | Description |
action | adminlocations |
operation | add |
format | xml |
name | Location name. Any text, 32 character max. |
Optional Information | |
active | flag to specify if you want the location to be set as active or inactive. Active locations will show up in the location filter dropdowns in GTC, inactive will not. Possible values are
Note: If no value is passed for active, true is assumed. |
Returned information
A success or error message.
Example Request
https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=adminlocations&operation=add&format=xml&name=Home
Example Success Reply
<?xml version="1.0"?>
<success ver="1.07">
<action>adminlocations</action>
</success>
Example Error Reply
<?xml version="1.0"?>
<error ver="1.0">
<action>adminlocations</action>
<code>201</code>
<message>Location 'Seattle' could not be found.</message>
</error>