API:Centricity

From ExtractValue Wiki

The Centricity API houses functions related to the operation of every Superportal web portal.

Contents 1 Functions 1.1 Users / Login 1.2 Groups 1.3 Portal 1.4 Group Type 1.5 Performance 1.6 File 2 Category Tree

Functions

Users / Login

• CreateUser( string::email_address, string::password, string::first_name, string::last_name )

=> int User_ID

• Login( string::username, string::password, int::portal_id )

=> array( user_id, first_name, last_name, group_id, group_name )

• GetUserByID( int::user_id )

=> array( user_id, first_name, last_name, group_id, group_name )

Groups

• CreateGroup( integer::grouptype_id, string::group_name, contact_first_name, contact_last_name, phone_direct, email_address, originator_id, user_id )

=> int Group_ID

• All information are required, because of basic Group integrity

• AddMemeberToGroup( string::group_short_name, string:portal_id, integer:user_id, integer:permission_level )

=> integer Permission_level

• GetGroupByID( string::group_id )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetAllGroupsByShortName( string::short_name )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetGroupsByTypeAndName( string::grouptype, string::group_name )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetAllGroupsByOriginator( int::originator_id )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetGroupsByType( string::grouptype )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetAllGroupsByPortalID( string::portal_unique_id )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetAllGroupsByType( int::grouptype_id )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetAllGroupsByUser( int::user_id )

=> array( group_id, group_name, gruop.*, grouptype_id, grouptype )

• GetMemebersOfGroup( string::group_unique_id )

=> array( user_id, first_name, last_name, group_id, group_name )

• RemoveMemeberFromGroup( string::group_short_name, integer:user_id )

=> integer user_id

Portal

• CreatePortal( grouptype_id, name, url )

=> int Portal_ID

• GetAllPortalsByType( $grouptype_id )

=> array( grouptag_id, parent_id, parent_name, name )

• GetPortalByID( string::$portal_id )

=>array( grouptag_id, parent_id, parent_name, name )

• Modified to use unique id for security

Group Type

• GetAllGroupTypes()

Performance

• GetPerformanceByProductID( int::product_id )

=>array( Year => Month => Day => Hour => Minute => Second => Micro-second => Performance )

File

• CheckDuplicateFilename( type, creator, filename )

• UploadFile( credential, filename, creator, description, type, permission )

Category Tree