Changes

Jump to: navigation, search

SmartConnect - Appendix: Standard Field Names

19,528 bytes added, 16:48, 25 September 2020
no edit summary
==Field List Syntax==
{| class="wikitable"
|-
||
|-
!|Field List Syntax
==Companies==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- style="font-weight: bold; text-align: center;"| style="border: 1px solid gray;" ! width="520%"|API Field Reference''' ''' | style="border: 1px solid gray;" ! width="25%"|'''Standard Field Name'''Description | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Get/List'''Description''' | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Update'''GET Method''' | style="border: 1px solid gray;" ! width="2025%"|'''UPDATE Method'''Notes External
|-
||sf_Name
||Name of current company
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
1|-||sf_Phone
||
sf_Company ID| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Company id. (0 if new company)|-||sf_Fax
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
'''Not Updatable'''
 
|-
||sf_Address
||
2| style="text-align: center;"|✓|style="text-align: center;"|sf_Parent Company✓
||
Parent company name|-||sf_Address 2
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_City
||
3| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Parent Company ID|-||sf_State / Province
||
Parent company id| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Country
||
| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Country ID or Country name as value
|-
||sf_Zip / Postal Code
||
4| style="text-align: center;"|✓|style="text-align: center;"|sf_Status ID✓
||
Status id
 
||
 
||
 
|-
||sf_Web Site
||
5| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Status Caption
 
||
Status Caption
 
||
 
||
 
|-
||sf_Longitude
||
6 |style="text-align: center;"|sf_Status✓|style="text-align: center;"|Status✓
||
 
||
 
|-
||sf_Latitude
||
7 |style="text-align: center;"|✓sf_Is External ||Flag (1style=external, 0=internal) "text-align: center;"||✓
||
 
|-
||sf_Primary Contact
||Primary Contact name
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
8
 
||
sf_Owner ID
 
||
user who created the company
 
||
 
||
 
|-
||sf_Parent Company
||Parent company name
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
9
 
||
sf_Primary Contact ID
 
||
Primary contact ID. (0 if empty)
 
||
 
||
 
|-
||sf_Owner
||Name of User in Owner Standard Field
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
10
 
||
sf_Primary Contact
 
||
Primary contact name
 
||
 
||
 
|-
||sf_Company Workflow
||ID of Company workflow standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
11
 
||
sf_Name
 
||
Name standard field
 
||
 
||
 
|-
||sf_User Workflow
||ID of User workflow standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
12
 
||
sf_Address
 
||
Address standard field
 
||
 
||
 
|-
||sf_Updated By
||Name of user that last updated the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
13
 
||
sf_Address 2
 
||
Address 2 standard field
 
||
 
||
 
|-
||sf_Last Updated
||Date record was last updated
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
14
 
||
sf_City
 
||
City standard field
 
||
 
||
 
|-
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
15
 
||
sf_State / Province
 
||
Province standard field
 
||
 
||
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
16
 
||
sf_Zip / Postal Code
 
||
Postal code standard field
 
||
 
||
 
|-
||17sf_Status||sf_CountryReturns Status name|style="text-align: center;"|Country name✓|style="text-align: center;"|''Displays country name''✓||''Update using country id or country name<br />''using Status ID as value
|-
||18sf_Company ID||sf_PhoneCompany id. (0 if new company)|style="text-align: center;"|Phone standard field✓|style="text-align: center;"|Not Updatable||Mandatory field for updating records
|-
||sf_Owner ID
||ID of User in Owner Standard Field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
19
 
||
sf_Fax
 
||
Fax standard field
 
||
 
||
 
|-
||20sf_Parent Company ID||sf_Web SiteID of Parent Company|style="text-align: center;"|Website standard field✓|style="text-align: center;"|✓||Mandatory field for adding records
|-
||sf_Primary Contact ID
||Primary Contact ID (0 if empty)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
21
 
||
sf_Category List
 
||
Comma delimited list of category IDs. (Starts and ends with a comma)
 
||
 
||
 
|-
||sf_Category ID List
||Comma delimited list of category IDs. (Starts and ends with a comma)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
22
 
||
sf_Last Updated
 
||
date the record was last updated on SmartSimple
 
||
 
||
'''Not Updatable'''
 
|-
||23sf_Status ID||sf_Last Updated ByReturns Status ID|style="text-align: center;"|Last updated user name✓|style="text-align: center;"|✓||Update using Status ID as value
|-
||sf_Is External
||Flag (1=external, 0=internal)
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
24Mandatory field for adding records
||sf_Created Date ||date For updates, this attribute will follow the record was last created on SmartSimple || ||'''Not Updatable'''attribute of the parent company
|-
||sf_Status Caption
||Returns Status Caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
25
 
||
sf_Created By
 
||
Created by user name
 
||
 
||
'''Not Updatable'''
 
|}
==Users==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- style="font-weight: bold; text-align: center;"| style="border: 1px solid gray;" ! width="520%"|API Field Reference''' ''' | style="border: 1px solid gray;" ! width="25%"|'''Standard Field Name'''Description | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Get/List'''Description''' | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Update'''GET Method''' | style="border: 1px solid gray;" ! width="2025%"|'''UPDATE Method'''Notes External
|-
||sf_First Name
||
1| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_User ID|-||sf_Last Name
||
User ID (0 if new user)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
'''Not Updatable'''
 
 
|-
||sf_Email
||
2| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Is External|-||sf_Title
||
Flag (1| style=external, 0=internal)"text-align: center;"|✓|style="text-align: center;"|✓
||
 
