Difference between revisions of "Pandora Functions Descriptions"

From SmartWiki
Jump to: navigation, search
Line 29: Line 29:
 
|}
 
|}
  
==='''UTA Specific Functions'''===
+
==='''UTA Functions'''===
 
{| border="1"
 
{| border="1"
 
!Function
 
!Function
Line 43: Line 43:
 
|-
 
|-
 
|[[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.
 +
|}
 +
 +
==='''Transaction Functions'''===
 +
{| border="1"
 +
!Function
 +
!Description
 +
|-
 +
|[[Pandora - Update Transaction Intersection to Level 1 Entity|translink_add(flag ,callbackfunc,translinkid,transid,objectid,linktype,recordset)]]||Updates intersection table between Transactions and Level 1 items.
 
|}
 
|}
  

Revision as of 14:39, 5 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.

General System Functions

These functions are general to the entire instance.

Function Description
Session_Login (Find) Enables Login to the instance.
Session_getCurrentUser (Find) Enables retrieving the current user information.
Session_getCurrentCompany (Find) Enables retrieving the current user’s organisational information.
send_msg(flag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body) Enables sending a message (email or quick message).
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.

UTA Functions

Function Description
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.
invoiceitem_find(flag,callbackfunc,appid,invoiceid,fields,filter,order,start,end,prefix) Enables access to UTA invoices (invoice item and invoice line item).
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.