=General Information=Introduction ==Next Upgrade Date==The next upgrade is scheduled for '''{{CurrentUpgradeDate}}'''.<br />
==Upgrade Schedule=={{Upgrade Schedule}}SmartSimple’s SmartConnect JSON API provides a relatively easy to use method of integrating SmartSimple information with other web services and other programs.
We regularly update the list of upgrade features The API uses industry '''standard JSON syntax and schedule for both constructs'''. If you are not familiar with JSON you should take a look at the backup and production environments on [http://www.w3schools.com/json/default.asp following tutorial] before venturing much further in this Wiki page. topic:
This page will provide == SmartSimple System Version =={| class="wikitable"|Clients must be on the November 2015 or a general overview of each more recent upgrade, with links to use the Wiki articles describing the new or updated features and how to use them. You can also [http://smart.smartsimpleAPI.com/s_signup.jsp?token=XVtQC1oGYF9bRxdFQhdQ subscribe] to the [[:Category:Newsletter Archives|Technical Journal]] that is sent out prior to each upgrade on the [http://smart.smartsimple.com/s_signup.jsp?token=XVtQC1oGYF9bRxdFQhdQ Newsletter Signup Page]. (Unsubscribe [http://smart.smartsimple.com/s_signup.jsp?token=XVtQC1oGYF9bQxNFQhdQ here]).}
==System Upgrade ProcessGeneral Overview of the API ==
The objective of the System Upgrade Process is to ensure that customers have a chance to review, without compromising the integrity of their production system, how their applications and information will work following the upgrade. In order to take advantage of this use the API you will need to know how to access your backup instance of SmartSimple. If you need assistance with this either refer to take the [[Backup Server and Testing Instances]] Wiki article, or contact the [[SmartSimple]] support desk.following steps:
For clients on a Private Cloud enviornment, please review * Within your instance of SmartSimple you will create one or more API functions that can be called through the [[SmartSimple Upgrade Process – Dedicated Server]] pageAPI.
===Upgrade Schedule Details==={{Upgrade Schedule Details}}* Each function you create is linked to a specific SmartSimple object such as Organization, Contact, Report, Universal Tracking Application Level 1 object, Level 2 and level 3.
===Backup Environment Update===* You define the fields that can be retrieved from that object through that function. This approach ensures that you never expose data to the API that you don't want people to use in the API.
* Each [[Backup Server and Testing Instances|backup environment]] will be updated to You choose the "release candidate" prior Action Type that you wish to use for the upgrade datefunction. Currently there are five action types:* This update will provide * '''Get''' - Retrieve a single record for instance specific testing of release candidate, as the object type you have selected in the function.** '''List''' - Retrieve multiple records or the object type you can log into your respective [[Backup Server and Testing Instances|backup environment]] and test have selected in the changes against your most current function.** '''Update''' - Change data and configurationin one or more fields in the object you have retrieved. Update is also used to create new objects.* Internal staff will also be using these environments * '''Download File''' - Downloads to perform instance the browser a file you have retrieved.** '''List Files''' - Retrieves a list of files from a specified object.** '''Search Files''' - Retrieve a list of files containing specific testingstring values.
===Update Go/No-Go===* Subject Once saved, each function will generates and display a key that is unique to satisfactory testing on both that function in that instance. You cannot use the pre-production environments and function unless you supply the backup environments, the Go/No-Go decision will be made on the Wednesday prior to an upgrade releasekey.
=Current Upgrade PackageNote: February 2017=The production environments for SmartSimple will increase the Public Cloud were last upgraded on {{LastUpgradeDate}}Action Types as we continue to enhance the API.
'''Important:''' The upgrade will be applied to your [[Backup Server and Testing Instances|backup environment]] two weeks prior to the scheduled upgrade date for your production environment. You are encouraged to log into your backup environment during this period to test the changes against your most recent data and configuration.== JSON API Interactive Demonstration Page ==
If your organization is subscribed you want to Private Cloud hosting, review how the upgrade will API works and interact with some sample functions and test data be made available sure to you two weeks after visit the Public Cloud release'''[https://api.smartsimple.com/devtools/dev_api.html interactive demonstration page]'''. This page is connected to a specific demonstration instance that contains sample data for testing.====[https://api.smartsimple.com/devtools/dev_api.html Interactive Demonstration Page]====
{{February2017Upgrade}}== Configuring JSON Functions within SmartSimple ==
=Previous Upgrades=See The only functions you will be able to use within a instance of SmartSimple are the specific functions that have been enabled in that instance. Visit the article [[Previous UpgradesCreating JSON functions]] page for a list of previously-implemented upgrade featuresto learn how to add functions to your instance.
=Future Upgrades=Click [[Future Upgrades|here]] for a listing of future upgrade dates.Field List Syntax ==
{| class="wikitable"||-!Field List Syntax!Example|-|Separate values with ";;" |sf_Name;;cf_MyFieldName|-|Prefix Standard fields with "sf_"|sf_Name|-|Prefix Custom fields with "cf_"|cf_MyFieldName|-|Application Metadata append with "." followed by what you want returned|levelone.status or levelone.* (star returns all)|} ===Application Metadata Options:=======Level One Options==== * '''*'''* levelone.** levelone.fields* levelone.roles* levelone.categories* levelone.statuses* levelone.types* levelone.types.fields ====Level Two Options==== * leveltwo.** leveltwo.fields* leveltwo.types* leveltwo.types.fields* leveltwo.status====Level Three Options====* levelthree.** levelthree.fields* levelthree.types* levelthree.types.fields [[Category:Integration]][[Category:API]][[Category:UpgradesSmartConnect RESTful API]]