|-
||sf_Prefix
||
3| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Company ID|-||sf_Suffix
||
ID of user's company. 0 if empty.| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Phone
||
4 ||sf_Company |style="text-align: center;"|name of user's company✓|style="text-align: center;"|✓
||
 
|-
||sf_Phone Ext.
||
5 ||sf_Title |style="text-align: center;"|Title standard field.✓|style="text-align: center;"|✓
||
 
|-
||sf_Address
||
6| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Prefix
 
||
Prefix standard field
 
||
 
||
 
|-
||sf_Address 2
||
7 ||sf_Suffix |style="text-align: center;"|Suffix standard field✓|style="text-align: center;"|✓
||
 
|-
||sf_City
||
8| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_First Name
 
||
First name standard field
 
||
 
||
 
|-
||sf_State / Province
||
9 ||sf_Last Name |style="text-align: center;"|Last name standard field✓|style="text-align: center;"|✓
||
 
|-
||sf_Country
||
10| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Middle Name
 
||
Middle name standard field
 
||
 
||
 
|-
||sf_Zip / Postal Code
||
11 ||sf_Email |style="text-align: center;"|Email standard field✓|style="text-align: center;"|✓
||
 
|-
||12sf_Company||sf_AddressName of user's company|style="text-align: center;"|Address standard field✓|style="text-align: center;"|✓||When updating, use Company ID or Company name as value
|-
||sf_Middle Name
||
13 ||sf_Address 2 |style="text-align: center;"|Address 2 standard field✓|style="text-align: center;"|✓
||
 
|-
||sf_Longitude
||
14| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_City
 
||
City standard field
 
||
 
||
 
|-
||sf_Latitude
||
15 ||sf_State / Province |style="text-align: center;"|Province standard field✓|style="text-align: center;"|✓
||
 
|-
||16sf_User Role||sf_CountryComma delimited list of role IDs. (Starts and ends with a comma)|style="text-align: center;"|Name of country field.✓|style="text-align: center;"|''Displays country name''✓||''Update using country id or country name<br />''sf_User Role and sf_Role ID List are interchangable.
|-
||sf_Access Type
||
17 ||sf_Zip / Postal Code ||Postal code standard field || ||1 ('User'), 3 ('Applicant Interface'), 5 ('API'), 0 ('No Access')
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Update using ID as value
|-
||18sf_User Type||sf_Phone10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)|style="text-align: center;"|Phone standard field✓|style="text-align: center;"|✓||Update using ID as value
|-
||sf_Updated By
||Name of user that last updated the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
19
 
||
sf_Phone Ext
 
||
Phone extension field. (includes period at the end)
 
||
 
||
 
|-
||sf_Last Updated
||Date record was last updated
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
20
 
