118
edits
Changes
no edit summary
* Utility functions – these functions provide additional general functionality to the API.
==='''General System 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.
{| border="1"
!Function
|-
|[[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 - Retrieve Current User’s Organisational 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 - {|[[Pandora - Send a Message|send_msg(flag,callbackfunc,msgtype,format,fromadd,touserid,cc,subject,body)]] ||Enables sending a message (email or quick message).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 a Contact/User|contact_find(flag,callbackfunc,fields,filter,order,start,end,prefix)]] ||Enables contact search functions can retrieve all contacts.
|-
|[[Pandora - Loading VariablesLocate a UTA Level 1 Entity|variables_replacelevelone_find(flag,callbackfunctioncallbackfunc,40appid,useridfields,variablefilter,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)]]||Obtains Enables access to Level 2 items.|-|[[System VariablesPandora - Locate a UTA Level 3 Entity|level23_find(flag,callbackfunc,appid,level,fields,filter,order,start,end,prefix)]] or other values|| 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 Recordset Retrieval Functions'''===
{| border="1"
!Function
!Description
|-
|[[Pandora - Locate Create a UTA Level 1 EntityContact Recordset (HTML)|levelone_findcontact_list(flag,callbackfunc,appid,fields,filter,html,order,start,end,prefixcfidused)|| Enables creation of a contact recordset.|-|[[Pandora - Returns All Webforms Recordset|webform_list(flag/callbackfunc,actionname,formid,scoreid,filter,order)]] ||Enables access to Level 1 itemsreturn of all webforms recordset.
|-
|[[Pandora - Locate a UTA Level 2 EntityCreate an Organisation Recordset (HTML)|level23_findcompany_list(flag,callbackfunc,appid,level,fields,filter,html,order,start,end,prefixcfidused)]]||Enables access to Level 2 itemsreturn of an organisation recordset. {| border="1"!Function!Description
|-
|[[Pandora - Locate Send a UTA Level 3 EntityMessage|level23_findsend_msg(flag,callbackfunc,appidmsgtype,levelformat,fieldsfromadd,filtertouserid,ordercc,startsubject,end,prefixbody)]]|| Enables access to Level 3 items I UTAssending a message (email or quick message).
|-
|[[Pandora - Locate a UTA Invoice EntityLoading Variables|invoiceitem_findvariables_replace(flag,callbackfunc,appid,invoiceidcallbackfunction,fields40,filteruserid,order,start,end,prefixvariable)]] ||Enables access to Obtains [[System Variables]] or other values.|} ==='''UTA invoices (invoice item and invoice line item).Functions'''==={| border="1"!Function!Description
|-
|[[Pandora - Locate a UTA Level 1 Skill|leveloneskills_update(flag,callbackfunc,objectid,rs)]] ||Enables access to Level 1 skills.
