Open main menu

Changes

SmartConnect - Appendix: Standard Field Names

22,991 bytes added, 16:48, 25 September 2020
no edit summary
==Field List Syntax==
{| class="wikitable"
|-
||
|-
!|Field List Syntax
|-
||Separate values with ";;"
||sf_Name;;cf_MyFieldName;;cf_MyFieldssid
|-
||Prefix Standard fields with "sf_"
==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 namesf_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|-||sf_Web Site
||
Status id| style="text-align: center;"|✓|style="text-align: center;"|✓
||
 
|-
||sf_Longitude
||
5| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Status Caption|-||sf_Latitude
||
Status Caption| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Primary Contact||Primary Contact name| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Parent Company
||Parent company name
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
6|-||sf_Owner||Name of User in Owner Standard Field| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Status|-||sf_Company Workflow||ID of Company workflow standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Status|-||sf_User Workflow||ID of User workflow standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Last Updated
||Date record was last updated
| 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_Is External|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Flag |-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Company ID||Company id. (10 if new company)| style="text-align: center;"|✓| style=external, 0"text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Owner ID||ID of User in Owner Standard Field| style=internal)"text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Parent Company ID||ID of Parent Company| style="text-align: center;"|✓| 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;"|✓
||
 
|-
||sf_Category ID List
||Comma delimited list of category IDs. (Starts and ends with a comma)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
8|-||sf_Status ID||Returns Status ID| style="text-align: center;"|✓| 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
||
sf_Owner IDMandatory field for adding records
||user who created 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
||
|}
==Users==
{| 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%"|Notes External
|-
||sf_First Name
||
9| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Primary Contact ID|-||: Primary contact ID. (0 if empty)sf_Last Name
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Email
||
10| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Primary Contact|-||Primary contact namesf_Title
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Prefix
||
11| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Name|-||Name standard fieldsf_Suffix
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Phone
||
12| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address|-||sf_Phone Ext.
||
Address standard field| style="text-align: center;"|✓|style="text-align: center;"|✓
||
 
|-
||sf_Address
||
13| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address 2|-||Address sf_Address 2 standard field 
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_City
||
14| style="text-align: center;"|✓|style="text-align: center;"|sf_City✓
||
City standard field|-||sf_State / Province
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Country
||
15| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_State |-||sf_Zip / ProvincePostal Code
||
Province standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Company
||Name of user's company
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||When updating, use Company ID or Company name as value
|-
||sf_Middle Name
||
16| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Zip / Postal Code|-||Postal code standard fieldsf_Longitude
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Latitude
||
17| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Country|-||sf_User Role||Comma delimited list of role IDs. (Starts and ends with a comma)| style="text-align: center;"|✓| style="text-align: center;"|✓||sf_User Role and sf_Role ID List are interchangable.|-||sf_Access Type
||
Country name1 ('User'), 3 ('Applicant Interface'), 5 ('API'), 0 ('No Access')
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Update using ID as value
|-
||sf_User Type
||10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)
| style="text-align: center;"|✓
| 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
||
''Displays country name''|-||sf_Last Updated||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
''Update using country id''
 
