System Information

This chapter describes the methods that can be used to get information about the activeCollab installation you are communicating with. These are contained in class ActiveCollab. Methods can be called directly (as static methods) or through an object.

Description:

array getVersion( void ) - Return API Version

Return Value:

Array containing the information about API

Description:

array listProjects( void ) - List all Projects

Return Value:

Array containing the objects of Projects

Description:

array listProjectsGroups( void ) - List all available project groups

Return Value:

Array containing the objects of Project groups

Description:

array listTicketCategoriesByProjectId( int $project_id ) - List ticket categories in one project

Parameters:

project_id - id value of the project

Return Value:

Array containing the objects of Ticket categories

Description:

array listDiscussionCategoriesByProjectId( int $project_id ) - List discussion categories in one project

Parameters:

project_id - id value of the project

Return Value:

Array containing the objects of Discussion categories

Description:

array listFileCategoriesByProjectId( int $project_id ) - List file categories in one project

Parameters:

project_id - id value of the project

Return Value:

Array containing the objects of File categories

Description:

array listPageCategoriesByProjectId( int $project_id ) - List page categories in one project

Parameters:

project_id - id value of the project

Return Value:

Array containing the objects of Page categories

Description:

array listTicketsByCategoryId( int $project_id, int $category_id ) - List all tickets for a specific project and category

Parameters:

project_id - id value of the project category_id - id value of the category

Return Value:

Array of ActiveCollabTicket objects

Description:

array listFilesByCategoryId( int $project_id, int $category_id ) - List all files for a specific project and category

Parameters:

project_id - id value of the project category_id - id value of the category

Return Value:

Array of ActiveCollabFile objects

Description:

array listPagesByCategoryId( int $project_id, int $category_id ) - List all pages for a specific project and category

Parameters:

project_id - id value of the project category_id - id value of the category

Return Value:

Array of ActiveCollabPage objects

Description:

array listDiscussionsByCategoryId( int $project_id, int $category_id ) - List all discussions for a specific project and category

Parameters:

project_id - id value of the project category_id - id value of the category

Return Value:

Array of ActiveCollabDiscussion objects

Description:

array listSystemRoles( void ) - List all system roles

Return Value:

Array containing the system roles

Description:

array listProjectRoles( void ) - List all project roles

Return Value:

Array containing the project roles

Description:

array findRoleDetailsById( int $role_id ) - List role details

Parameters:

role_id - id of the role

Return Value:

Array containing the information about the role

Description:

array listCompanies( void ) - List all companies

Return Value:

Array of ActiveCollabCompany objects

Description:

array listStatusMessages( void ) - List all status messages

Return Value:

Array of ActiveCollabStatusMessage objects

Description:

array listStatusMessagesByUserId( int $user_id ) - List all status messages created by specific user

Parameters:

user_id - id of a user

Return Value:

Array of ActiveCollabStatusMessage objects

Description:

array listPeopleByProjectId( int $project_id ) - List all people involved with a project and their permissions

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabUser objects

Description:

array listTicketsByProjectId( int $project_id ) - List all tickets for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabTicket objects

Description:

array listArchivedTicketsByProjectId( int $project_id ) - List all archived tickets for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabTicket objects

Description:

array listFilesByProjectId( int $project_id ) - List all files for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabFile objects

Description:

array listDiscussionsByProjectId( int $project_id ) - List all discussions for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabDiscussion objects

Description:

array listMilestonesByProjectId( int $project_id ) - List all milestones for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabMilestone objects

Description:

array listChecklistsByProjectId( int $project_id ) - List all checklists for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabChecklist objects

Description:

array listArchivedChecklistsByProjectId( int $project_id ) - List all archived checklists for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabChecklists objects

Description:

array listTimeRecordsByProjectId( int $project_id ) - List all time records for a specific project

Parameters:

project_id - id of a project

Return Value:

Array of ActiveCollabTime objects