Smartstaff
1,385
edits
Changes
no edit summary
Visit the '''[https://api.smartsimple.com/devtools/api.html interactive demonstration page]''' to test the sample functions.
===GetMetadata===This function will retrieve all fields from the the metadata of the selected '''Field ListObject Type''' of . ====Get Metadata of a single record based on the Universal Tracking Application===='''Function Name''' - 3.04.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />'''recordidDescription''' - To retrieve metadata of an a [[Category:Universal_Tracking_Application|Universal Tracking Application]].<br />'''Object Type''' - Case Management 360° - Case<br />'''Action Type ''' - Get Meta<br />'''Field List''' - levelone.*;;leveltwo.*;;levelthree.*<br />
[[File:APIFunctionSample1APIFunctionSample5l.PNG|800px]]
====Retrieve a Single Contact RecordGet Metadata of Organizations====<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->'''Function Name''' - 3.0104.2 Get Method Metadata Sample 2: Retrieve a Single Contact RecordOrganizations Metadata<br />'''Description''' - This function will To retrieve a single record metadata from the user table using the [[Determining_the_userid|User ID]]Organizations.<br />'''Object Type''' - Company<br />'''Action Type ''' - Get Meta<br />'''Field List''' - companies. The function is set up *<br />No parameters are needed to retrieve the fields listed under metadata.<br /> Available in November 2018 Upgrade====Get Metadata from Contacts====<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->'''Field ListFunction Name''' - 3.04.3 Get Metadata Sample 3: Users Metadata<br />'''Description''' - To retrieve metadata from Users.<br />
'''Object Type''' - User<br />
'''Action Type ''' - GetMeta<br />'''Field List''' - sf_User ID;;sf_Last Name;;sf_First Name;;sf_Prefix;;sf_Suffix;;sf_Title;;sf_Phone;;sf_Email [[File:APIFunctionSample2.PNG|800px]] ====Retrieve a Single Grant Application Record===='''Function Name''' - 3 contacts.01.3 Get Method Sample 3: Retrieve a Single Grant Application Record*<br />'''Description''' - This function will No parameters are needed to retrieve a single record from the [[Universal Tracking Application]] Level 1 using the [[Determining_the_opportunityid|Opportunity ID]]metadata.<br />'''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 [[File:APIFunctionSample3.PNG|800px]] ====Retrieve a Single Grant Application Payment Record===='''Function Name''' - 3.01.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 />'''Action Type ''' - Get<br />'''Field List''' - sf_Status;;sf_Activity Type;;cf_Payment ID;;cf_Payment Amount;;cf_Payment Date;;Payment Notes [[File:APIFunctionSample4.PNG|800px]] ====Get System Variables=========Retrieve a System Variable Record====='''Function Name''' - 3.01.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 />'''Action Type ''' - Get<br />'''Field List''' - sf_ID;;sf_Name;;sf_Value;; --Begin custom parameter --<br />recordid: 3601<br />--End custom parameter-- [[File:APIFunctionSystemVariables2.PNG|800px]] ====Get Transaction Record=========Retrieve a Single Transaction Record====='''Function Name''' - 3.01.6.1 Get Transaction Records<br />'''Description''' - <br />'''Object Type''' - <br />'''Action Type ''' - Get<br />'''Field List''' - Available in November 2018 Upgrade
===Report===
[[File:APIFunctionReport5.PNG|800px]]
===Get===
This function will retrieve all fields from the '''Field List''' of a single record based on the '''recordid''' of an '''Object Type'''.
====Retrieve a Single Organization Record====
'''Function Name''' - 3.01.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 />
'''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
[[File:APIFunctionSample1.PNG|800px]]
====Retrieve a Single Contact Record====
'''Function Name''' - 3.01.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 />
'''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
[[File:APIFunctionSample2.PNG|800px]]
====Retrieve a Single Grant Application Record====
'''Function Name''' - 3.01.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 />
'''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
[[File:APIFunctionSample3.PNG|800px]]
====Retrieve a Single Grant Application Payment Record====
'''Function Name''' - 3.01.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 />
'''Action Type ''' - Get<br />
'''Field List''' - sf_Status;;sf_Activity Type;;cf_Payment ID;;cf_Payment Amount;;cf_Payment Date;;Payment Notes
[[File:APIFunctionSample4.PNG|800px]]
====Get System Variables====
=====Retrieve a System Variable Record=====
'''Function Name''' - 3.01.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 />
'''Action Type ''' - Get<br />
'''Field List''' - sf_ID;;sf_Name;;sf_Value;;
--Begin custom parameter --<br />
recordid: 3601<br />
--End custom parameter--
[[File:APIFunctionSystemVariables2.PNG|800px]]
====Get Transaction Record====
=====Retrieve a Single Transaction Record=====
'''Function Name''' - 3.01.6.1 Get Transaction Records<br />
'''Description''' - <br />
'''Object Type''' - <br />
'''Action Type ''' - Get<br />
'''Field List''' -
===List===
=====Retrieve a list of organizations=====
'''Function Name''' - 3.03.2 List Method Sample 2: Retrieve a list of Organizations<br />
'''Description''' - To retrieve a list of organizations. <br />
'''Object Type''' - Company<br />
'''Action Type ''' - List<br />
'''Object Type''' - <br />
'''Action Type ''' -<br />
'''Field List''' - ===Metadata===This function will retrieve the metadata of the selected '''Object Type'''. ====Get Metadata of a Universal Tracking Application===='''Function Name''' - 3.04.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 />'''Action Type ''' - Get Meta<br />'''Field List''' - levelone.*;;leveltwo.*;;levelthree.*<br /> No parameters are needed to retrieve metadata.<br /> [[File:APIFunctionSample5l.PNG|800px]]
===Update===
This function will create new records or update existing records based on the selected '''Object Type'''.
'''Object Type''' - <br />
'''Action Type ''' -<br />
'''Field List''' -
===Download File===