||
sf_User Role
 
||
Comma delimited list of role IDs. (Starts and ends with a comma)
 
||
 
||
 
|-
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
21
 
||
sf_Access Type
 
||
1 ('Administration or Portal Interface'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service User','No Access')
 
||
''Displays id''
 
||
''Update using id''
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
22
 
||
sf_User Type
 
||
10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)
 
||
''Displays name''
 
||
''Update using id''
 
|-
||23sf_Status||sf_Status*Returns Status name|style="text-align: center;"|status name of user✓|style="text-align: center;"|''Displays name''✓||''Update using id''using Status ID as value
|-
||24sf_User ID||sf_Status User ID*(0 if new user)|style="text-align: center;"|status ID of user✓|style="text-align: center;"|'' ''Not Updatable||'' ''Mandatory field for updating records
|-
||25sf_Company ID||Sf_Status CaptionID of user's company. 0 if empty.|style="text-align: center;"|Status caption✓|style="text-align: center;"|'' ''✓||'' ''Mandatory field for adding records
|-
||26sf_Status ID||sf_Updated ByReturns Status ID|style="text-align: center;"|name of user who updated the record✓|style="text-align: center;"|✓||Update using Status ID as value
|-
||27sf_Role ID List||sf_Last UpdatedComma delimited list of role IDs. (Starts and ends with a comma)|style="text-align: center;"|date record was last updated✓|style="text-align: center;"|✓||'''Not Updatable''' sf_User Role and sf_Role ID List are interchangable.
|-
||sf_Is External
||Flag (1=external, 0=internal)
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
28 ||sf_Created Date ||date record was created || ||'''Not Updatable'''Mandatory field for adding records
For updates, this attribute will follow the attribute of the parent company
|-
||sf_Status Caption
||Returns Status Caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
29
 
||
sf_Created By
 
||
user who created the user
 
||
 
||
 
|}
==Level 1==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- style! width="font-weight: bold; text-align: center;20%"|API Field Reference! width="25%"| Field Description! style="bordertext-align: 1px solid graycenter;" width="515%"|Allow Get/List''' ''' | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Update'''Standard Field Name''' | style="border: 1px solid gray;" ! width="25%"|Notes External'''Description'''|-||sf_Application Type||Returns level 1 template name| style="bordertext-align: 1px solid graycenter;" width="25%"|'''GET Method'''✓| style="bordertext-align: 1px solid graycenter;" width="20%"|✓'''UPDATE Method'''||Update using Type ID as value
|-
||sf_Application Name
||Returns value of Name standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
1|-||sf_Customer||Name of company on Client standard field| style="text-align: center;"|✓|style="text-align: center;"|✓sf_Level One ||Update using Company IDas value|-||sf_PersonTracking ||Name of contact attached to Person standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using User ID of level 1as value|-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Revenue||Revenue standard field|style="text-align: center;"|✓| style="text-align: center;"|✓
||
'''Not Updatable'''
 
 
|-
||sf_Currency
||Currency standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
2
 
||
sf_Application ID
 
||
UTA ID
 
||
 
||
 
|-
||sf_Close Date
||Close Date standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
3
 
||
sf_Company ID
 
||
Company ID of level 1 company/client field. 0 if empty
 
||
 
||
 
|-
||sf_Modified Date
||Date record was last updated
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
 
||
sf_Customer
 
||
Name of company
 
||
 
||
 
|-
||sf_Modified By
||Name of user that last updated the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
4
 
||
sf_Branch ID
 
||
Company ID of level 1 branch field. 0 if empty
 
||
 
||
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
5
 
||
sf_Person ID
 
||
User ID of level 1 people field. 0 if empty
 
||
 
||
 
|-
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
6
 
||
Sf_Person
 
||
Name of Person
 
||
 
||
 
|-
||sf_Probability
||Probability standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
7
 
||
sf_Type ID
 
||
ID of level 1 template
 
||
 
||
 
|-
||sf_Description
||Returns value from Description standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
8
 
||
sf_Application Type
 
||
Level 1 template type name
 
||
 
||
 
|-
||sf_Requirement
||Requirement standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
9
 
