Difference between revisions of "Pandora Functions Descriptions"

From SmartWiki
Jump to: navigation, search
Line 9: Line 9:
 
* Utility functions – these functions provide additional general functionality to the API.
 
* Utility functions – these functions provide additional general functionality to the API.
  
−
==='''General System Functions'''===
+
==='''Session Level Functions'''===
 +
 
 +
These functions are used to enable a valid session in which process can be performed and once created, determine user and related organization attributes.
 +
Unless a function is established, no functionality is available.
  
−
These functions are general to the entire instance.
 
 
{| border="1"
 
{| border="1"
 
!Function
 
!Function
Line 17: Line 19:
 
|-
 
|-
 
|[[Pandora - Log in a User|Session_Login (Find)]] ||Enables Login to the instance.
 
|[[Pandora - Log in a User|Session_Login (Find)]] ||Enables Login to the instance.
 +
|-
 +
|[[Pandora - Logout a User|session_logout(flag,callbackfunc)]]||Enables logout of the instance.
 +
|-
 +
|[[Pandora - Verify If a Session Exists|session_islogin(flag,callbackfunc)]] || Enables retrieving of active user information.
 
|-
 
|-
 
|[[Pandora - Current User’s Information|Session_getCurrentUser (Find)]] ||Enables retrieving the current user information.
 
|[[Pandora - Current User’s Information|Session_getCurrentUser (Find)]] ||Enables retrieving the current user information.
 
|-
 
|-
 
|[[Pandora - Retrieve Current User’s Organisational Information|Session_getCurrentCompany (Find)]] || Enables retrieving the current user’s organisational information.
 
|[[Pandora - Retrieve Current User’s Organisational Information|Session_getCurrentCompany (Find)]] || Enables retrieving the current user’s organisational information.
−
|-
+
|}
−
|[[Pandora - Send a Message|send_msg(flag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body)]] ||Enables sending a message (email or quick message).
+
 
 +
 
 +
===Information Finding Functions===
 +
 
 +
These functions return record sets containing multiple records based on the filter passed to the functions.
 +
Each of these functions uses the following parameters:
 +
 
 +
*Fields – the fields list to be retrieved and created in the recordset.  Notes an ID field will be prefixed onto the user specified field list providing the unique identifier for each record.
 +
*Filter – the criteria by which fields should be retrieved.
 +
*Order – the field list to control the sort sequence of the records set.
 +
*Start – the starting record to be returned.  The default is 0.
 +
*End – the end record to be returned.  The default is 200.
 +
*Pref -
 +
 
 +
{| border="1"
 +
!Function
 +
!Description
 
|-
 
|-
 
|[[Pandora - Locate an Organisation|company_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||Enables organisation search functions to retrieve all organisations.
 
|[[Pandora - Locate an Organisation|company_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||Enables organisation search functions to retrieve all organisations.
Line 28: Line 50:
 
|[[Pandora - Locate a Contact/User|contact_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||Enables contact search functions can retrieve all contacts.
 
|[[Pandora - Locate a Contact/User|contact_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||Enables contact search functions can retrieve all contacts.
 
|-
 
|-
−
|[[Pandora - Loading Variables|variables_replace(flag,callbackfunction,40,userid,variable)]]||Obtains [[System Variables]] or other values.
+
|[[Pandora - Locate a UTA Level 1 Entity|levelone_find(flag,callbackfunc,appid,fields,filter,order,start,end,prefix)]] ||Enables access to Level 1 items.
 +
|-
 +
|[[Pandora - Locate a UTA Level 2 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]]||Enables access to Level 2 items.
 +
|-
 +
|[[Pandora - Locate a UTA Level 3 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]]|| Enables access to Level 3 items I UTAs.
 +
|-
 +
|[[Pandora - Locate a UTA Invoice Entity|invoice_find(flag,callbackfunc,appid,fields,filter,order,start,end,prefix)]]||Enables access to UTA invoice entities.
 +
|-
 +
|[[Pandora - Locate a UTA Invoice Item|invoiceitem_find(flag,callbackfunc,appid,invoiceid, fields,filter,order,start,end,prefix)]]|| Enables access to UTA invoice items.
 +
|-
 +
|[[Pandora - Return a Record Set of Level 1 Skills|leveloneskills_find(flag,callbackfunc,objectid)]]|| Enables return of a record set of skills for Level 1 items.
 +
|-
 +
|[[Pandora - Return a Skill List from a Skill Category|skills_find(flag,callbackfunc,skilltypeid)]]|| Enables return of a record set of skill categories for Level 1 items.
 
|}
 
|}
  
−
==='''UTA Functions'''===
+
===Recordset Retrieval Functions===
 +
 
 
{| border="1"
 
{| border="1"
 
!Function
 
!Function
 
!Description
 
!Description
 
|-
 
|-
−
|[[Pandora - Locate a UTA Level 1 Entity|levelone_find(flag,callbackfunc,appid,fields,filter,order,start,end,prefix)]] ||Enables access to Level 1 items.
+
|[[Pandora - Create a Contact Recordset (HTML)|contact_list(flag,callbackfunc,fields,filter,html,order,start,end,cfidused)|| Enables creation of a contact recordset.
 +
|-
 +
|[[Pandora - Returns All Webforms Recordset|webform_list(flag/callbackfunc,actionname,formid,scoreid,filter,order)]]|| Enables return of all webforms recordset.
 
|-
 
|-
−
|[[Pandora - Locate a UTA Level 2 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]]||Enables access to Level 2 items.
+
|[[Pandora - Create an Organisation Recordset (HTML)|company_list(flag,callbackfunc,fields,filter,html,order,start,end,cfidused)]]|| Enables return of an organisation recordset.
 +
 
 +
 
 +
 
 +
 
 +
 
 +
{| border="1"
 +
!Function
 +
!Description
 
|-
 
|-
−
|[[Pandora - Locate a UTA Level 3 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]]|| Enables access to Level 3 items I UTAs.
+
|[[Pandora - Send a Message|send_msg(flag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body)]] ||Enables sending a message (email or quick message).
 
|-
 
|-
−
|[[Pandora - Locate a UTA Invoice Entity|invoiceitem_find(flag,callbackfunc,appid,invoiceid,fields,filter,order,start,end,prefix)]] ||Enables access to UTA invoices (invoice item and invoice line item).
+
|[[Pandora - Loading Variables|variables_replace(flag,callbackfunction,40,userid,variable)]]||Obtains [[System Variables]] or other values.
 +
|}
 +
 
 +
==='''UTA Functions'''===
 +
{| border="1"
 +
!Function
 +
!Description
 
|-
 
|-
 
|[[Pandora - Locate a UTA Level 1 Skill|leveloneskills_update(flag,callbackfunc,objectid,rs)]] ||Enables access to Level 1 skills.
 
|[[Pandora - Locate a UTA Level 1 Skill|leveloneskills_update(flag,callbackfunc,objectid,rs)]] ||Enables access to Level 1 skills.

Revision as of 10:53, 6 August 2010

Function Overview

Pandora functions are are divided into a number of types.

  • Session Level Functions – these functions are used to manage the session associated with the processing being performed.
  • Information Finding Functions – these functions are used to retrieve multi-record recordsets based on provided criteria.
  • List functions
  • Update Functions – these functions are used to create new entities within the system.
  • Utility functions – these functions provide additional general functionality to the API.

Session Level Functions

These functions are used to enable a valid session in which process can be performed and once created, determine user and related organization attributes. Unless a function is established, no functionality is available.

Function Description
Session_Login (Find) Enables Login to the instance.
session_logout(flag,callbackfunc) Enables logout of the instance.
session_islogin(flag,callbackfunc) Enables retrieving of active user information.
Session_getCurrentUser (Find) Enables retrieving the current user information.
Session_getCurrentCompany (Find) Enables retrieving the current user’s organisational information.


Information Finding Functions

These functions return record sets containing multiple records based on the filter passed to the functions. Each of these functions uses the following parameters:

  • Fields – the fields list to be retrieved and created in the recordset. Notes an ID field will be prefixed onto the user specified field list providing the unique identifier for each record.
  • Filter – the criteria by which fields should be retrieved.
  • Order – the field list to control the sort sequence of the records set.
  • Start – the starting record to be returned. The default is 0.
  • End – the end record to be returned. The default is 200.
  • Pref -
Function Description
company_find(flag,callbackfunc,fields,filter,order,start,end,prefix) Enables organisation search functions to retrieve all organisations.
contact_find(flag,callbackfunc,fields,filter,order,start,end,prefix) Enables contact search functions can retrieve all contacts.
levelone_find(flag,callbackfunc,appid,fields,filter,order,start,end,prefix) Enables access to Level 1 items.
level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix) Enables access to Level 2 items.
level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix) Enables access to Level 3 items I UTAs.
invoice_find(flag,callbackfunc,appid,fields,filter,order,start,end,prefix) Enables access to UTA invoice entities.
invoiceitem_find(flag,callbackfunc,appid,invoiceid, fields,filter,order,start,end,prefix) Enables access to UTA invoice items.
leveloneskills_find(flag,callbackfunc,objectid) Enables return of a record set of skills for Level 1 items.
skills_find(flag,callbackfunc,skilltypeid) Enables return of a record set of skill categories for Level 1 items.

Recordset Retrieval Functions

Function Description
[[Pandora - Create a Contact Recordset (HTML)|contact_list(flag,callbackfunc,fields,filter,html,order,start,end,cfidused) Enables creation of a contact recordset.
webform_list(flag/callbackfunc,actionname,formid,scoreid,filter,order) Enables return of all webforms recordset.
company_list(flag,callbackfunc,fields,filter,html,order,start,end,cfidused) Enables return of an organisation recordset.



Function Description
send_msg(flag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body) Enables sending a message (email or quick message).
variables_replace(flag,callbackfunction,40,userid,variable) Obtains System Variables or other values.

UTA Functions

Function Description
leveloneskills_update(flag,callbackfunc,objectid,rs) Enables access to Level 1 skills.

Transaction Functions

Function Description
translink_add(flag ,callbackfunc,translinkid,transid,objectid,linktype,recordset) Updates intersection table between Transactions and Level 1 items.

General Guidelines

The following guides are common to all function calls.

Field Referencing

  • Standard fields are referenced by name. ,’firstname,lastname’.
  • Custom fields by filename (recommended) or field ID.
  • Fields specified = recordset fields.
  • First field always ID.
  • Standard fields when field list empty.
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Pandora_Functions_Descriptions&oldid=10345’