Difference between revisions of "Creating SmartConnect Functions"

From SmartWiki
Jump to: navigation, search
(→‎SmartConnect Function Samples)
(→‎SmartConnect Function Samples)
Line 31: Line 31:
 
==='Get'===
 
==='Get'===
 
||
 
||
−
01.1 Get Method Sample 1: Retrieve a Single Organization Record<br />01.2 Get Method Sample 2: Retrieve a Single Contact Record<br />01.3 Get Method Sample 3: Retrieve a Single Grant Application Record<br />01.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record<br />01.5 Get Method Sample 5: List Files
+
01.1 Get Method Sample 1: Retrieve a Single Organization Record<br />
 +
01.2 Get Method Sample 2: Retrieve a Single Contact Record<br />
 +
01.3 Get Method Sample 3: Retrieve a Single Grant Application Record<br />
 +
01.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record<br />
 +
01.5 Get Method Sample 5: List Files
  
 
|-
 
|-
Line 37: Line 41:
 
==='List'===
 
==='List'===
 
||
 
||
−
[[Image:ListSample.PNG|thumb|right|851x230px|<strong>List Level One</strong>]]
+
02.1 List Method Sample 1: Retrieve a list of contacts<br />
−
<span style="color: #247859;"> </span><br />
+
02.2 List Method Sample 2: Retrieve a list of organizations<br />
−
<span style="color: #247859;">      3.02.1 List Method Sample 1: Retrieve a list of contacts</span><br />
+
02.3 List Method Sample 3: CMS360° - Retrieve a list of claims<br />
−
<span style="color: #247859;">      3.02.2 List Method Sample 2: Retrieve a list of organizations</span><br />
+
02.4 List Method Sample 4: CMS360°- Retrieve a list of Services<br />
−
<span style="color: #247859;">      3.02.3 List Method Sample 3: CMS360° - Retrieve a list of claims</span><br />
+
02.5 List Method Sample 5: CMS360°- Retrieve Assessors list<br />
−
<span style="color: #247859;">      3.02.4 List Method Sample 4: CMS360°- Retrieve a list of Services</span><br />
+
02.6 List Method Sample 6: CMS360°- Retrieve a List of Grants<br />
−
<span style="color: #247859;">      3.02.5 List Method Sample 5: CMS360°- Retrieve Assessors list</span><br />
 
−
<span style="color: #247859;">      3.02.6 List Method Sample 6: CMS360°- Retrieve a List of Grants</span>
 
  
 
|-
 
|-
Line 50: Line 52:
 
==='Update'===
 
==='Update'===
 
||
 
||
−
[[Image:UpdateCompany.PNG|thumb|right|851x230px|<strong>Update Company</strong>]]
+
 
 
<br />
 
<br />
−
<span style="color: #247859;">      3.03.1 Update Method Sample 1: Create organizations</span><br />
+
03.1 Update Method Sample 1: Create organizations<br />
−
<span style="color: #247859;">      3.03.2 Update Method Sample 2: Create/Update User</span>
+
03.2 Update Method Sample 2: Create/Update User<br />
  
 
|-
 
|-
Line 59: Line 61:
 
==='Download File'===
 
==='Download File'===
 
||
 
||
−
[[Image:DownloadFiles.PNG|thumb|right|851x230px|<strong>Download Files from Level One</strong>]]
+
04.1 Download File Method Sample 1: Download file(s) from a company profile<br />
−
<br />
 
−
<span style="color: #247859;">      3.04.1 Download File Method Sample 1: Download file(s) from a company profile</span>
 
  
 
|-
 
|-
Line 67: Line 67:
 
==='List File'===
 
==='List File'===
 
||
 
||
−
[[Image:ListFiles.PNG|thumb|right|851x230px|<strong>List Files from Level One</strong>]]
+
05.1 List Files Method Sample 1:  from an organization<br />
−
<br />
+
05.2 List Files Method Sample 2: from an application<br />
−
<span style="color: #247859;">      3.05.1 List Files Method Sample 1:  from an organization</span><br />
 
−
<span style="color: #247859;">      3.05.2 List Files Method Sample 2: from an application</span>
 
  
 
|-
 
|-
Line 76: Line 74:
 
==='Search File'===
 
==='Search File'===
 
||
 
||
−
[[Image:SearchFiles.PNG|thumb|right|851x230px|<strong>Search Files from Level One</strong>]]
+
06.1 Search Files Method Sample 1: Search Case Documents<br />
−
<br />
 
−
<span style="color: #247859;">      3.06.1 Search Files Method Sample 1: Search Case Documents </span>
 
  
 
|-
 
|-
Line 84: Line 80:
 
==='List Notes'===
 
==='List Notes'===
 
||
 
||
−
[[Image:ListNotes.PNG|thumb|right|851x230px|<strong>List Notes from a Company</strong>]]
+
.07.1 List Notes Method Sample 1:  from an application<br />
−
<br />
 
−
<span style="color: #247859;">      3.07.1 List Notes Method Sample 1:  from an application</span>
 
  
 
|-
 
|-
Line 92: Line 86:
 
==='List Multiple Addresses'===
 
==='List Multiple Addresses'===
 
||
 
||
−
[[Image:ListMultipleAddresses.PNG|thumb|right|851x230px|<strong>Get all multiple addresses of a Company</strong>]]
+
08.1 List Multiple Addresses Method Sample 1: Multiple Addresses of an Organization<br />
−
<br />
 