|-
||sf_Created By
||Name of user that created  the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
18|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Phone|-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_User ID||User ID (0 if new user)| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Company ID||ID of user's company. 0 if empty.| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Status ID||Returns Status ID| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Role ID List||Comma delimited list of role IDs. (Starts and ends with a comma)| style="text-align: center;"|✓| style="text-align: center;"|✓||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
||
Phone standard Mandatory fieldfor 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
||
|}
==Level 1==
{| 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%"|Notes External
|-
||sf_Application Type
||Returns level 1 template name
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Update using Type ID as value
|-
||sf_Application Name
||Returns value of Name standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
19|-||sf_Customer||Name of company on Client standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Company ID as value|-||sf_Person||Name of contact attached to Person standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using User ID as 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;"|✓
||
sf_Fax|-||sf_Currency||Currency standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Fax |-||sf_Close Date||Close Date standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Modified Date||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
 
|-
||sf_Modified By
||Name of user that last updated the record
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
20|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Web Site|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Website |-||sf_Probability||Probability 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;"|✓
||
 
|-
||sf_Requirement
||Requirement standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
21|-||sf_Owner||Returns name of level 1 owner standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner ID as value|-||sf_Branch||Returns company name on Branch standard field| style="text-align: center;"|✓| 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;"|✓
||
sf_Category List|-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Comma delimited list of category IDs. |-||sf_Archived||Flag (Starts and ends with a comma1=Archived, 0=Not Archived)| style="text-align: center;"|✓|style="text-align: center;"|✓
||
 
|-
||sf_Level One ID
||Returns unique Level 1 tracking ID
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
22Mandatory field for updating records
||sf_Last UpdatedUse "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;"|✓
||
date the record was last updated on SmartSimple|-||sf_Person ID||User ID of level 1 people field. 0 if empty| style="text-align: center;"|✓| style="text-align: center;"|✓
||
|-||sf_Branch ID||Company ID of level 1 branch field. 0 if empty| style="text-align: center;"|✓| style="text-align: center;"|✓
||
'''Not Updatable'''
 
|-
||sf_Type ID
||ID of level 1 template
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records<br /> Update using Type ID as value
|-
||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<br /> Update using Status ID as value
|-
||sf_Owner ID
||ID of level 1 owner.
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
23|-||sf_Application ID||sf_Last Updated ByReturns UTA ID|style="text-align: center;"|Last updated user name✓|style="text-align: center;"|Not Updatable
||
 
|-
||sf_Status Caption
||Returns Status caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
24
 
||
sf_Created Date
 
||
date the record was last created on SmartSimple
 
||
 
||
'''Not Updatable'''
 
|-
||sf_Type Caption
||Returns level 1 template caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
25
 
||
sf_Created By
 
||
Created by user name
 
||
 
||
'''Not Updatable'''
 
|}
==UsersLevel 2=={| 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 2 type name| style="text-align: center;"|✓| style="text-align: 800pxcenter;"|✓||Update using Type ID as value
|-
||sf_Subject
||Returns level 2 subject
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
''' '''|-||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;"|✓
||
'''Standard Field Name'''|-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
'''Description'''|-||sf_Owner||Returns name of level 2 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
||
'''GET Method'''|-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
'''UPDATE Method'''
 
|-
||sf_Created Date
||Date the record was created
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
1|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_User ID|-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓
||
User ID (0 if new user)|-||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;"|✓
||
'''Not Updatable'''
 
 
|-
||sf_Reminder Sent
||Flag (1=Yes 0=No)
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
2|-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Is External|-||sf_Reminder Type||Returns ID of reminder type| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Flag (1|-||sf_Follow-up Type||Returns Id of follow-up type| style=external, 0"text-align: center;"|✓| style=internal)"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;"|✓
||
3|-||sf_Description||Returns value from Description standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Company ID|-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
ID of user's company. 0 if empty.|-||sf_Parent Name||Returns Name standard field from parent level 1| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Longitude
||
4| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Company|-||name of user's companysf_Latitude
||
| 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
||
5Mandatory field for updating records
||sf_TitleUse "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;"|✓
||
Title standard field.|-||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
||
6|}
==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_Prefix|-||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;"|✓
||
Prefix |-||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
||
7|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Suffix|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Suffix standard field|-||sf_Start Date||Returns Start Date and Time in YYYY-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;"|✓
||
8|-||sf_Reminder Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_First Name|-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓
||
First name standard field|-||sf_Reminder Type||Returns ID of reminder 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;"|✓
||
9|-||sf_Associated Parent||Displays level 2 ID from soft-linked UTA| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Last Name|-||sf_Assign Person||Comma delimited list of user IDs in assigned standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Last name |-||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;"|✓
||
 
|-
||sf_Amount
||Returns value from Amount standard field
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
10|-||sf_Longitude
||
sf_Middle Name| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Middle name standard field|-||sf_Latitude
||
| style="text-align: center;"|✓| 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
||
11Mandatory field for updating records
||sf_EmailUse "recordid" in place of "sf_Level Three ID" in updating records
|-
||sf_Parent ID
||Returns level 2 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 L3 records
|-
||sf_Type ID
||ID of level 3 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;"|✓
||
Email standard field|-||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 3 type caption
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
12|}
==Multiple Address==
{| 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_Address ID
||Unique id in Multiple Address table
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||Mandatory field for updating records
|-
||sf_Object ID
||Object ID of parent record. Could be companyid, contactid.
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records
|-
||sf_Type ID
||Address type ID
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||Mandatory field for adding records
|-
||sf_Type
||Address Type
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
sf_Address|-||Address standard fieldsf_Address
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Address 2
||
13| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address 2|-||Address 2 standard fieldsf_City
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_State / Province
||
14| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_City|-||City standard fieldsf_Zip / Postal Code
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
|-
||sf_Country
||
15| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_State / Province|-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Province standard |-||sf_Primary Address||Flag (1=Yes, 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory fieldfor adding records|-||sf_Updated By||Name of user that last updated the record|style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
|}
==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
||
16| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Country ||Name of country field.}
==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
||
''Displays country name''| style="text-align: center;"|✓| style="text-align: center;"|✓
||
''Update using country id''
 
|-
||sf_End Date
||
17| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Zip / Postal Code|-||sf_Description
||
Postal code standard field| style="text-align: center;"|✓| style="text-align: center;"|✓
||
 
||
 