||
sf_Application Name
 
||
Name standard field
 
||
 
||
 
|-
||10sf_Owner||sf_DescriptionReturns name of level 1 owner standard field|style="text-align: center;"|Description standard field✓|style="text-align: center;"|✓||Update using Owner ID as value
|-
||11sf_Branch||sf_RequirementReturns company name on Branch standard field|style="text-align: center;"|Requirement standard field✓|style="text-align: center;"|✓||Update using Branch ID as value
|-
||sf_End Date
||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
12
 
||
sf_Status ID
 
||
Status ID of level 1 status. 0 if empty
 
||
 
||
 
|-
||sf_Start Date
||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
13
 
||
sf_Status
 
||
Name of level 1 status
 
||
 
||
 
|-
||sf_Archived
||Flag (1=Archived, 0=Not Archived)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
14
 
||
sf_Revenue
 
||
Revenue standard field
 
||
 
||
 
|-
||sf_Level One ID
||Returns unique Level 1 tracking ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
15 ||sf_Start DateMandatory field for updating records
||Start date standard field || ||Use "recordid" in place of "sf_Level One ID" in updating records
|-
||sf_Company ID
||Company ID of level 1 company/client field. 0 if empty
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
16
 
||
sf_End Date
 
||
End date standard field
 
||
 
||
 
|-
||sf_Person ID
||User ID of level 1 people field. 0 if empty
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
17
 
||
sf_Close Date
 
||
Close date standard field
 
||
 
||
 
|-
||sf_Branch ID
||Company ID of level 1 branch field. 0 if empty
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
18
 
||
sf_Probability
 
||
Probability standard field
 
||
 
||
 
|-
||41.19 ||sf_Owner sf_Type ID ||ID of level 1 owner.template| style="text-align: center;"|✓|style="text-align: center;"|✓||Mandatory field for adding records<br /> Update using Type ID as value
|-
||20 ||sf_Ownersf_Status ID||Name Status ID of level 1 ownerstatus. 0 if empty| style="text-align: center;"|✓|style="text-align: center;"|✓||Mandatory field for adding records<br /> Update using Status ID as value
|-
||sf_Owner ID
||ID of level 1 owner.
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
21
 
||
sf_Modified By
 
||
Name of user who modified the record
 
||
 
||
'''Not Updatable'''
 
 
|-
||sf_Application ID
||Returns UTA ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
22
 
||
sf_Modified Date
 
||
Date the record was modified
 
||
 
||
'''Not Updatable'''
 
 
|-
||sf_Status Caption
||Returns Status caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
23
 
||
sf_Created By
 
||
Name of user who created the record
 
||
 
||
'''Not Updatable'''
 
''' '''
 
|-
||sf_Type Caption
||Returns level 1 template caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
24
 
||
sf_Created Date
 
||
Date record was created
 
||
 
