Changes

* This API uses industry standard JSON syntax and constructs. If you are not familiar with JSON you should take a look at the [https://www.w3schools.com/js/js_json_intro.asp following tutorial] before venturing much further in this topic.* If you wish to export and import large amounts of information then this API should not be used.

==Interactive Demonstration Page==For * This API does not place metering restrictions as to the number of records that can be retrieved by a demo of how the single API works, you can test some sample functions on our [https://api.smartsimple.com/devtools/dev_api.html interactive demonstration page]query. This page is connected to   However retrieving a specific demonstration instance containing sample data. We strongly encourage you to review this page in order to gain large number of records (greater than 1000 records) will have a better understanding of the syntax negative impact on performance and functionality of may cause the APIquery to fail. 

# In this screen you will find options for ''Object Record Type'', ''Action Type'', and ''Field List'' that define respectively, the type of record, the action to perform, and the field list that will be exposed for this function.

Here is a more detailed look at [[Creating JSON functionsSmartConnect Functions|creating SmartConnect functions]].

||Standard fields are denoted by their name, preceded by a prefix of 'sf_'. See Appendix for a list of Standard Field names for each object. 

||cf_''CustomFieldName'' cf_''CustomFieldID'' ||Custom fields are denoted by their field name, preceded by a prefix of 'cf_'. While it is best practice to reference the field name, you may also reference the field ID. ||cf_My Custom Field cf_12345 

To make an API call you will need to post to the appropriate endpoint which will simply be based on the ''Object TypeRecord Type'' of the API function. The general endpoint will be in the form of:

/API/''APIVersion''/''objecttyperecordtype''/

!|Object Record Type

||<nowiki>https://example.smartsimple.com/API/1/report/</nowiki>

||<nowiki>https://example.smartsimple.com/API/1/company/</nowiki>

||<nowiki>https://example.smartsimple.com/API/1/user/</nowiki>

||<nowiki>https://example.smartsimple.com/API/1/sysvar/</nowiki>

||<nowiki>https://example.smartsimple.com/API/1/levelone/</nowiki>

||https<nowiki>tps://example.smartsimple.com/API/1/leveltwo/</nowiki>

||<nowiki>https://example.smartsimple.com/API/1/levelthree/</nowiki>

||<nowiki>https://example.smartsimple.com/API/1/transactions/</nowiki>

The message body that you post will need to include various parameters depending on the ''Object TypeRecord Type'' and ''Action Type'' being used. The required and optional parameters will be listed for each different function on the configuration page of each SmartConnect function.  At minimum though, you will always need to includethe following parameters:

* '''url''': The String containing the URL to post which the request is sent* '''apitoken''': Encrypted token generated and associated toeach SmartConnect function.* '''apitokenjsonrset'''(update functions only): JSON array containing one or more records to update. The top node should be named 'records', with each sub-node representing a record to update. Each record sub-node is identified by a 'recordid' value that is the unique SmartSimple ID generated for that record (e.g. userid for a user/contact record), and must include every field and associated to each only fields that were defined in the field list of the SmartConnect function. If the field value is not being changed, set it to the current value.

* '''alias''': The web alias of your SmartSimple instance. This will typically be the leading portion of your instance URL, and can be found in your Global Settings -> Branding configuration. E.g. for <nowiki>https://example.smartsimple.com </nowiki> the alias would be 'example'. <pre>Sample call within SmartSimple instance: function api_call() { $.ajax({ method: "POST", type: "POST", url: "/API/1/levelone/", data: { apitoken: "QlwYYlJERHVASmlfXWtTWklbXEt9UHpmDw4~", recordid: 1234567, }, dataType: "html" }) .done(function(data) { json = JSON.parse(data); });}</pre> ===POST Response===With every successful request an HTTP status of 200 is returned along with a JSON response body that contains the recordset.

{ "records":[ { "sf_Description":"0959-3985", "sf_Transaction ID":"6048788", "sf_Created Date":"2015-07-23 11:03:17", "sf_End Date":"2015-07-23 11:03:17", "sf_Subject":"API Test", "sf_Object ID":"0", "sf_Start Date":"2015-07-22 00:00:00", "sf_Modified Date":"2018-05-09 11:14:58", "sf_Type":"Publications", "sf_Created By":"SmartSimple Support", } ], "message":{  }}</pre> For record updates and creation, the response body will simply return the recordid and a status of "Updated Successfully". <pre>Sample response format for UPDATE call:<br />{ "records":[ { "recordid":"6048788", "recordindex":1, "status":"updated successfully" } ], "message":{  }}</pre> ===Important Notes=======Using Update Functions====Here are some important notes to be aware of when calling update functions. * Date field values should be written in the format of YYYY-MM-DD.* Field types with pre-defined options, e.g. Select One, and Select Many type fields, need to be set with their stored value options, rather than their display captions. For example, a field where you have defined options like "1=Yes;2=No" needs to be set by the values "1" or "2".* The update functions can also be used to create new records. This can be done by setting the recordid to 0. The response will then return the recordid of the new record created. ====Update Behaviour====

<!--Explain all applicable misc options and settings that shouldn't be explained above here...-->===Available Object TypesRecord Types===

<!--89304 - SmartConnect 'Update Meta' - should be removed from dropdown-->The following is a full list of available actions. Please note that not all actions will be available for all object typesrecord types. 

||Download a single file from a specified record and field. 

||Retrieve a list of files containing across a specific object type via keyword search of the file contents. Upload fields searched are restricted based on the field list specified string valuesin the api call. See [[Indexing Multiple and Single File Fields|Indexing Multiple and Single File fields.]]

||Returns formatted content processed by the variable processor from a specified record.  The system will replace all variables within the content parameter with variable values from that objectrecord.  E.g. Passing in "Hello @firstname@" as content for a contact name named John Smith will return "Hello John".