−
<span style="color: #247859;">      3.08.1 List Multiple Addresses Method Sample 1: Multiple Addresses of an Organization</span>
 
  
 
|-
 
|-
Line 100: Line 92:
 
==='Update Multiple Addresses'===
 
==='Update Multiple Addresses'===
 
||
 
||
−
[[Image:UpdateMultipleAddresses.PNG|thumb|right|851x230px|<strong>Update multiple addresses of a Company</strong>]]
+
09.1 Update Multiple Addresses Method Sample 1: update addresses of an Organization<br />
−
<br />
 
−
<span style="color: #247859;">      3.09.1 Update Multiple Addresses Method Sample 1: update addresses of an Organization</span>
 
  
 
|-
 
|-
Line 108: Line 98:
 
==='List Associations'===
 
==='List Associations'===
 
||
 
||
−
[[Image:List_Associations.png|thumb|right|851x230px|<strong>List Contact Association of a Level 1</strong>]]
+
10.1 List Associations Method Sample 1: Contact associations from an application<br />
−
<br />
+
10.2 List Associations Method Sample 2: Organization associations from an application<br />
−
<span style="color: #247859;">      3.10.1 List Associations Method Sample 1: Contact associations from an application</span><br />
 
−
<span style="color: #247859;">      3.10.2 List Associations Method Sample 2: Organization associations from an application</span>
 
  
 
|-
 
|-
Line 117: Line 105:
 
==='Update Associations'===
 
==='Update Associations'===
 
||
 
||
−
[[Image:Update_Associations.png|thumb|right|851x230px|<strong>Update Contact Association of a Level 1</strong>]]
+
11.1 Update Associations Method Sample 1: update contact associations of a Level 1<br />
−
<br />
 
−
<span style="color: #247859;">      3.11.1 Update Associations Method Sample 1: update contact associations of a Level 1</span><br />
 
−
<span style="color: #247859;">      </span>
 
  
 
|-
 
|-
Line 126: Line 111:
 
==='Metadata'===
 
==='Metadata'===
 
||
 
||
−
 
+
12.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />
−
<br />
+
12.2 Get Metadata Sample 1: GMS360°: Application Metadata<br />
−
<span style="color: #247859;">      3.12.1 Get Metadata Sample 1: CMS360°: Application Metadata</span><br />
 
−
<span style="color: #247859;">      3.12.2 Get Metadata Sample 1: GMS360°: Application Metadata</span>
 
  
 
|-
 
|-
Line 135: Line 118:
 
==='Report'===
 
==='Report'===
 
||
 
||
−
 
+
13.1 Get Report Sample 1: CMS360°: Report - Assessor Count by Specialty<br />
−
<br />
+
13.2 Get Report Sample 2: GMS360°: Grants by Organization Report<br />
−
<span style="color: #247859;">      3.13.1 Get Report Sample 1: CMS360°: Report - Assessor Count by Specialty</span><br />
+
13.3 Get Report Sample 3: GMS360°: GMS360°: Grants by Focus Area Report<br />
−
<span style="color: #247859;">      3.13.2 Get Report Sample 2: GMS360°: Grants by Organization Report</span><br />
+
13.4 Get Report Sample 4: GMS360°: GMS360°: Payments Made by Grant Type Report<br />
−
<span style="color: #247859;">      3.13.3 Get Report Sample 3: GMS360°: GMS360°: Grants by Focus Area Report</span><br />
 
−
<span style="color: #247859;">      3.13.4 Get Report Sample 4: GMS360°: GMS360°: Payments Made by Grant Type Report</span>
 
  
 
|}
 
|}

Revision as of 16:26, 21 August 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      Samples

'Get'

01.1 Get Method Sample 1: Retrieve a Single Organization Record
01.2 Get Method Sample 2: Retrieve a Single Contact Record
01.3 Get Method Sample 3: Retrieve a Single Grant Application Record
01.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record
01.5 Get Method Sample 5: List Files

'List'

02.1 List Method Sample 1: Retrieve a list of contacts
02.2 List Method Sample 2: Retrieve a list of organizations
02.3 List Method Sample 3: CMS360° - Retrieve a list of claims
02.4 List Method Sample 4: CMS360°- Retrieve a list of Services
02.5 List Method Sample 5: CMS360°- Retrieve Assessors list
02.6 List Method Sample 6: CMS360°- Retrieve a List of Grants

'Update'


03.1 Update Method Sample 1: Create organizations
03.2 Update Method Sample 2: Create/Update User

'Download File'

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

'List File'

05.1 List Files Method Sample 1:  from an organization
05.2 List Files Method Sample 2: from an application

'Search File'

06.1 Search Files Method Sample 1: Search Case Documents

'List Notes'

.07.1 List Notes Method Sample 1:  from an application

'List Multiple Addresses'

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

'Update Multiple Addresses'

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

'List Associations'

10.1 List Associations Method Sample 1: Contact associations from an application
10.2 List Associations Method Sample 2: Organization associations from an application

'Update Associations'

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

'Metadata'

12.1 Get Metadata Sample 1: CMS360°: Application Metadata
12.2 Get Metadata Sample 1: GMS360°: Application Metadata

'Report'

13.1 Get Report Sample 1: CMS360°: Report - Assessor Count by Specialty
13.2 Get Report Sample 2: GMS360°: Grants by Organization Report
13.3 Get Report Sample 3: GMS360°: GMS360°: Grants by Focus Area Report
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=32574’