||
'''Not Updatable'''
 
 
|}
==Level 2==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- style! width="font-weight: bold; text-align: center;20%"|API Field Reference! width="25%"| Field Description! style="bordertext-align: 1px solid graycenter;" width="515%"|Allow Get/List''' ''' | ! style="bordertext-align: 1px solid graycenter;" width="2515%"|Allow Update'''Standard Field Name''' | style="border: 1px solid gray;" ! width="25%"|External Notes'''Description'''|-||sf_Activity Type||Returns level 2 type name| style="bordertext-align: 1px solid graycenter;" width="25%"|'''GET Method'''✓| style="bordertext-align: 1px solid graycenter;" width="20%"|✓'''UPDATE Method'''||Update using Type ID as value
|-
||sf_Subject
||Returns level 2 subject
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
1|-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Location||Location standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Level Two ID|-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Activity ID |-||sf_Owner||Returns name of level 2owner standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner ID as value|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
|-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
'''Not Updatable'''
 
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
2|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Application ID|-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
UTA ID|-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Whole Day Event||Flag (Yes, No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Reminder Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
3|-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Description|-||sf_Reminder Type||Returns ID of reminder type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Description standard field|-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Assign Person||Comma delimited list of user IDs in assigned standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Contact Person
||Comma delimited list of user IDs in contact standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
4|-||sf_Description||Returns value from Description standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Subject|-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Subject |-||sf_Parent Name||Returns Name standard fieldfrom parent level 1| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Longitude
||
5| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Type ID|-||sf_Latitude
||
ID of level 2/3 type| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
||
 
|-
||sf_Level Two ID
||Returns unique level 2 ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
6Mandatory field for updating records
||sf_Activity TypeUse "recordid" in place of "sf_Level Two ID" in updating records
|-
||sf_Parent ID
||Returns level 1 ID from parent record
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L2 records
|-
||sf_Type ID
||ID of level 2 template
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records
|-
||sf_Status ID
||Status ID of level 1 status. 0 if empty
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records
|-
||sf_Owner ID
||ID of level 1 owner.
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
Level 2/3 type name|-||sf_Application ID||Returns UTA ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
|-||sf_Status Caption||Returns Status caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Type Caption
||Returns level 2 type caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
7|}
==Level 3==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||sf_Activity Type
||Returns level 3 type name
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Update using Type ID as value
|-
||sf_Subject
||Returns level 3 subject
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
sf_Parent |-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status IDas value|-||sf_Location||Location standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Parent object ID|-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Owner||Returns name of level 3 owner standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner ID as value|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Last Modified
||Date record was last updated
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
8|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Assign Person|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Comma delimited list of user IDs |-||sf_Start Date||Returns Start Date and Time in assigned standard fieldYYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Whole Day Event
||Flag (Yes, No)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
9|-||sf_Reminder Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Contact Person|-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Comma delimited list |-||sf_Reminder Type||Returns ID of user IDs in contact standard fieldreminder type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Parent Subject
||Returns Subject field from parent level 2
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
10|-||sf_Associated Parent||Displays level 2 ID from soft-linked UTA| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Location|-||sf_Assign Person||Comma delimited list of user IDs in assigned standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Location |-||sf_Contact Person||Comma delimited list of user IDs in contact standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Description
||Returns value from Description standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
11
 
||
sf_Start Date
 
||
Start date standard field
 
||
 
||
 
|-
||sf_Amount
||Returns value from Amount standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
12
 
||
sf_End Date
 
||
End date standard field
 
||
 
||
 
|-
||sf_Longitude
||
13| style="text-align: center;"|✓|style="text-align: center;"|sf_DurationNot Updatable
||
Duration standard field
 
||
 
||
 
|-
||sf_Latitude
||
14 ||sf_Amount |style="text-align: center;"|Amount standard field✓|style="text-align: center;"|Not Updatable
||
 
|-
||sf_Level Three ID
||Returns unique level 3 ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
15 ||sf_Status ID ||Status ID of status. 0 if emptyMandatory field for updating records
|| ||Use "recordid" in place of "sf_Level Three ID" in updating records
|-
||16sf_Parent ID||sf_StatusReturns level 2 ID from parent record|style="text-align: center;"|Status name✓|style="text-align: center;"|✓||Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L3 records
|-
||17sf_Type ID||sf_Owner IDof level 3 template|style="text-align: center;"|User ID of owner. 0 if empty✓|style="text-align: center;"|✓||Mandatory field for adding records
|-
||18 ||sf_Ownersf_Status ID||Name Status ID of ownerlevel 1 status. 0 if empty| style="text-align: center;"|✓|style="text-align: center;"|✓||Mandatory field for adding records
|-
||sf_Owner ID
||ID of level 1 owner.
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
19
 
||
sf_Updated By
 
||
Name of user who updated the record
 
||
 
||
 
|-
||sf_Application ID
||Returns UTA ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
20
 
||
sf_Last Modified
 
||
Date the record was modified
 
||
 
||
'''Not Updatable'''
 
 
|-
||sf_Status Caption
||Returns Status caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
21
 
||
sf_Created By
 
||
Name of user who created the record
 
||
 
||
 
|-
||sf_Type Caption
||Returns level 3 type caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
22
 
||
sf_Created Date
 
||
Date record was created
 
||
 
||
'''Not Updatable'''
 
 
|}
 