|-
||sf_Subject
||
18| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Phone|-||sf_Status||Returns transaction status name| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Phone 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
||
19|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Phone Ext|-||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==Phone extension fieldNotes can only be retrieved via GET and LIST. They cannot be created or updated via SmartConnect. (includes period at the end)
{| 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
||
20|-||sf_Content||Contents of the note| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_User Role|-||sf_Created By||Name of user that created  the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Comma delimited list of role IDs. (Starts and ends with a comma)|-||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;"|✓
||
21|-||sf_Value||Value of the variable| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Access Type|-||sf_Description||Variable Description| style="text-align: center;"|✓| style="text-align: center;"|✓
||
1 ('Administration or Portal Interface'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service User','No Access') ||''Displays id'' ||''Update using id''}
==Consumer/Provider==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"||22API Field Reference! width="25%"||Field Descriptionsf_User Type |! style="text-align: center;" width="15%"|Allow Get/List10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’) ! style="text-align: center;" width="15%"||''Displays name''Allow Update! width="25%"||''Update using id''External Notes
|-
||providerappid
||[[Determining_the_applicationid|Application ID]] of the provider UTA
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
23
 
||
sf_Status*
 
||
status name of user
 
||
''Displays name''
 
||
''Update using id''
 
|-
||consumerappid
||[[Determining_the_applicationid|Application ID]] of the consumer UTA
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
24
 
||
sf_Status ID*
 
||
status ID of user
 
||
'' ''
 
||
'' ''
 
|-
||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
||
25
 
||
Sf_Status Caption
 
||
Status caption
 
||
'' ''
 
||
'' ''
 
|-
||consumerid
||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the consumer UTA L1/L2
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
26
 
||
sf_Updated By
 
||
name of user who updated the record
 
||
 
||
 
|-
||roleid
||Connection roleid between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
27
 
||
sf_Last Updated
 
||
date record was last updated
 
||
 
||
'''Not Updatable'''
 
 
|-
||rolename
||Connection rolename between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
28
 
||
sf_Created Date
 
||
date record was created
 
||
 
||
'''Not Updatable'''
 
 
|-
||associationid
||Unique identifier for the consumer/provider relationship table
| style="text-align: center;"|✓
| style="text-align: center;"| 
||
29
 
||
sf_Created By
 
||
user who created the user
 
||
 
||
 
|}
 
==Level 1==
* '''sf_Level One ID''': Tracking ID of level 1.
* '''sf_Application ID''': UTA ID.
* '''sf_Company ID''': Company ID of level 1 company/client field. 0 if empty.
* '''sf_Branch ID''': Company ID of level 1 branch field. 0 if empty.
* '''sf_Person ID''': User ID of level 1 people field. 0 if empty.
* '''sf_Person''': name of User for level 1 people field.
* '''sf_Type ID''': ID of level 1 template.
* '''sf_Application Template Type''': Level 1 template type name.
* '''sf_Application Name''': Name standard field.
* '''sf_Description''': Description standard field.
* '''sf_Requirement''': Requirement standard field.
* '''sf_Status ID''': Status ID of level 1 status. 0 if empty.
* '''sf_Status''': Name of level 1 status.
* '''sf_Revenue''': Revenue standard field.
* '''sf_Start Date''': Start date standard field.
* '''sf_End Date''': End date standard field.
* '''sf_Close Date''': Close date standard field.
* '''sf_Probability''': Probability standard field.
* '''sf_Owner ID''': ID of level 1 owner.
* '''sf_Owner''': Name of level 1 owner.
* '''sf_Modified By''': Name of user who modified the record.
* '''sf_Modified Date''': Date the record was modified.
* '''sf_Created By''': Name of user who created the record.
* '''sf_Created Date''': Date the record was created.
 
==Level 2==
* '''sf_Level Two ID''': Activity ID of level 2.
* '''sf_Application ID''': UTA ID.
* '''sf_Description''': Description standard field.
* '''sf_Subject''': Subject standard field.
* '''sf_Type ID''': ID of level 2/3 type.
* '''sf_Activity Type''': Level 2 type name.
* '''sf_Parent ID''': Parent object ID.
* '''sf_Assign Person''': Comma delimited list of user IDs in assigned standard field.
* '''sf_Contact Person''': Comma delimited list of user IDs in contact standard field.
* '''sf_Location''': Location standard field.
* '''sf_Start Date''': Start date standard field.
* '''sf_End Date''': End date standard field.
* '''sf_Duration''': Duration standard field.
* '''sf_Amount''': Amount standard field.
* '''sf_Status ID''': Status ID of status. 0 if empty.
* '''sf_Status''': Status name.
* '''sf_Owner ID''': User ID of owner. 0 if empty.
* '''sf_Owner''': Name of owner.
* '''sf_Updated By''': Name of user who updated the record.
* '''sf_Last Modified''': Date the record was modified.
* '''sf_Created By''': Name of user who created the record.
* '''sf_Created Date''': Date the record was created.
 
==Level 3==
See Level 2.
 
 
==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/29415...38022’