Pandora Functions Descriptions

Revision as of 13:39, 12 July 2010 by sharris@smartsimple.com (talk | contribs)

Contents

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 (All) Enables organisation search functions to retrieve all organisations.
Company Below (Find,Update) Enables organisation search functions to retrieve only organisations at the user’s hierarchical level and lower.
Contact (All) Enables contact search functions can retrieve all contacts.
Contact Below (Find,Update) Enables contact search functions to retrieve contacts at the user’s hierarchical level and lower

UTA Specific 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.
UTA - Use Level One Item Security Matrix (All) Enforces UTA security for Level 1 items.
UTA - Use Level Two Item Security Matrix (All) Enforces UTA security for Level 2 items.
UTA - Use Level Three Item Security Matrix (All) Enforces UTA security for Level 3 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.