Difference between revisions of "Pandora Functions Descriptions"
From SmartWiki
Michael Reid (talk | contribs) |
|||
| Line 2: | Line 2: | ||
Pandora functions are are divided into a number of types. | Pandora functions are are divided into a number of types. | ||
| + | |||
| + | '''General System Functions''' | ||
| + | |||
| + | These functions are general to the entire instance. | ||
| + | {| border="1" | ||
| + | !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 Message (Add) ||Enables sending a massage (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''' | ||
| + | {| border="1" | ||
| + | !Function | ||
| + | !Description | ||
| + | |- | ||
| + | |UTA - Level One Item (All) ||Enables access to Level 1 items I UTAs. | ||
| + | |- | ||
| + | |UTA - Level Two Item (All)||Enables access to Level 2 items I UTAs. | ||
| + | |- | ||
| + | |UTA - Level Three Item (All) || Enables access to Level 3 items I UTAs. | ||
| + | |- | ||
| + | |UTA - Invoices (All) ||Enables access to UTA invoices (invoice item and invoice line item). | ||
| + | |- | ||
| + | |UTA - Level One Skills (Find,Update) ||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. | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
* Session Level Functions – these functions are used to manage the session associated with the processing being performed. | * 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. | * Information Finding Functions – these functions are used to retrieve multi-record recordsets based on provided criteria. | ||
Revision as of 11:32, 12 July 2010
Function Overview
Pandora functions are are divided into a number of types.
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 Message (Add) | Enables sending a massage (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 |
|---|---|
| UTA - Level One Item (All) | Enables access to Level 1 items I UTAs. |
| UTA - Level Two Item (All) | Enables access to Level 2 items I UTAs. |
| UTA - Level Three Item (All) | Enables access to Level 3 items I UTAs. |
| UTA - Invoices (All) | Enables access to UTA invoices (invoice item and invoice line item). |
| UTA - Level One Skills (Find,Update) | 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. |
- 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 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.
