Smartstaff
1,385
edits
Changes
no edit summary
* '''Record Type''' – a list of all SmartSimple objects within this instance. This will include: Report (reports you have created in the instance), Organization (company records), Users (system users and contacts), and each Universal Tracking Application™ Level 1, Level 2 and Level 3 type that you have created in the instance.
* '''Action Type''' – this defines the action to be taken by the function. The following actions are available: GET META, UPDATE META, GET, LIST, UPDATE, UPDATE ASSOCIATIONS, LIST ASSOCIATIONS, DOWNLOAD FILE, LIST FILES, SEARCH FILES, LIST NOTES and VARIABLE REPLACE. Details on these Action Types / Methods are available below.
* '''Field List''' – this restricts the fields that are to be retrieved from the underlying object.<br />
==SmartConnect Function Samples==
'''Object Type''' - Company<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_Company ID;;sf_Name;;sf_Address;;sf_City;;sf_Country;;sf_Zip / Postal Code;;cf_EIN Number;;sf_Mission Statement<br />
[[File:APIFunctionSample1.PNG|800px]]
'''Object Type''' - User<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_User ID;;sf_Last Name;;sf_First Name;;sf_Prefix;;sf_Suffix;;sf_Title;;sf_Phone;;sf_Email<br />
[[File:APIFunctionSample2.PNG|800px]]
'''Object Type''' - Submission Manager - Grant<br />
'''Action Type ''' - Get<br />
'''Field List''' - cf_Project Name;;cf_Submission Number;;sf_Application Type;;sf_Status;;sf_Customer;;sf_Owner;;cf_Focus Area;;cf_Amount Requested;;cf_Program Area;;cf_Location;;cf_Proposed Start Date;;cf_Proposed End Date<br />
[[File:APIFunctionSample3.PNG|800px]]
'''Object Type''' - Submission Manager - Activity<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_Status;;sf_Activity Type;;cf_Payment ID;;cf_Payment Amount;;cf_Payment Date;;Payment Notes<br />
[[File:APIFunctionSample4.PNG|800px]]
'''Object Type''' - Report<br />
'''Action Type ''' - Query<br />
'''Field List''' - <br />
=====A report query on the number of assessors grouped by specialty=====
reportid : 36864<br />
criteriavalue: <br />
--End custom parameter--<br />
=====A report query on a list of Grants grouped by Organization=====
reportid : 36812<br />
criteriavalue: <br />
--End custom parameter--<br />
=====A report query on a list of Grants grouped by Focus Area=====
reportid : 36814<br />
criteriavalue: <br />
--End custom parameter--<br />
=====A report query on a list of Payments grouped by Grant Type=====
reportid : 36806<br />
criteriavalue: <br />
--End custom parameter--<br />
===List===
'''Object Type''' - User<br />
'''Action Type ''' - List<br />
'''Field List''' - sf_User ID;;sf_First Name;;sf_Address;;sf_Address 2;;sf_City;;sf_Country;;sf_State / Province;;sf_Zip / Postal Code;;<br />
<u>'''Sample 1A'''</u><br/>
sortby : [{"field":"sf_First Name","direction":"asc"}]<br />
getstorevalue :<br />
--End custom parameter--<br />
[[File:APIFunctionSample5a.PNG|800px]]
sortby : [{"field":"sf_First Name","direction":"asc"}]<br />
getstorevalue :<br />
--End custom parameter--<br />
[[File:APIFunctionSample5b.PNG|800px]]
'''Object Type''' - Company<br />
'''Action Type ''' - List<br />
'''Field List''' - sf_Company ID;;sf_Name;;sf_Address;;sf_Address 2;;sf_City;;sf_Country;;sf_State / Province;;sf_Zip / Postal Code;;cf_Mission Statement<br />
<u>'''Sample 2A'''</u><br/>
'''Description''' - To retrieve a list of organizations with organization name that starts with "Br"<br />
[[File:APIFunctionSample5c.PNG|800px]]
<u>'''Sample 2B'''</u><br/>
'''Description''' - To retrieve a list of organizations with organization name that starts with "Br" and address that contains "Ave" with an ascending order based on the organization name.<br />
[[File:APIFunctionSample5d.PNG|800px]]
'''Object Type''' - Cast Management 360° - Case<br />
'''Action Type ''' - List<br />
'''Field List''' - sf_Application Template Type;;sf_Customer;;cf_Claim;;cf_Nature of Injury / Comments on Claim;;sf_Activity List<br />
[[File:APIFunctionSample5e.PNG|800px]]
'''Object Type''' - Company<br />
'''Action Type ''' - List Files<br />
'''Field List''' - <br />
Parameters used are:<br />
''objectid'' = [[Determining_the_companyid|Company ID]]<br />
[[File:APIFunctionSample5f.PNG|800px]]
'''Object Type''' - Submission Manager - Grant<br />
'''Action Type ''' - List Files<br />
'''Field List''' - <br />
Parameters used are:<br />
''objectid'' = [[Determining_the_opportunityid|Opportunity ID]]<br />
[[File:APIFunctionSample5g.PNG|800px]]
'''Object Type''' - Submission Manager - Grant<br />
'''Action Type ''' - List notes<br />
'''Field List''' - sf_Type Name;;sf_Content;;sf_Created By;;sf_Created By ID;;sf_Created Date;;sf_Note ID;;sf_Object ID;;sf_Type ID;;sf_Note Content<br />
Parameters used are:<br />
''objectid'' = [[Determining_the_opportunityid|Opportunity ID]]<br />
[[File:APIFunctionSample5h.PNG|800px]]
Parameters used are:<br />
''objectid'' = [[Determining_the_companyid|Company ID]]<br />
[[File:APIFunctionSample5i.PNG|800px]]
''recordid'' = [[Determining_the_opportunityid|Opportunity ID]]<br />
''type'' = either '"contacts"' or '"organizations"'<br />
recordid: 8276165<br />
type: contacts<br />
[[File:APIFunctionSample5j.PNG|800px]]
''recordid'' = [[Determining_the_opportunityid|Opportunity ID]]<br />
''type'' = either '"contacts"' or '"organizations"'<br />
recordid: 8276165<br />
type: organizations<br />
[[File:APIFunctionSample5k.PNG|800px]]