41. Manage Location of Interest (LOI) Categories*

Use these functions to manage location of interest categories. For LOI* management functions see:


41.1 Add

Add a new LOI* category.

Required Information
Name Description
action editposition
operation addloicategories
format xml
name The name to give the LOI* category. Any arbitrary text string up to 128 characters in length.
isvisible Either 'true' or 'false'. Indicates whether the category will be displayed or not.

41.1 Add Reply

Returned information:
A success or error message.

Example Request:

http://development.zonarsystems.net/interface.php?action=editposition&operation=addloicategories&format=xml&name=Example&isvisible=true

Example Success Reply,

41.2 Delete

Use this to delete an existion LOI* category.

Required Information
Name Description
action editposition
operation deleteloicategories
format xml
target The name of the LOI* category to remove.

41.2 Delete Reply

Returned information:
A success or error message.

Example Request:

http://development.zonarsystems.net/interface.php?action=editposition&operation=deleteloicategories&format=xml&target=Example

Note:
A LOI* category that has LOIs* assigned to it cannot be deleted. In this case the error code returned will be 203.

41.3 Edit

Use this to alter the name or visible status of an LOI* category.

Required Information
Name Description
action editposition
operation editloicategories
format xml
target The name of the LOI* category to modify.
name The new name to give the LOI* category. Any arbitrary text string up to 128 characters in length.
isvisible Either 'true' or 'false'. Indicates whether the category will be displayed or not.

41.3 Edit Reply

Returned information:
A success or error message.

Example Request:

http://development.zonarsystems.net/interface.php?action=editposition&operation=editloicategories&format=xml&target=Example&name=Example&isvisble=false

41.4 List

Use this to obtain a list of the existing LOI* categories in the system.

Required Information
Name Description
action editposition
operation loicategories
format xml

41.4 List Reply

Returned information:
Either an LOI* category list or an error response

DTD:
<!ELEMENT loicategory_list (category*)>
<!ATTLIST category id CDATA #REQUIRED>
<!ATTLIST category isvisible CDATA #REQUIRED>
<!ATTLIST category name CDATA #REQUIRED>
<!ATTLIST category loicount CDATA #REQUIRED>

Reply Data
Name Description
category An LOI* category object.
id The database id of the category. A positive integer quantity.
isvisible Either 'true' or 'false'. Indicates whether the category is visible in the web interface or not.
name The name of the category. An arbitrary text string up to 128 characters long.
loicount The number of locations of interest assigned to the category. A non negative integer quantity, may be zero.

Example Request:

http://development.zonarsystems.net/interface.php?action=editposition&operation=loicategories&format=xml&target=Example

Example Success Reply

*LOI means Location of Interest; called "Zone" in GPS tools and reports in Ground Traffic Control web application.