2,004
edits
Changes
no edit summary
The API uses industry '''standard JSON syntax and constructs'''. If you are not familiar with JSON you should take a look at the [http://www.w3schools.com/json/default.asp following tutorial] before venturing much further in this topic:
== SmartSimple System Version ==
{| class="wikitable"
|You must be on the November 2015 or January 2016 upgrade to use the API.
|}
== General Overview of the API ==
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 [[Creating JSON functions]] to learn how to add functions to your instance.
== 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:API]][[Category:Integration]]
