Changes

Jump to: navigation, search

Creating SmartConnect Functions

7 bytes removed, 20:49, 12 September 2018
no edit summary
====Get Metadata of a Universal Tracking Application====
'''Function Name'''  -  3.0401.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />
'''Description'''  - To retrieve metadata of a [[Category:Universal_Tracking_Application|Universal Tracking Application]].<br />
'''Object Type'''  -  Case Management 360° - Case<br />
====Get Metadata of Organizations====
<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->
'''Function Name'''  -  3.0401.2 Get Metadata Sample 2: Organizations Metadata<br />
'''Description'''  - To retrieve metadata from Organizations.<br />
'''Object Type'''  -  Company<br />
====Get Metadata from Contacts====
<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->
'''Function Name'''  -  3.0401.3 Get Metadata Sample 3: Users Metadata<br />
'''Description'''  - To retrieve metadata from Users.<br />
'''Object Type'''  -  User<br />
No parameters are needed to retrieve metadata.<br />
Available in November 2018 Upgrade
 
===Report===
This function will retrieve the results of the query from an existing report by using the [[Determining_the_reportid|'''reportid''']].
====Retrieve a Single Organization Record====
'''Function Name'''  -  3.0103.1 Get Method Sample 1: Retrieve a Single Organization Record<br />
'''Description'''  - This function will retrieve a single record from the organization using the recordid: [[Determining_the_companyid|Company ID]]. The function is set up to retrieve the fields listed under '''Field List'''.<br />
'''Object Type'''  -  Company<br />
====Retrieve a Single Contact Record====
'''Function Name'''  -  3.0103.2 Get Method Sample 2: Retrieve a Single Contact Record<br />
'''Description'''  - This function will retrieve a single record from the user table using the [[Determining_the_userid|User ID]]. The function is set up to retrieve the fields listed under '''Field List'''.<br />
'''Object Type'''  -  User<br />
====Retrieve a Single Grant Application Record====
'''Function Name'''  -  3.0103.3 Get Method Sample 3: Retrieve a Single Grant Application Record<br />
'''Description'''  - This function will retrieve a single record from the [[Universal Tracking Application]] Level 1 using the [[Determining_the_opportunityid|Opportunity ID]].<br />
'''Object Type'''  -  Submission Manager - Grant<br />
====Retrieve a Single Grant Application Payment Record====
'''Function Name'''  -  3.0103.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record<br />
'''Description'''  - This function will retrieve a single record from the [[Universal Tracking Application]] Level 2 using the [[Determining_the_eventid|Event ID]].<br />
'''Object Type'''  -  Submission Manager - Activity<br />
====Get System Variables====
=====Retrieve a System Variable Record=====
'''Function Name'''  -  3.0103.5.1 System Variables Sample 1: Get<br />
'''Description'''  - Get information on the [[System_Variables|system variables]] by searching the System Variable ID<br />
'''Object Type'''  -  System Variables<br />
====Get Transaction Record====
=====Retrieve a Single Transaction Record=====
'''Function Name'''  -  3.0103.6.1 Get Transaction Records<br />
'''Description'''  - <br />
'''Object Type'''  - <br />
=====Retrieve a list of contacts=====
'''Function Name'''  -  3.0304.1 List Method Sample 1: Retrieve a list of Contacts<br />
'''Description'''  - This function will retrieve a list of contacts based on criteria specified.<br />
'''Object Type'''  -  User<br />
=====Retrieve a list of organizations=====
'''Function Name'''  -  3.0304.2 List Method Sample 2: Retrieve a list of Organizations<br />
'''Description'''  - To retrieve a list of organizations.<br />
'''Object Type'''  -  Company<br />
=====Retrieve a list of claims=====
'''Function Name'''  -  3.0304.3 List Method Sample 3: CMS360° - Retrieve a list of claims<br />
'''Description'''  - To retrieve a list of claims by professors sorted by organization name in descending order.<br />
'''Object Type'''  -  Cast Management 360° - Case<br />
====List File====
=====List files of an existing organization=====
'''Function Name'''  -  3.0304.4.1 List Files Method Sample 1: from an existing organization<br />
'''Description'''  - To retrieve the list of file(s) from the organization using the [[Determining_the_companyid|Company ID]]<br />
'''Object Type'''  -  Company<br />
=====List files from an existing application=====
'''Function Name'''  -  3.0304.4.2 List Files Method Sample 2: from an existing application<br />
'''Description'''  - To retrieve the list of file(s) of an existing application using the [[Determining_the_opportunityid|Opportunity ID]]<br />
'''Object Type'''  -  Submission Manager - Grant<br />
====List Notes====
=====List notes from an existing application=====
'''Function Name'''  -  3.0304.5.1 List Notes Method Sample 1: from an existing application<br />
'''Description'''  - To retrieve all note(s) associated with an existing application using the [[Determining_the_opportunityid|Opportunity ID]]<br />
'''Object Type'''  -  Submission Manager - Grant<br />
====List Multiple Addresses====
=====List all Multiple Addresses of an existing Organization=====
'''Function Name'''  -  3.0304.6.1 List Multiple Addresses Method Sample 1: Multiple Addresses of an existing Organization<br />
'''Description'''  - To retrieve all of the multiple addresses of an existing organization using the [[Determining_the_companyid|Company ID]]<br />
'''Object Type'''  -  Company<br />
====List Associations====
=====List Contact associations from an existing application=====
'''Function Name'''  -  3.0304.7.1 List Associations Method Sample 1: Contact associations from an existing application<br />
'''Description'''  - To retrieve the list of contacts associated with an existing application using the [[Determining_the_opportunityid|Opportunity ID]]<br />
'''Object Type'''  -  Submission Manager - Grant<br />
=====List Organization associations from an application=====
'''Function Name'''  -  3.0304.7.2 List Associations Method Sample 2: Organization associations from an existing application<br />
'''Description'''  - To retrieve the list of organizations associated with an existing application using the [[Determining_the_opportunityid|Opportunity ID]]<br />
'''Object Type'''  -  Submission Manager - Grant<br />
====List System Variables====
=====List All System Variables=====
'''Function Name'''  -  3.0304.8.1 System Variables Sample 1: List<br />
'''Description'''  - Retrieves all the [[System_Variables|system variables]]<br />
'''Object Type'''  -  System Variables<br />
====List Transaction Records====
=====List All Transaction Records of an Object Type=====
'''Function Name'''  -  3.0304.9.1 List Transaction Record Sample<br />
'''Description'''  - <br />
'''Object Type'''  - <br />
'''Action Type '''  -<br />
'''Field List'''  -<br />
===Update===
Smartstaff
1,385
edits

Navigation menu