Smartstaff
1,385
edits
Changes
no edit summary
* '''url''': String containing the URL to which the request is sent
* '''apitoken''': Encrypted token generated and associated to each SmartConnect function.
* '''jsonrset''' (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 for that record (e.g. userid for a user/contact record), and must include every field and 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.
If you are making a remote call from an external system you will also need to include:
: Values of each nodes:
: "andor" - either "and" or "or"
: "field" - name of the standard/custom field to set the condition to
: "operator" - can use the following: =,>,>=,<=,<,<>,!=,like,not like
: "value" - value for the filter
: sample1: [{"andor":"and","field":"FIELDNAME","operator":"like","value":"PATTERN"}]<br/>
: sample2: [{"andor":"and","field":"FIELDNAME1","operator":"=","value":"100"},{"andor":"or","field":"FIELDNAME2","operator":"like","value":"PATTERN"}]
* sortby - this is an optional json array. This contains the following nodes: "field" and "direction"
: "field" - name of the standard/custom field to sort records by<br/>
: "direction" - either "asc" (for ascending) or "desc" (for descending)
* getstorevalue - this is an optional json array. Options are: int type: 0 = no (get display value), 1 = yes (get stored value)
=Configuration - Advanced=
=Appendix=
==Standard Field Names==
See [[SmartConnect - Appendix: Standard Field Names|SmartConnect Standard Field Names]] for a list of all available Standard Fields that you can reference along with update restrictions.
==Options and Settings==
===Available Record Types===
{| class="wikitable"
=SmartConnect Examples=
See our [https://api.smartsimple.com/devtools/dev_apiapi.html interactive demonstration page] for a demo and live sample of how the API works. This page is connected to a specific demonstration instance containing sample data.
We strongly encourage you to review this page in order to gain a better understanding of the syntax and functionality of the API.