API Documentation

Index:

Notes

AgencyFunctions
List setting_types(s) on the ssystem

List agency setting(s) on the ssystem
Edit an agency setting on the ssystem

UserCategoryFunctions
List user category type(s) on the system

List user category(s) on the system

UserFunctions
Get Agency from Domain

Login as a user

Validate a Session ID

Log a user out

List user_type(s) on the ssystem

List all users of a type for a agency on the ssystem

UserNotificationsFunctions
List user notification(s) on the ssystem
Edit an user notification on the ssystem
Delete an user notification on the ssystem

UserProfileFunctions
List user profile type(s) on the ssystem

List user profile(s) on the ssystem
Edit an user profile on the ssystem
Add an user profile item on the ssystem

agency_functions_agency_setting_types_list

Description:

List setting_types(s) on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null}

Info:

api_action - The name of the function

Reply Xml:

<?xml version="1.0"?>
<api>

 <agency_setting_types>
  <agency_setting_type>
   <agency_setting_type_can_edit>   </agency_setting_type_can_edit>

   <agency_setting_type_default_value>   </agency_setting_type_default_value>

   <agency_setting_type_desc>   </agency_setting_type_desc>

   <agency_setting_type_id>   </agency_setting_type_id>

   <agency_setting_type_setting_type>   </agency_setting_type_setting_type>
  </agency_setting_type>
 </agency_setting_types>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"status":null,"agency_setting_types":{"agency_setting_type":{"agency_setting_type_id":null,"agency_setting_type_can_edit":null,"agency_setting_type_default_value":null,"agency_setting_type_desc":null,"agency_setting_type_setting_type":null}},"error_description":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
agency_setting_types - container for all agency_setting_types
agency_setting_type - container for each agency_setting_types
agency_setting_type_id - ID of the item
agency_setting_type_desc - Description of the item
agency_setting_type_default_value - Default value for the item
agency_setting_type_can_edit - Can the item be edited.
agency_setting_type_setting_type - Type for the Item

Back to Index

agency_functions_agency_settings_list

Description:

List agency setting(s) on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null}

Info:

api_action - The name of the function

Reply Xml:

<?xml version="1.0"?>
<api>

 <agency_settings>
  <agency_setting>
   <agency_setting_id>   </agency_setting_id>

   <agency_setting_type_id>   </agency_setting_type_id>

   <agency_setting_value>   </agency_setting_value>
  </agency_setting>
 </agency_settings>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"error_description":null,"status":null,"agency_settings":{"agency_setting":{"agency_setting_type_id":null,"agency_setting_value":null,"agency_setting_id":null}},"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
agency_settings - container for all items
agency_setting - container for each item
agency_setting_id - ID of the setting
agency_setting_type_id - ID of the setting type
agency_setting_value - Value of the setting

Back to Index

agency_functions_agency_settings_edit

Description:

Edit an agency setting on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <agency_setting_id>  </agency_setting_id>

  <agency_setting_value>  </agency_setting_value>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"agency_setting_id":null,"agency_setting_value":null}}

Info:

api_action - The name of the function
agency_setting_id - ID of the Item to edit
agency_setting_value - The new value

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"error_description":null,"status":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

user_category_functions_user_category_types_list

Description:

List user category type(s) on the system

Sent Xml:

<?xml version="1.0"?>
<api>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null}

Info:

api_action - The name of the function

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <user_category_types>
  <user_category_type>
   <user_category_type_id>   </user_category_type_id>

   <user_category_type_value>   </user_category_type_value>
  </user_category_type>
 </user_category_types>
</api>

Reply Json:

{"user_category_types":{"user_category_type":{"user_category_type_id":null,"user_category_type_value":null}},"message_level":null,"status":null,"error_description":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
user_category_types - container for all items
user_category_type - container for each item
user_category_type_id - ID of the item
user_category_type_value - Value for the item

Back to Index

user_category_functions_user_category_list

Description:

List user category(s) on the system

Sent Xml:

<?xml version="1.0"?>
<api>

 <api_action> </api_action>

 <api_content>
  <session_id>  </session_id>
 </api_content>
</api>

Sent Json:

{"api_content":{"session_id":null},"api_action":null}

Info:

api_action - The name of the function
api_content - container for all incomming data
session_id - The Session ID for the user

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <user_categories>
  <user_category>
   <user_category_hourly_cost>   </user_category_hourly_cost>

   <user_category_id>   </user_category_id>

   <user_category_types_id>   </user_category_types_id>
  </user_category>
 </user_categories>
</api>

Reply Json:

{"message_level":null,"status":null,"user_categories":{"user_category":{"user_category_types_id":null,"user_category_hourly_cost":null,"user_category_id":null}},"error_description":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
user_categories - Container for all items
user_category - Container for each item
user_category_id - ID of the item
user_category_types_id - The ID of the category type
user_category_hourly_cost- The hourly cost for the user

Back to Index

user_functions_get_agency_from_domain

Description:

Get Agency from Domain

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <domain>  </domain>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"domain":null}}