==Level 3==
See Level 2.
 
 
==Multiple Address==
{| class="wikitable" width="85%" cellpadding="5px" align="center"|- ! width="20%"|API Field Reference! width="25%"|Field Description! style="font-weight: bold; text-align: center;"width="15%"|Allow Get/List| ! style="bordertext-align: 1px solid graycenter;" width="515%"| Allow Update| style="border: 1px solid gray;" ! width="25%"|External Notes|-'''Standard Field Name'''||sf_Address ID||Unique id in Multiple Address table| style="bordertext-align: 1px solid graycenter;" width|✓| style="25%text-align: center;"|Not Updatable||Mandatory field for updating records|-'''Description'''||sf_Object ID||Object ID of parent record. Could be companyid, contactid.| style="bordertext-align: 1px solid graycenter;" width|✓| style="25%text-align: center;"|✓||Mandatory field for adding records|-'''GET Method'''||sf_Type ID||Address type ID| style="bordertext-align: 1px solid graycenter;" width|✓| style="20%text-align: center;"|✓'''UPDATE Method'''||Mandatory field for adding records
|-
||sf_Type
||Address Type
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
1|-||sf_Address
||
sf_Address ID| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Unique id in Multiple Address table|-||sf_Address 2
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_City
||
2| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Object ID|-||sf_State / Province
||
companyid / contactid / providerid / consumerid| style="text-align: center;"|✓|style="text-align: center;"|✓
||
 
|-
||sf_Zip / Postal Code
||
3| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Type ID|-||sf_Country
||
Multiple Address Type ID| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Primary Address
||Flag (1=Yes, 0=No)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records
|-
||sf_Updated By
||Name of user that last updated the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
4|}
==Associations==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||objectid
||
sf_Type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Type name|}
==Transactions==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||sf_Start Date
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_End Date
||
5| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address|-||sf_Description
||
Address standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Subject
||
6| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address 2|-||sf_Status||Returns transaction status name| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Address 2 standard field|-||sf_Modified Date||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
7|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_City|-||sf_Type||Transaction type| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Transaction ID||Unique ID for the transaction record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Object ID||Parent object id for the transaction| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|}
||==Notes==City standard fieldNotes can only be retrieved via GET and LIST. They cannot be created or updated via SmartConnect.
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||sf_Note ID
||Unique ID for the Note record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
|-||sf_Type||Note Type| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Type ID
||Type ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
8|-||sf_Content||Contents of the note| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_State / Province|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Province standard field|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
|-||sf_Object ID||Parent object id for the note| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
|}
==System Variables==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||sf_ID
||System variable record ID.
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||Mandatory field for updating records
|-
||sf_Name
||Variable Name
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
9|-||sf_Value||Value of the variable| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Zip / Postal Code|-||sf_Description||Variable Description| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Postal code standard field|}
==Consumer/Provider==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||providerappid
||[[Determining_the_applicationid|Application ID]] of the provider UTA
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
|-||consumerappid||[[Determining_the_applicationid|Application ID]] of the consumer UTA| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||providerid
||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the provider UTA L1/L2
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
10|-||consumerid||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the consumer UTA L1/L2sf_Country| style="text-align: center;"|✓|style="text-align: center;"|Country nameNot Updatable
||
''Displays country name''
 
||
''Update using country id''
 
|-
||roleid
||Connection roleid between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
11
 
||
sf_Last Modified
 
||
date the record was last updated
 
||
 
||
 
|-
||rolename
||Connection rolename between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
12
 
||
sf_Primary Address
 
||
Is primary address (1=yes, 0=no)
 
||
 
||
 
|-
||associationid
||Unique identifier for the consumer/provider relationship table
| style="text-align: center;"|✓
| style="text-align: center;"| 
||
13
 
||
sf_Updated By
 
||
Last updated user id
 
||
 
||
 
|}
==See Also==
[[JSON API (SmartConnect_-_RESTful_API|SmartConnect)]] <br />[[JSON - RESTful API (SmartConnect) Prerequisite]]  
[[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]
Lalaine Songalia
Smartstaff
1,385
edits
Retrieved from ‘https://wiki.smartsimple.com/wiki/Special:MobileDiff/29511...38022’

Navigation menu