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.
* '''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 META, UPDATE META, GET, LIST, UPDATE, UPDATE ASSOCIATIONS, LIST ASSOCIATIONS, DOWNLOAD FILE, LIST FILES, SEARCH FILES, LIST NOTES and VARIABLE REPLACE. Details on these Action Types / Methods are available below.
* '''Field List''' – this restricts the is used to define which fields that are retrievable through the function call. Please limit field list to be retrieved from the underlying object~50 standard fields/custom fields.
==SmartConnect Function SamplesConfigurations and Responses==
Visit the '''[https://api.smartsimple.com/devtools/api.html interactive demonstration page]''' to test the sample functions.
===GetMetadata===This function will retrieve all fields from the the metadata of the selected '''Field ListObject Type''' of . ====Get Metadata of a single record based on the Universal Tracking Application===='''Function Name''' - 3.01.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />'''recordidDescription''' - To retrieve metadata of an a [[Category:Universal_Tracking_Application|Universal Tracking Application]].<br />'''Object Type''' - Case Management 360° - Case<br />'''Action Type ''' - Get Meta<br />'''Field List''' - levelone.*;;leveltwo.*;;levelthree.* No parameters are needed to retrieve metadata.<br /> [[File:APIFunctionSample5l.PNG|800px]]
====Retrieve a Single Organization Record====
'''Function Name''' - 3.01.1 Get Method Sample 1: Retrieve a Single Organization Record<br />
'''Description''' - This function will retrieve a single record from the organization using the recordid: [[Determining_the_companyid|Company ID]]. The function is set up to retrieve the fields listed under '''Field List'''.<br />
'''Object Type''' - Company<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_Company ID;;sf_Name;;sf_Address;;sf_City;;sf_Country;;sf_Zip / Postal Code;;cf_EIN Number;;sf_Mission Statement
=====Sending API request using cURL=====cURL command below is an example on how to send API request to ''Get Metadata of a Universal Tracking Application'' using [[Filehttps:APIFunctionSample1//curl.haxx.PNG|800px]se/ cURL].
====Retrieve a Single Contact Record====<pre><nowiki>curl -X GET -k -i '''Function Name''' - 3https://api.01smartsimple.2 Get Method Sample 2: Retrieve a Single Contact Recordcom/API/1/levelone/<br /nowiki>'''Description''' - This function will retrieve a single record from the user table using the [[Determining_the_userid|User ID]]<nowiki>?url=https://api. The function is set up to retrieve the fields listed under '''Field List'''smartsimple.com/API/1/levelone/</nowiki><nowiki>&companyid=825646</nowiki><nowiki>&alias=api<br /nowiki>'''Object Type''' - User<br nowiki>&username=smartconnectdemo@smartsimple.com</nowiki>'''Action Type ''' - Get<br nowiki>&password=********************</nowiki><nowiki>&apitoken=U2N4RwUBTn5XZldZXFdfWX1@C2JAWXVuAjIF'''Field List''' - sf_User ID;;sf_Last Name;;sf_First Name;;sf_Prefix;;sf_Suffix;;sf_Title;;sf_Phone;;sf_Email</nowiki></pre>
[[File:APIFunctionSample2.PNG|800px]]
====Retrieve a Single Grant Application RecordGet Metadata of Organizations====<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->'''Function Name''' - 3.01.3 2 Get Method Metadata Sample 32: Retrieve a Single Grant Application RecordOrganizations Metadata<br />'''Description''' - This function will To retrieve a single record metadata from the [[Universal Tracking Application]] Level 1 using the [[Determining_the_opportunityid|Opportunity ID]]Organizations.<br />'''Object Type''' - Submission Manager - GrantCompany<br />'''Action Type ''' - GetMeta<br />'''Field List''' - cf_Project Name;;cf_Submission Number;;sf_Application Type;;sf_Status;;sf_Customer;;sf_Owner;;cf_Focus Area;;cf_Amount Requested;;cf_Program Area;;cf_Location;;cf_Proposed Start Date;;cf_Proposed End Date companies.*No parameters are needed to retrieve metadata.
====Retrieve a Single Grant Application Payment RecordGet Metadata from Contacts====<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->'''Function Name''' - 3.01.4 3 Get Method Metadata Sample 43: Retrieve a Single Grant Application Payment RecordUsers Metadata<br />'''Description''' - This function will To retrieve a single record metadata from the [[Universal Tracking Application]] Level 2 using the [[Determining_the_eventid|Event ID]]Users.<br />'''Object Type''' - Submission Manager - ActivityUser<br />'''Action Type ''' - GetMeta<br />'''Field List''' - sf_Status;;sf_Activity Type;;cf_Payment ID;;cf_Payment Amount;;cf_Payment Date;;Payment Notes contacts.*<br />No parameters are needed to retrieve metadata.
=====A report query on a list of Grants grouped by Focus Area=====
criteriavalue: <br />
--End custom parameter--
[[File:APIFunctionReport4.PNG|800px]]
=====A report query on a list of Payments grouped by Grant Type=====
criteriavalue: <br />
--End custom parameter--
[[File:APIFunctionReport5.PNG|800px]]
===Get===
This function will retrieve all fields from the '''Field List''' of a single record based on the '''recordid''' of an '''Object Type'''.
====Retrieve a Single Organization Record====
'''Function Name''' - 3.03.1 Get Method Sample 1: Retrieve a Single Organization Record<br />
'''Description''' - This function will retrieve a single record from the organization using the recordid: [[Determining_the_companyid|Company ID]]. The function is set up to retrieve the fields listed under '''Field List'''.
'''Object Type''' - Company<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_Company ID;;sf_Name;;sf_Address;;sf_City;;sf_Country;;sf_Zip / Postal Code;;cf_EIN Number;;sf_Mission Statement
[[File:APIFunctionSample1.PNG|800px]]
====Retrieve a Single Contact Record====
'''Function Name''' - 3.03.2 Get Method Sample 2: Retrieve a Single Contact Record<br />
'''Description''' - This function will retrieve a single record from the user table using the [[Determining_the_userid|User ID]]. The function is set up to retrieve the fields listed under '''Field List'''.<br />
====Retrieve a Single Grant Application Record====
'''Function Name''' - 3.03.3 Get Method Sample 3: Retrieve a Single Grant Application Record<br />
'''Description''' - This function will retrieve a single record from the [[Universal Tracking Application]] Level 1 using the [[Determining_the_opportunityid|Opportunity ID]].<br />
'''Field List''' - cf_Project Name;;cf_Submission Number;;sf_Application Type;;sf_Status;;sf_Customer;;sf_Owner;;cf_Focus Area;;cf_Amount Requested;;cf_Program Area;;cf_Location;;cf_Proposed Start Date;;cf_Proposed End Date
[[File:APIFunctionSample3.PNG|800px]]
====Retrieve a Single Grant Application Payment Record====
'''Function Name''' - 3.03.4 Get Method Sample 4: Retrieve a Single Grant Application Payment Record<br />
'''Description''' - This function will retrieve a single record from the [[Universal Tracking Application]] Level 2 using the [[Determining_the_eventid|Event ID]].<br />
'''Function Name''' - 3.03.5 System Variables Sample 1: Get<br />
'''Description''' - Get information on the [[System_Variables|system variables]] by searching the System Variable ID<br />
'''Object Type''' - System Variables<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_ID;;sf_Name;;sf_Value;;
--Begin custom parameter --<br />
recordid: 3601<br />
--End custom parameter--
===List===
<!--66823 - SmartConnect grouping criteria--><!--75675 - SmartConnect field name and format consistency-->This function will retrieve a list of records from the selected '''Object Type'''. Records will include all fields from the Custom parameters for List Functions are:* criteria - this is an optional json array. This contains the following nodes: "andor", "field", "operator" and "value" : 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: ''''Field List'sample1: '' and can be filtered using the parameter ''': criteria: [{"andor":"and","field":"FIELDNAME","operator":"like","value":"PATTERN"}]: sortby: [{"field":"FIELDNAME","direction":"asc"}]: othersettings : {"getstorevalue":"1","keyformat":"0"}: '''' and can also be sorted out using the parameter 'sample2: ''sortby'''. If the custom : criteria: [{"andor":"and","field":"FIELDNAME1","operator":"=","value":"100"},{"andor":"or","field":"FIELDNAME2","operator":"like","value":"PATTERN"}]: sortby: [{"field has a predefined options":"FIELDNAME","direction":"desc"}]: othersettings : {"getstorevalue":"0", use "keyformat":"0"}: '''''sample3:''''': An example query with brackets: ( (cf_somefield1 like '%whatever%'or cf_somefield2 like 'getstorevalue%whatever%' or cf_somefield3 like '%whatever%' to show either the display or cf_somefield4like '%whatever%' ) and (cf_someotherfield1='whatever' or cf_someotherfield2='whatever else')): criteria: [{ "andor": "(", "field": "cf_somefield1", "operator": "like", "value": "whatever" },{ "andor": "or", "field": "cf_somefield2", "operator": "like", "value": "whatever" },{ "andor": "or", "field": "cf_somefield3", "operator": "like", "value": "whatever" },{ "andor": "or", "field": "cf_somefield4", "operator": "like", "value ": "whatever" },{ "andor": ") and (", "field": "cf_someotherfield1", "operator": "=", "value": "whatever" },{ "andor": "or", "field": "cf_someotherfield2", "operator": "=", "value": "whatever else" }]: sortby: : othersettings : {"getstorevalue":"0","keyformat": "0) or to show "}* sortby - this is an optional json array. This contains the stored value (getstorevaluefollowing nodes: 1)."field" and "direction"
: "field" - name of the standard/custom field to sort records by: "direction" - either "asc" (for ascending) or "desc" (for descending)* othersettings** getstorevalue - this is an optional settings for the json array. Options are: int type: '''0''' - to get display value, '''1''' to get stored value (value from the database eg. $25,000 vs 25000)** keyformat - this is an optional settings for the json array. Options are: '''0''' - to use what is configured in the Field Listform the SmartConnect Function, '''1''' - to use the custom field names / standard field names and '''2''' - to use the custom field ID
=====Retrieve a list of contacts=====
'''Function Name''' - 3.03.104.1 List Method Sample 1: Retrieve a list of Contacts<br />
'''Description''' - This function will retrieve a list of contacts based on criteria specified.<br />
'''Function Name''' - 3.03.104.2 List Method Sample 2: Retrieve a list of Organizations<br />'''Description''' - To retrieve a list of organizations. <br />
=====List all Multiple Addresses of an existing Organization=====
'''Function Name''' - 3.0304.46.1 List Multiple Addresses Method Sample 1: Multiple Addresses of an existing Organization<br />
'''Description''' - To retrieve all of the multiple addresses of an existing organization using the [[Determining_the_companyid|Company ID]]<br />
'''Object Type''' - Company<br />
====List Associations====
=====List Contact associations from an existing application=====
'''Function Name''' - 3.0304.57.1 List Associations Method Sample 1: Contact associations from an existing application<br />
'''Description''' - To retrieve the list of contacts associated with an existing application using the [[Determining_the_opportunityid|Opportunity ID]]<br />
''recordidobjectid'' = [[Determining_the_opportunityid|Opportunity ID]]<br />''type'' = either '"contacts"' or '"organizations"' <br />
--Begin custom parameter --<br />
recordidobjectid: 827616510697883<br />
type: contacts<br />
--End custom parameter--
''Note:'' Please always use ''objectid'' (as per May 2019 update). ''recordid'' still works.
[[File:APIFunctionSample5j.PNG|800px]]
=====List Organization associations from an application=====
'''Function Name''' - 3.0304.57.2 List Associations Method Sample 2: Organization associations from an existing application<br />
'''Description''' - To retrieve the list of organizations associated with an existing application using the [[Determining_the_opportunityid|Opportunity ID]]<br />
''type'' = either '"contacts"' or '"organizations"'<br />
--Begin custom parameter --<br />
recordidobjectid: 827616510697883<br />
type: organizations<br />
--End custom parameter--
''Note:''
1. As per May 2019 upgrade, use ''objectid'' but ''recordid'' still works.
2. In '''Field List''', either use organizations or companies. If organizations is used in the '''Field List''', '''type''' in the parameter should be organizations.
[[File:APIFunctionSample5k.PNG|800px]]
===Metadata=List System Variables=========List All System Variables====='''Function Name''' - 3.04.8.1 System Variables Sample 1: List<br />This function will retrieve '''Description''' - Retrieves all the metadata of the selected [[System_Variables|system variables]]<br />'''Object Type'''. - System Variables<br />'''Action Type ''' - List<br />'''Field List''' - sf_ID;;sf_Name;;sf_Value;;
====Get Metadata of a Universal Tracking Application===='''Function Name''' - 3.04.1 Get Metadata Sample 1: CMS360°: Application Metadata<br />'''Description''' - To No parameters are needed to retrieve metadata of a all the global [[Category:Universal_Tracking_ApplicationSystem_Variables|Universal Tracking Applicationsystem variables]].<br />'''Object Type''' - Case Management 360° - Case<br />'''Action Type ''' - Get Meta<br />'''Field List''' - levelone.*;;leveltwo.*;;levelthree.*<br />
No parameters are needed to retrieve metadata.<br /> [[File:APIFunctionSample5lAPIFunctionSystemVariables1.PNG|800px]]
====Get Metadata of Organizations====
<!--63342 - SmartConnect API - metadata option to include Orgs/Contacts-->
recordid - to create new record, recordid should be '0'<br />
sf_Parent ID - parent of the UTA L2 record. use "objectid" in place of sf_Parent ID to update<br />
sf_Type ID - assigned [[Determining_the_typeid#Level_2_Template|Type ID]] of the new UTA L2 record.<br />
sf_Status ID - assigned [[Determining_the_statusid|Status ID]] of the new UTA L2 record.<br />
--Begin custom parameter --<br />
jsonrset : [{"recordid":"0","objectid":"10697883","sf_Type ID":"49096","sf_Status ID":"49093","sf_Start Date":"2018-10-01","sf_End Date":"2018-11-01","cf_Payment Notes":"new record added as an example"}]<br />
--End custom parameter--
[[File:APIFunctionUpdateUtaL2a.PNG|800px]]
<u>'''Sample 1H '''</u><br/>
'''Description''' - to update existing UTA L2 record
<br />
'''Mandatory fields''' to update a custom field "Payment Notes" of an existing records:<br />
recordid - is the [[Determining_the_eventid|Event ID]] of existing record.<br />
--Begin custom parameter --<br />
jsonrset : [{"recordid":"10020959 ","cf_Payment Notes":"Change value of this custom field thru API function"}]<br />
--End custom parameter--
[[File:APIFunctionUpdateUtaL2b.PNG|800px]]
====Update Multiple Addresses====
<u>'''Sample 2A'''</u><br/>
'''Description''' - To create new multiple address for an existing company <br/>
'''Mandatory fields''' to add new records:<br/>
recordid - to create new record, recordid should be '0'<br/>
<u>'''Sample 2B'''</u><br/>
'''Description''' - To update address of existing multiple address record <br />
'''Mandatory fields''' to update records:<br/>
recordid - is the unique identifier from the Association table.
====Update Associations====
Update function for association can add new association records or update the role of an existing association record.<br />
A. When this function is used to add new record, the following parameters are mandatory: objectid, companyid or contactid, rolename or roleid.<br />
B. When this function is used to update existing association records, it can only update the role of existing association records. Mandatory parameters are objectid, companyid or contactid, rolename or roleid and associationid. When the existing record is updated to a new role, all custom fields of the association from the previous role will be deleted.<br />
If you need to change company/contact, the record will need to be deleted and then add a new record for a new association.
=====Create/Update contact associations of a Level 1=====
'''Function Name''' - 3.05.3.1 Update Associations Method Sample 1: update contact associations of an existing Level 1<br />
<u>'''Sample 3A'''</u><br/>
'''Description''' - To create new user associated with an existing Submission Manager Level 1 <br/>
'''Mandatory fields''' to add new records:<br/>
recordid objectid - is the [[Determining_the_companyidDetermining_the_opportunityid|Company Opportunity ID]] where the user will be associated to.<br/>contactid - [[Determining_the_userid|User ID]]<br/>rolename / roleid - association role of the user<br/>isupdate - "1" for yes to update and "0" for to add new record <br/>rolename - association role of the user
'''Description''' - To update association information of an existing Submission Manager Level 1 record <br />
'''Mandatory fields''' to update records:<br/>
recordid objectid - is the [[Determining_the_companyidDetermining_the_opportunityid|Company Opportunity ID]] where the user will be associated to.<br/>
isupdate - "1" for yes and "0" for no
contactid - [[Determining_the_userid|User ID]]
associationid - is the system's unique numerical value associated with each Association record
rolename / roleid -[[Determining the roleid|'''Role ID''']]
====Update System Variables=========Update a System Variable====='''Function Name''' - 3.05.4.1 System Variables Sample 1: Update<br />'''Description''' - Updates the value or the name of an existing [[System_Variables|system variables]]<br />'''Object Type''' - System Variables<br />'''Action Type ''' - Update<br />'''Field List''' - sf_ID;;sf_Name;;sf_Value;; --Begin custom parameter --<br />jsonrset : [{"recordid":"9313","sf_Value":"2"}]<br />--End custom parameter-- [[File:APIFunctionSystemVariables3.PNG|800px]] ===Upload/Download File===
This function will download the file.
filename: Test.txt<br />
objectid: 1688407<br />
fieldid: 1523157<br />
--End custom parameter--<br />
Note: In the API website, the content of the file will be shown in the Response section as seen below.<br />[https://api.smartsimple.com/API/1/report/?url=https://api.smartsimple.com/API/1/report/&companyid=825646&alias=api&username=dataimport@smartsimple.com&password=smartsimple1&apitoken=W0t2dV58fmZGR1lzUmVDc2xibnd8BEdfAgMBAg~~&filename=Test.txt&objectid=1688407&fieldid=1523157| Click here to download the file]
[[File:APIFunctionDownloadFile1.PNG|800px]]
====Upload File(s) to a field in the company profile====
<!--122516 - API file upload-->
'''Function Name''' - 3.06.2 Upload File Method Sample 1: Upload file(s) to an existing company record<br />
'''Description''' - Upload the file based on the criteria indicated.<br />
'''Object Type''' - Company<br />
'''Action Type ''' - Upload Files<br />
'''Field List''' - cf_123456
'''
Mandatory fields''' to upload a file:
objectid - is the [wiki/Determining_the_companyid Company ID] where the file is attached to.<br />
fieldid - [wiki/Custom_Field_ID Custom Field ID] of the Organization record that is either a [wiki/Custom_Field_Type:_Upload_-_Single_File_Storage single file type] or [wiki/Custom_Field_Type:_Upload_-_Multiple_Files_Storage multiple file type].
--Begin custom parameter --<br />
objectid: 1688407<br />
fieldid: 1523157<br />
--End custom parameter--
<br />Note: To test use Postman.
The API URL for upload file will be:
https://alias.smartsimple.com/API/1/company/?alias=xxxxx&companyid=xxxxxx&username=xxxxx&password=xxxxx&apitoken=xxxxx&objectid=xxxxx&fieldid=xxxxx<br />with the file included in the form data, use POST method.
===Search File===
This function will retrieve a list of files by searching for a keyword.
[[File:APIFunctionSample8.PNG|800px]]
===System Variables===
This function will retrieve a list of all the global [[System_Variables|system variables]], get a single record based on the System Variable ID or update the name or value of the [[System_Variables|system variables]] using the System Variable ID.
<!--71972 - SmartConnect Function: System Variables - does not show when using '/devtools/dev_api.html'-->
====List====
'''Function Name''' - 3.08.1 System Variables Sample 1: List<br />
'''Description''' - Retrieves all the [[System_Variables|system variables]]<br />
'''Description''' - This function will send the objectid=[[Determining_the_opportunityid|Opportunity ID]] and the desired content with system variables. It returns a json format of the content with all the [[System_Variables|system variables]] replaced by the variable processor. <br />
content: This application is called "@name@", under the status of "@status@". The owner on this record is "@owner.fullname@", belonging to "@owner.company.name@". The company is "@client.name@". Parent Company is "@company.parent.name@.<br />
'''Description''' - This function will send the objectid=[[Determining_the_eventid|Event ID]] and the desired content with system variables. It returns a json format of the content with all the [[System_Variables|system variables]] replaced by the variable processor. <br />
content: This is a level two id record with eventid of"@eventid@" with L2 Type of "@type@" and status of "@status@". The parent record id is "@parent.opportunityid@". The parent Company's address is "@parent.company.address@".<br />
'''Description''' - This function will send the objectid=[[Determining_the_eventid|Event ID]] and the desired content with system variables. It returns a json format of the content with all the [[System_Variables|system variables]] replaced by the variable processor. <br />
content: This is L3 record id "@eventid@", of status "@status@". The parent L2 Type is "@parent.type@". The L1 company is "@parent.parent.company.name@".<br />
--End custom parameter--
[[File:APIFunctionVariablesReplace5.PNG|800px]]
===Delete===
====Delete a Single Organization Record====
<!--82768 - SmartConnect Function to delete objects-->
After the July 2023 upgrade, new function to delete files from Upload - Multiple Files Storage fields was added.
'''Function Name''' - 3.09.6 Delete Files in Level One<br />
'''Description''' - Delete existing files from a multiple file field in [[Category:Universal_Tracking_Application|Universal Tracking Application]] Level 1 record<br />
<!--72195 - SmartConnect Function on Transaction Applied to prod for May 2019 Upgrade-->
* <span style="color: #ff0000;">Available after May 2019 upgrade.</span>
* Transaction should be [[Transaction_Attribution|configured]] before using this API function. Transactions can be attached to an object (Organization or User or UTA L1/L2).
====Get Transaction Record====
=====Get a Transaction Record from an Organization=====
'''Function Name''' - 3.10.1.1 Get a Transaction Record from an Organization<br />
'''Description''' - Retrieve an organization transaction record <br />
'''Object Type''' - Company Transactions<br />
'''Action Type ''' - Get<br />
'''Field List''' - sf_Transaction ID;;sf_Object ID;;sf_Description;;sf_Subject;;sf_Type;;sf_Status;;sf_Created Date;;sf_Modified Date;;sf_Created By;;sf_Updated By
'''Mandatory fields''' to get a transaction record:<br/>
recordid - the unique identifier from the transaction table.
--Begin custom parameter --<br />
recordid:2738520<br />
othersettings :<br />
--End custom parameter--
[[File:TransactionGet1.PNG|800px]]
=====Retrieve a Transaction Record from a Submission Manager L1=====
'''Function Name''' - 3.10.1.2 Get Method Sample 4: Retrieve a Transaction Record from a Submission Manager L1<br />
'''Description''' - Retrieve a transaction record <br />
Note that translevel is new in version 2 where translevel=1 for UTA L1 and translevel=2 for UTA L2.
'''Mandatory fields''' to add a new transaction record:<br/>
recordid - the unique identifier from the transaction table. To create new record, recordid should be '0'<br/>
sf_Object ID - is the object(UTA L1) the transaction would be attached to.<br/>
sf_Type - [[Transaction_Custom_and_Standard_Field_Types|Transaction Type]] of the transaction record.<br/>
sf_Status - [[Transaction_Status|Transaction Status]] of the transaction record.<br/>
translevel - is the UTA Level (UTA L1/L2) the transaction would be attached to. <span style="color: #ff0000;">(NEW that is implemented in API v2)</span>
Note that translevel is new in version 2 where translevel=1 for UTA L1 and translevel=2 for UTA L2.<br/>
'''Mandatory fields''' to add a new transaction record:<br/>
recordid - the unique identifier from the transaction table. To create new record, recordid should be '0'<br/>
sf_Object ID - is the object(UTA L2) the transaction would be attached to.<br/>
sf_Type - [[Transaction_Custom_and_Standard_Field_Types|Transaction Type]] of the transaction record.<br/>
sf_Status - [[Transaction_Status|Transaction Status]] of the transaction record.<br/>
translevel - is the UTA Level (UTA L1/L2) the transaction would be attached to. <span style="color: #ff0000;">(NEW that is implemented in API v2)</span><br/>
<!--85831 - SmartConnect to support Consumer/Provider link Applied to prod for May 2019 Upgrade-->
* <span style="color: #ff0000;">Available after May 2019 upgrade.</span>
Consumer/Provider Relationship should be [[Configuring_UTA_Provider/Receiver_(Consumer)_Relationships | configured]] before using this API function. UTA Provider/Consumer Relationships allows for the sharing of data between different [[UTA|UTAs]].
'''Notes'''<br />
1. For May 2019 upgrade, add/update function will not support custom fields of the relationship.<br />
2. Update function is only used to update role between consumer/provider. When roleid/rolename is updated, all custom fields of the relationship from the previous role will be deleted.<br />
3. To update either the consumerid or the providerid of the consumer/provider record, these ids can't be updated. The record should be delete first and then add new consumer/provider record.
3. List function supports standard fields and custom fields of the relationship.
====List Consumer/Provider Records====
'''Function Name''' - 3.11.1 List Consumer/Provider Records<br />
'''Description''' - Get a list of all Consumer/Provider records<br />