Difference between revisions of "Creating SmartConnect Functions"

From SmartWiki
Jump to: navigation, search
Line 4: Line 4:
 
You need to have [[Global User Administrator]] permissions in order to add JSON functions.
 
You need to have [[Global User Administrator]] permissions in order to add JSON functions.
  
−
1. Log into the copy of SmartSimple where you wish to add the function.<br data-attributes="%20/">
+
# Log into the copy of SmartSimple where you wish to add the function.
−
2. Navigate to '''Global Settings'''<br data-attributes="%20/">
+
# Navigate to '''Global Settings'''.
−
3. Click on the '''Integrations''' tab<br data-attributes="%20/">
+
# Click on the '''Integrations''' tab.
−
4. Click on the '''SmartConnect API''' link
+
# Click on the '''SmartConnect API''' link. Existing functions will be listed here for you to update.
−
 
+
# Click on the '''+''' button to create a new function.
−
: Any existing Functions are displayed
 
−
5. Click on the '''+''' button to create a new function.
 
  
 
==Function Settings==
 
==Function Settings==

Revision as of 08:43, 31 July 2018

SmartConnect functions are specific to individual copies of SmartSimple so you can only use the functions that are have been previously established in that copy. The article describes how you add functions to an instance.

Creating a New Function

You need to have Global User Administrator permissions in order to add JSON functions.

  1. Log into the copy of SmartSimple where you wish to add the function.
  2. Navigate to Global Settings.
  3. Click on the Integrations tab.
  4. Click on the SmartConnect API link. Existing functions will be listed here for you to update.
  5. Click on the + button to create a new function.

Function Settings

Each function has the following settings:

  • Function Name – you will use this name to call the function from your own code.
  • Description – used to provide documentation as to the function’s purpose.
  • 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, LIST, UPDATE, DOWNLOAD FILE, and LIST FILES. Details on these Action Types / Methods are available in the following section.
  • Field List – this restricts the fields that are to be retrieved from the underlying object.


SmartConnect Function Samples

Visit the interactive demonstration page to test the sample functions.

Function      Sample

'Get'
Get Company

 
      3.01.1 Get Method Sample 1: Retrieve a Single Organization Record
      3.01.2 Get Method Sample 2: Retrieve a Single Contact Record
      3.01.3 Get Method Sample 3: Retrieve a Single Grant Application Record
      3.01.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record
      3.01.5 Get Method Sample 5: List Files

'List'
List Level One

 
      3.02.1 List Method Sample 1: Retrieve a list of contacts
      3.02.2 List Method Sample 2: Retrieve a list of organizations
      3.02.3 List Method Sample 3: CMS360° - Retrieve a list of claims
      3.02.4 List Method Sample 4: CMS360°- Retrieve a list of Services
      3.02.5 List Method Sample 5: CMS360°- Retrieve Assessors list
      3.02.6 List Method Sample 6: CMS360°- Retrieve a List of Grants

'Update'
Update Company


      3.03.1 Update Method Sample 1: Create organizations
      3.03.2 Update Method Sample 2: Create/Update User

'Download File'
Download Files from Level One


      3.04.1 Download File Method Sample 1: Download file(s) from a company profile

'List File'
List Files from Level One


      3.05.1 List Files Method Sample 1:  from an organization
      3.05.2 List Files Method Sample 2: from an application

'Search File'
Search Files from Level One


      3.06.1 Search Files Method Sample 1: Search Case Documents 

'List Notes'
List Notes from a Company


      3.07.1 List Notes Method Sample 1:  from an application

'List Multiple Addresses'
Get all multiple addresses of a Company


      3.08.1 List Multiple Addresses Method Sample 1: Multiple Addresses of an Organization

'Update Multiple Addresses'
Update multiple addresses of a Company


      3.09.1 Update Multiple Addresses Method Sample 1: update addresses of an Organization

'List Associations'
List Contact Association of a Level 1


      3.10.1 List Associations Method Sample 1: Contact associations from an application
      3.10.2 List Associations Method Sample 2: Organization associations from an application

'Update Associations'
Update Contact Association of a Level 1


      3.11.1 Update Associations Method Sample 1: update contact associations of a Level 1
      

'Metadata'


      3.12.1 Get Metadata Sample 1: CMS360°: Application Metadata
      3.12.2 Get Metadata Sample 1: GMS360°: Application Metadata

'Report'


      3.13.1 Get Report Sample 1: CMS360°: Report - Assessor Count by Specialty
      3.13.2 Get Report Sample 2: GMS360°: Grants by Organization Report
      3.13.3 Get Report Sample 3: GMS360°: GMS360°: Grants by Focus Area Report
      3.13.4 Get Report Sample 4: GMS360°: GMS360°: Payments Made by Grant Type Report

See Also

SmartConnect - RESTful API
JSON API (SmartConnect) Standard Field Names


API Sample Code

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Creating_SmartConnect_Functions&oldid=32317’