Info:

api_action - The name of the function
domain - the url of the domain

Reply Xml:

<?xml version="1.0"?>
<api>

 <agency_id> </agency_id>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"message_level":null,"agency_id":null,"status":null,"error_description":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
agency_id - the ID of the agency

Back to Index

user_functions_login

Description:

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <agency_id>  </agency_id>

  <password>  </password>

  <username>  </username>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"agency_id":null,"password":null,"username":null}}

Info:

api_action - The name of the function
agency_id - the ID for the agency to log in under
username - username of the user
password - password for the user

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <session_id> </session_id>

 <status> </status>

 <user_type_id> </user_type_id>
</api>

Reply Json:

{"message_level":null,"user_type_id":null,"status":null,"error_description":null,"session_id":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
session_id - the ID of the session
user_type_id - ID of the user type

Back to Index

user_functions_validate_session

Description:

Validate a Session ID

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <session_id>  </session_id>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"session_id":null}}

Info:

api_action - The name of the function
session_id - The Session_id to validate

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"status":null,"error_description":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

user_functions_logout

Description:

Log a user out

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <session_id>  </session_id>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"session_id":null}}

Info:

api_action - The name of the function
session_id - the session_id to destroy

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"error_description":null,"status":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

user_functions_user_type_list

Description:

List user_type(s) on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null}

Info:

api_action - The name of the function

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <user_types>
  <user_type>
   <user_type_id>   </user_type_id>

   <user_type_level>   </user_type_level>

   <user_type_value>   </user_type_value>
  </user_type>
 </user_types>
</api>

Reply Json:

{"message_level":null,"error_description":null,"user_types":{"user_type":{"user_type_level":null,"user_type_id":null,"user_type_value":null}},"status":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
user_types - container for all user types
user_type - container for each user type
user_type_id - ID for the user type
user_type_value - Description of the user type
user_type_level - User type Level

Back to Index

user_functions_agency_user_list

Description:

List all users of a type for a agency on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <agency_users>  </agency_users>

  <client_users>  </client_users>

  <event_staff_users>  </event_staff_users>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"action_content":{"client_users":null,"agency_users":null,"event_staff_users":null},"api_action":null}

Info:

api_action - The name of the function
action_content - container for all parameters
agency_users - return only agency_users
client_users - return only client_users
event_staff_users - return only even staff users

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <users>
  <user>
   <user_active>   </user_active>

   <user_dbdate_activated>   </user_dbdate_activated>

   <user_dbdate_added>   </user_dbdate_added>

   <user_id>   </user_id>

   <user_type_id>   </user_type_id>

   <user_username>   </user_username>
  </user>
 </users>
</api>

Reply Json:

{"message_level":null,"users":{"user":{"user_username":null,"user_active":null,"user_dbdate_activated":null,"user_type_id":null,"user_dbdate_added":null,"user_id":null}},"status":null,"error_description":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
users - container for all items
user - container for each item
user_id - ID of the user
user_type_id - ID of the user type
user_username - username of the user
user_active - Is the user active
user_dbdate_added - when the user was added
user_dbdate_activated - when ther user was activated

Back to Index

user_notification_functions_user_notification_list

Description:

List user notification(s) on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <session_id>  </session_id>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"action_content":{"session_id":null},"api_action":null}

Info:

api_action - The name of the function
session_id - ID of the session

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <user_notifications>
  <user_notification>
   <user_notification_dbdate>   </user_notification_dbdate>

   <user_notification_id>   </user_notification_id>

   <user_notification_shown>   </user_notification_shown>

   <user_notification_value>   </user_notification_value>
  </user_notification>
 </user_notifications>
</api>

Reply Json:

{"message_level":null,"user_notifications":{"user_notification":{"user_notification_dbdate":null,"user_notification_shown":null,"user_notification_id":null,"user_notification_value":null}},"status":null,"error_description":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
user_notifications - container for all items
user_notification - container for each item
user_notification_id - ID of the item
user_notification_value - Message of the notification
user_notification_dbdate - Date the notification was created
user_notification_shown - has this message been shown before

Back to Index

user_notification_functions_user_notification_edit

Description:

Edit an user notification on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <user_notification_id>  </user_notification_id>

  <user_notification_shown>  </user_notification_shown>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"user_notification_shown":null,"user_notification_id":null}}

Info:

api_action - The name of the function
user_notification_id - ID of the Item to edit
user_notification_shown - HAs the item been shown

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"error_description":null,"status":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

user_notification_functions_user_notification_delete

Description:

Delete an user notification on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <user_notification_id>  </user_notification_id>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"action_content":{"user_notification_id":null},"api_action":null}

Info:

api_action - The name of the function
user_notification_id - ID of the Item to edit

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"message_level":null,"status":null,"error_description":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

user_profile_functions_user_profile_types_list

Description:

List user profile type(s) on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null}

Info:

api_action - The name of the function

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <user_profile_types>
  <user_profile_type>
   <user_profile_type_can_edit>   </user_profile_type_can_edit>

   <user_profile_type_default_value>   </user_profile_type_default_value>

   <user_profile_type_desc>   </user_profile_type_desc>

   <user_profile_type_id>   </user_profile_type_id>

   <user_profile_type_type>   </user_profile_type_type>

   <user_type_id>   </user_type_id>
  </user_profile_type>
 </user_profile_types>
</api>

Reply Json:

{"user_profile_types":{"user_profile_type":{"user_profile_type_desc":null,"user_profile_type_default_value":null,"user_profile_type_type":null,"user_profile_type_can_edit":null,"user_type_id":null,"user_profile_type_id":null}},"message_level":null,"error_description":null,"status":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
user_profile_types - container for all items
user_profile_type - continer for each item
user_profile_type_id - ID of the item
user_type_id - ID of the user type
user_profile_type_desc - description of the item
user_profile_type_default_value - Default value for the item
user_profile_type_can_edit - Can the Item be edited
user_profile_type_type - Type of item

Back to Index

user_profile_functions_user_profile_list

Description:

List user profile(s) on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <session_id>  </session_id>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"action_content":{"session_id":null},"api_action":null}

Info:

api_action - The name of the function
session_id - ID of the session

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>

 <user_profiles>
  <user_profile>
   <user_profile_id>   </user_profile_id>

   <user_profile_type_id>   </user_profile_type_id>

   <user_profile_value>   </user_profile_value>
  </user_profile>
 </user_profiles>
</api>

Reply Json:

{"status":null,"error_description":null,"message_level":null,"user_profiles":{"user_profile":{"user_profile_value":null,"user_profile_type_id":null,"user_profile_id":null}}}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical
user_profiles - container for all items
user_profile - continer for each item
user_profile_id - ID of the item
user_profile_type_id - ID of the profile type
user_profile_value - Value of the Item

Back to Index

user_profile_functions_user_profile_edit

Description:

Edit an user profile on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <user_profile_id>  </user_profile_id>

  <user_profile_value>  </user_profile_value>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"api_action":null,"action_content":{"user_profile_id":null,"user_profile_value":null}}

Info:

api_action - The name of the function
user_profile_id - ID of the Item to edit
user_profile_value - The new value

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"status":null,"error_description":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

user_profile_functions_user_profile_add

Description:

Add an user profile item on the ssystem

Sent Xml:

<?xml version="1.0"?>
<api>

 <action_content>
  <user_profile_type_id>  </user_profile_type_id>

  <user_profile_value>  </user_profile_value>
 </action_content>

 <api_action> </api_action>
</api>

Sent Json:

{"action_content":{"user_profile_value":null,"user_profile_type_id":null},"api_action":null}

Info:

api_action - The name of the function
user_profile_type_id - ID of the profile type to add
user_profile_value - The new value

Reply Xml:

<?xml version="1.0"?>
<api>

 <error_description> </error_description>

 <message_level> </message_level>

 <status> </status>
</api>

Reply Json:

{"status":null,"error_description":null,"message_level":null}

Info:

status - Status of the Call (True=Success/False=Faiure)
error_description - Error description if any
message_level - The message level, warning or critical

Back to Index

Author	Version	Date	Description
Danie van der Walt	0.1	Tue 21 July 2015	Initial API Created

Revision History:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml:

Sent Json:

Info:

Reply Xml:

Reply Json:

Info:

Description:

Sent Xml: