Difference between revisions of "SmartConnect - Appendix: Standard Field Names"

Latest revision as of 11:48, 25 September 2020

The following lists the database field names associated with Standard Fields.

These are used in JSON API (SmartConnect).

Field List Syntax

Field List Syntax	Example
Separate values with ";;"	sf_Name;;cf_MyFieldName;;cf_MyFieldssid
Prefix Standard fields with "sf_"	sf_Name

Companies

API Field Reference	Field Description	Allow Get/List	Allow Update	Notes External
sf_Name	Name of current company	✓	✓
sf_Phone		✓	✓
sf_Fax		✓	✓
sf_Address		✓	✓
sf_Address 2		✓	✓
sf_City		✓	✓
sf_State / Province		✓	✓
sf_Country		✓	✓	Update using Country ID or Country name as value
sf_Zip / Postal Code		✓	✓
sf_Web Site		✓	✓
sf_Longitude		✓	✓
sf_Latitude		✓	✓
sf_Primary Contact	Primary Contact name	✓	Not Updatable
sf_Parent Company	Parent company name	✓	Not Updatable
sf_Owner	Name of User in Owner Standard Field	✓	Not Updatable
sf_Company Workflow	ID of Company workflow standard field	✓	✓
sf_User Workflow	ID of User workflow standard field	✓	✓
sf_Updated By	Name of user that last updated the record	✓	Not Updatable
sf_Last Updated	Date record was last updated	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Status	Returns Status name	✓	✓	Update using Status ID as value
sf_Company ID	Company id. (0 if new company)	✓	Not Updatable	Mandatory field for updating records
sf_Owner ID	ID of User in Owner Standard Field	✓	✓
sf_Parent Company ID	ID of Parent Company	✓	✓	Mandatory field for adding records
sf_Primary Contact ID	Primary Contact ID (0 if empty)	✓	✓
sf_Category ID List	Comma delimited list of category IDs. (Starts and ends with a comma)	✓	✓
sf_Status ID	Returns Status ID	✓	✓	Update using Status ID as value
sf_Is External	Flag (1=external, 0=internal)	✓	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	✓	Not Updatable

Users

API Field Reference	Field Description	Allow Get/List	Allow Update	Notes External
sf_First Name		✓	✓
sf_Last Name		✓	✓
sf_Email		✓	✓
sf_Title		✓	✓
sf_Prefix		✓	✓
sf_Suffix		✓	✓
sf_Phone		✓	✓
sf_Phone Ext.		✓	✓
sf_Address		✓	✓
sf_Address 2		✓	✓
sf_City		✓	✓
sf_State / Province		✓	✓
sf_Country		✓	✓
sf_Zip / Postal Code		✓	✓
sf_Company	Name of user's company	✓	✓	When updating, use Company ID or Company name as value
sf_Middle Name		✓	✓
sf_Longitude		✓	✓
sf_Latitude		✓	✓
sf_User Role	Comma delimited list of role IDs. (Starts and ends with a comma)	✓	✓	sf_User Role and sf_Role ID List are interchangable.
sf_Access Type	1 ('User'), 3 ('Applicant Interface'), 5 ('API'), 0 ('No Access')	✓	✓	Update using ID as value
sf_User Type	10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)	✓	✓	Update using ID as value
sf_Updated By	Name of user that last updated the record	✓	Not Updatable
sf_Last Updated	Date record was last updated	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Status	Returns Status name	✓	✓	Update using Status ID as value
sf_User ID	User ID (0 if new user)	✓	Not Updatable	Mandatory field for updating records
sf_Company ID	ID of user's company. 0 if empty.	✓	✓	Mandatory field for adding records
sf_Status ID	Returns Status ID	✓	✓	Update using Status ID as value
sf_Role ID List	Comma delimited list of role IDs. (Starts and ends with a comma)	✓	✓	sf_User Role and sf_Role ID List are interchangable.
sf_Is External	Flag (1=external, 0=internal)	✓	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	✓	Not Updatable

Level 1

API Field Reference	Field Description	Allow Get/List	Allow Update	Notes External
sf_Application Type	Returns level 1 template name	✓	✓	Update using Type ID as value
sf_Application Name	Returns value of Name standard field	✓	✓
sf_Customer	Name of company on Client standard field	✓	✓	Update using Company ID as value
sf_Person	Name of contact attached to Person standard field	✓	✓	Update using User ID as value
sf_Status	Returns Status name	✓	✓	Update using Status ID as value
sf_Revenue	Revenue standard field	✓	✓
sf_Currency	Currency standard field	✓	✓
sf_Close Date	Close Date standard field	✓	✓
sf_Modified Date	Date record was last updated	✓	Not Updatable
sf_Modified By	Name of user that last updated the record	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Probability	Probability standard field	✓	✓
sf_Description	Returns value from Description standard field	✓	✓
sf_Requirement	Requirement standard field	✓	✓
sf_Owner	Returns name of level 1 owner standard field	✓	✓	Update using Owner ID as value
sf_Branch	Returns company name on Branch standard field	✓	✓	Update using Branch ID as value
sf_End Date	Returns End Date and Time in YYYY-MM-DD HH:MM:SS	✓	✓
sf_Start Date	Returns Start Date and Time in YYYY-MM-DD HH:MM:SS	✓	✓
sf_Archived	Flag (1=Archived, 0=Not Archived)	✓	✓
sf_Level One ID	Returns unique Level 1 tracking ID	✓	Not Updatable	Mandatory field for updating records 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	✓	✓
sf_Person ID	User ID of level 1 people field. 0 if empty	✓	✓
sf_Branch ID	Company ID of level 1 branch field. 0 if empty	✓	✓
sf_Type ID	ID of level 1 template	✓	✓	Mandatory field for adding records Update using Type ID as value
sf_Status ID	Status ID of level 1 status. 0 if empty	✓	✓	Mandatory field for adding records Update using Status ID as value
sf_Owner ID	ID of level 1 owner.	✓	✓
sf_Application ID	Returns UTA ID	✓	Not Updatable
sf_Status Caption	Returns Status caption	✓	Not Updatable
sf_Type Caption	Returns level 1 template caption	✓	Not Updatable

Level 2

API Field Reference	Field Description	Allow Get/List	Allow Update	External Notes
sf_Activity Type	Returns level 2 type name	✓	✓	Update using Type ID as value
sf_Subject	Returns level 2 subject	✓	✓
sf_Status	Returns Status name	✓	✓	Update using Status ID as value
sf_Location	Location standard field	✓	✓
sf_Duration	Duration standard field	✓	✓
sf_Owner	Returns name of level 2 owner standard field	✓	✓	Update using Owner ID as value
sf_Updated By	Name of user that last updated the record	✓	Not Updatable
sf_Last Modified	Date record was last updated	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Start Date	Returns Start Date and Time in YYYY-MM-DD HH:MM:SS	✓	✓
sf_End Date	Returns End Date and Time in YYYY-MM-DD HH:MM:SS	✓	✓
sf_Whole Day Event	Flag (Yes, No)	✓	✓
sf_Reminder Sent	Flag (1=Yes 0=No)	✓	✓
sf_Follow-up Sent	Flag (1=Yes 0=No)	✓	✓
sf_Reminder Type	Returns ID of reminder type	✓	✓
sf_Follow-up Type	Returns Id of follow-up type	✓	✓
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_Description	Returns value from Description standard field	✓	✓
sf_Amount	Returns value from Amount standard field	✓	✓
sf_Parent Name	Returns Name standard field from parent level 1	✓	✓
sf_Longitude		✓	Not Updatable
sf_Latitude		✓	Not Updatable
sf_Level Two ID	Returns unique level 2 ID	✓	Not Updatable	Mandatory field for updating records Use "recordid" in place of "sf_Level Two ID" in updating records
sf_Parent ID	Returns level 1 ID from parent record	✓	✓	Mandatory field for adding records Use "objectid" in place of "sf_Parent ID" for new L2 records
sf_Type ID	ID of level 2 template	✓	✓	Mandatory field for adding records
sf_Status ID	Status ID of level 1 status. 0 if empty	✓	✓	Mandatory field for adding records
sf_Owner ID	ID of level 1 owner.	✓	✓
sf_Application ID	Returns UTA ID	✓	Not Updatable
sf_Status Caption	Returns Status caption	✓	Not Updatable
sf_Type Caption	Returns level 2 type caption	✓	Not Updatable

Level 3

API Field Reference	Field Description	Allow Get/List	Allow Update	External Notes
sf_Activity Type	Returns level 3 type name	✓	✓	Update using Type ID as value
sf_Subject	Returns level 3 subject	✓	✓
sf_Status	Returns Status name	✓	✓	Update using Status ID as value
sf_Location	Location standard field	✓	✓
sf_Duration	Duration standard field	✓	✓
sf_Owner	Returns name of level 3 owner standard field	✓	✓	Update using Owner ID as value
sf_Updated By	Name of user that last updated the record	✓	Not Updatable
sf_Last Modified	Date record was last updated	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Start Date	Returns Start Date and Time in YYYY-MM-DD HH:MM:SS	✓	✓
sf_End Date	Returns End Date and Time in YYYY-MM-DD HH:MM:SS	✓	✓
sf_Whole Day Event	Flag (Yes, No)	✓	✓
sf_Reminder Sent	Flag (1=Yes 0=No)	✓	✓
sf_Follow-up Sent	Flag (1=Yes 0=No)	✓	✓
sf_Reminder Type	Returns ID of reminder type	✓	✓
sf_Follow-up Type	Returns Id of follow-up type	✓	✓
sf_Parent Subject	Returns Subject field from parent level 2	✓	✓
sf_Associated Parent	Displays level 2 ID from soft-linked UTA	✓	✓
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_Description	Returns value from Description standard field	✓	✓
sf_Amount	Returns value from Amount standard field	✓	✓
sf_Longitude		✓	Not Updatable
sf_Latitude		✓	Not Updatable
sf_Level Three ID	Returns unique level 3 ID	✓	Not Updatable	Mandatory field for updating records Use "recordid" in place of "sf_Level Three ID" in updating records
sf_Parent ID	Returns level 2 ID from parent record	✓	✓	Mandatory field for adding records Use "objectid" in place of "sf_Parent ID" for new L3 records
sf_Type ID	ID of level 3 template	✓	✓	Mandatory field for adding records
sf_Status ID	Status ID of level 1 status. 0 if empty	✓	✓	Mandatory field for adding records
sf_Owner ID	ID of level 1 owner.	✓	✓
sf_Application ID	Returns UTA ID	✓	Not Updatable
sf_Status Caption	Returns Status caption	✓	Not Updatable
sf_Type Caption	Returns level 3 type caption	✓	Not Updatable

Multiple Address

API Field Reference	Field Description	Allow Get/List	Allow Update	External Notes
sf_Address ID	Unique id in Multiple Address table	✓	Not Updatable	Mandatory field for updating records
sf_Object ID	Object ID of parent record. Could be companyid, contactid.	✓	✓	Mandatory field for adding records
sf_Type ID	Address type ID	✓	✓	Mandatory field for adding records
sf_Type	Address Type	✓	✓
sf_Address		✓	✓
sf_Address 2		✓	✓
sf_City		✓	✓
sf_State / Province		✓	✓
sf_Zip / Postal Code		✓	✓
sf_Country		✓	✓
sf_Last Modified	Date record was last updated	✓	Not Updatable
sf_Primary Address	Flag (1=Yes, 0=No)	✓	✓	Mandatory field for adding records
sf_Updated By	Name of user that last updated the record	✓	Not Updatable

Associations

API Field Reference	Field Description	Allow Get/List	Allow Update	External Notes
objectid		✓	✓

Transactions

API Field Reference	Field Description	Allow Get/List	Allow Update	External Notes
sf_Start Date		✓	✓
sf_End Date		✓	✓
sf_Description		✓	✓
sf_Subject		✓	✓
sf_Status	Returns transaction status name	✓	✓
sf_Modified Date	Date record was last updated	✓	Not Updatable
sf_Updated By	Name of user that last updated the record	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Type	Transaction type	✓	✓	Mandatory field for adding records
sf_Transaction ID	Unique ID for the transaction record	✓	Not Updatable	Mandatory field for updating records
sf_Object ID	Parent object id for the transaction	✓	✓	Mandatory field for adding records

Notes

Notes can only be retrieved via GET and LIST. They cannot be created or updated via SmartConnect.

API Field Reference	Field Description	Allow Get/List	Allow Update
sf_Note ID	Unique ID for the Note record	✓	Not Updatable
sf_Type	Note Type	✓	Not Updatable
sf_Type ID	Type ID	✓	Not Updatable
sf_Content	Contents of the note	✓	Not Updatable
sf_Created By	Name of user that created the record	✓	Not Updatable
sf_Created Date	Date the record was created	✓	Not Updatable
sf_Object ID	Parent object id for the note	✓	Not Updatable

System Variables

API Field Reference	Field Description	Allow Get/List	Allow Update	External Notes
sf_ID	System variable record ID.	✓	Not Updatable	Mandatory field for updating records
sf_Name	Variable Name	✓	✓
sf_Value	Value of the variable	✓	✓
sf_Description	Variable Description	✓	✓

Consumer/Provider

API Field Reference	Field Description	Allow Get/List	Allow Update
providerappid	Application ID of the provider UTA	✓	Not Updatable
consumerappid	Application ID of the consumer UTA	✓	Not Updatable
providerid	Opportunity ID or Event ID of the provider UTA L1/L2	✓	Not Updatable
consumerid	Opportunity ID or Event ID of the consumer UTA L1/L2	✓	Not Updatable
roleid	Connection roleid between consumer/provider	✓	Updatable
rolename	Connection rolename between consumer/provider	✓	Updatable
associationid	Unique identifier for the consumer/provider relationship table	✓

Difference between revisions of "SmartConnect - Appendix: Standard Field Names"

Latest revision as of 11:48, 25 September 2020

Contents

Field List Syntax

Companies

Users

Level 1

Level 2

Level 3

Multiple Address

Associations

Transactions

Notes

System Variables

Consumer/Provider

See Also

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 5: / Line 5: @@
 ==Field List Syntax==
 {| class="wikitable"
-|-
-||
 |-
 !|Field List Syntax
@@ Line 19: / Line 17: @@
 ==Companies==
-{| class="wikitable" cellpadding="5px" align="center"
+{| class="wikitable" width="85%" cellpadding="5px" align="center"
-|- style="font-weight: bold; text-align: center;"
+|-
-| style="border: 1px solid gray;" width="5%"|
+! width="20%"|API Field Reference
-''' '''
+! width="25%"|Field Description
+! style="text-align: center;" width="15%"|Allow Get/List
-| style="border: 1px solid gray;" width="25%"|
+! style="text-align: center;" width="15%"|Allow Update
-'''Standard Field Name'''
+! width="25%"|Notes External
-| style="border: 1px solid gray;" width="25%"|
-'''Description'''
-| style="border: 1px solid gray;" width="25%"|
-'''GET Method'''
-| style="border: 1px solid gray;" width="20%"|
-'''UPDATE Method'''
 |-
+||sf_Name
+||Name of current company
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
+|-
+||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
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-sf_Parent Company
+|-
+||sf_Address 2
-||
-Parent company name
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
 |-
+||sf_City
 ||
+| 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
 ||
+| 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
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-sf_Status
-||
-Status
-||
-||
 |-
+||sf_Latitude
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Is External
-||
-Flag (1=external, 0=internal)
 ||
-||
 |-
+||sf_Primary Contact
+||Primary Contact name
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Owner ID
-||
-user who created the company
-||
-||
 |-
+||sf_Parent Company
+||Parent company name
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-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
 ||
-||
-sf_Primary Contact
-||
-Primary contact name
-||
-||
 |-
+||sf_Company Workflow
+||ID of Company workflow standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Name
-||
-Name standard field
-||
-||
 |-
+||sf_User Workflow
+||ID of User workflow standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-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
 ||
-||
-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
 ||
-||
-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
 ||
-||
-sf_State / Province
-||
-Province standard field
-||
-||
 |-
+||sf_Created Date
+||Date the record was created
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Zip / Postal Code
-||
-Postal code standard field
-||
-||
 |-
-||
+||sf_Status
+||Returns Status name
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Country
+||Update using Status ID as value
-||
-Country name
-||
-''Displays country name''
-||
-''Update using country id or country name<br />''
 |-
-||
+||sf_Company ID
+||Company id. (0 if new company)
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|Not Updatable
-sf_Phone
+||Mandatory field for updating records
-||
-Phone standard field
-||
-||
 |-
+||sf_Owner ID
+||ID of User in Owner Standard Field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Fax
-||
-Fax standard field
-||
-||
 |-
-||
+||sf_Parent Company ID
+||ID of Parent Company
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Web Site
+||Mandatory field for adding records
-||
-Website standard field
-||
-||
 |-
+||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)
-||
-||
 |-
+||sf_Category ID List
+||Comma delimited list of category IDs. (Starts and ends with a comma)
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Last Updated
-||
-date the record was last updated on SmartSimple
-||
-||
-'''Not Updatable'''
 |-
-||
+||sf_Status ID
+||Returns Status ID
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Updated By
+||Update using Status ID as value
-||
-Last updated user name
-||
-||
-'''Not Updatable'''
 |-
+||sf_Is External
+||Flag (1=external, 0=internal)
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
+Mandatory field for adding records
-||
+For updates, this attribute will follow the attribute of the parent company
-sf_Created Date
-||
-date the record was last created on SmartSimple
-||
-||
-'''Not Updatable'''
 |-
+||sf_Status Caption
+||Returns Status Caption
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Created By
-||
-Created by user name
-||
-||
-'''Not Updatable'''
 |}
 ==Users==
-{| class="wikitable" cellpadding="5px" align="center"
+{| class="wikitable" width="85%" cellpadding="5px" align="center"
-|- style="font-weight: bold; text-align: center;"
+|-
-| style="border: 1px solid gray;" width="5%"|
+! width="20%"|API Field Reference
-''' '''
+! width="25%"|Field Description
+! style="text-align: center;" width="15%"|Allow Get/List
-| style="border: 1px solid gray;" width="25%"|
+! style="text-align: center;" width="15%"|Allow Update
-'''Standard Field Name'''
+! width="25%"|Notes External
-| style="border: 1px solid gray;" width="25%"|
-'''Description'''
-| style="border: 1px solid gray;" width="25%"|
-'''GET Method'''
-| style="border: 1px solid gray;" width="20%"|
-'''UPDATE Method'''
 |-
+||sf_First Name
 ||
+| 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
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-sf_Is External
+|-
+||sf_Title
-||
-Flag (1=external, 0=internal)
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
 |-
+||sf_Prefix
 ||
+| 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
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Company
 ||
-name of user's company
+|-
+||sf_Phone Ext.
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
 |-
+||sf_Address
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Title
-||
-Title standard field.
-||
 ||
 |-
+||sf_Address 2
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Prefix
 ||
-Prefix standard field
-||
-||
 |-
+||sf_City
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Suffix
 ||
-Suffix standard field
-||
-||
 |-
+||sf_State / Province
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_First Name
 ||
-First name standard field
-||
-||
 |-
+||sf_Country
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Last Name
-||
-Last name standard field
-||
 ||
 |-
+||sf_Zip / Postal Code
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Middle Name
-||
-Middle name standard field
 ||
-||
 |-
-||
+||sf_Company
+||Name of user's company
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Email
+||When updating, use Company ID or Company name as value
-||
-Email standard field
-||
-||
 |-
+||sf_Middle Name
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-sf_Address
-||
-Address standard field
-||
-||
 |-
+||sf_Longitude
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
-||
-sf_Address 2
-||
-Address 2 standard field
-||
 ||
 |-
+||sf_Latitude
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-sf_City
-||
-City standard field
-||
-||
 |-
-||
+||sf_User Role
+||Comma delimited list of role IDs. (Starts and ends with a comma)
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_State / Province
+||sf_User Role and sf_Role ID List are interchangable.
-||
-Province standard field
-||
-||
 |-
+||sf_Access Type
 ||
+('User'), 3 ('Applicant Interface'), 5 ('API'), 0 ('No Access')
-||
-sf_Country
-||
-Name of country field.
-||
-''Displays country name''
-||
-''Update using country id or country name<br />''
+| 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;"|✓
-sf_Zip / Postal Code
+||Update using ID as value
-||
-Postal code standard field
-||
-||
 |-
+||sf_Updated By
+||Name of user that last updated the record
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Phone
-||
-Phone standard field
-||
-||
 |-
+||sf_Last Updated
+||Date record was last updated
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Phone Ext.
-||
-Phone extension field. (includes period at the end)
-||
-||
 |-
+||sf_Created By
+||Name of user that created  the record
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Role ID List
-||
-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_Access Type
-||
-('Administration or Portal Interface'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service User','No Access')
-||
-''Displays id''
-||
-''Update using id''
 |-
-||
+||sf_Status
+||Returns Status name
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_User Type
+||Update using Status ID as value
-||
-(‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)
-||
-''Displays name''
-||
-''Update using id''
 |-
-||
+||sf_User ID
+||User ID (0 if new user)
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|Not Updatable
-sf_Status*
+||Mandatory field for updating records
-||
-status name of user
-||
-''Displays name''
-||
-''Update using id''
 |-
-||
+||sf_Company ID
+||ID of user's company. 0 if empty.
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Status ID*
+||Mandatory field for adding records
-||
-status ID of user
-||
-'' ''
-||
-'' ''
 |-
-||
+||sf_Status ID
+||Returns Status ID
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Updated By
+||Update using Status ID as value
-||
-name of user who updated the record
-||
-||
-'''Not Updatable'''
 |-
-||
+||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_Last Updated
+||sf_User Role and sf_Role ID List are interchangable.
-||
-date record was last updated
-||
-||
-'''Not Updatable'''
 |-
+||sf_Is External
+||Flag (1=external, 0=internal)
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
+Mandatory field for adding records
-||
-sf_Created Date
-||
-date record was created
-||
-||
+For updates, this attribute will follow the attribute of the parent company
-'''Not Updatable'''
 |-
+||sf_Status Caption
+||Returns Status Caption
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-||
-sf_Created By
-||
-user who created the user
-||
-||
-'''Not Updatable'''
 |}
 ==Level 1==
-{| class="wikitable" cellpadding="5px" align="center"
+{| class="wikitable" width="85%" cellpadding="5px" align="center"
-|- style="font-weight: bold; text-align: center;"
+|-
-| style="border: 1px solid gray;" width="5%"|
+! width="20%"|API Field Reference
-''' '''
+! width="25%"|Field Description
+! style="text-align: center;" width="15%"|Allow Get/List
-| style="border: 1px solid gray;" width="25%"|
+! style="text-align: center;" width="15%"|Allow Update
-'''Standard Field Name'''
+! width="25%"|Notes External
+|-
-| style="border: 1px solid gray;" width="25%"|
+||sf_Application Type
-'''Description'''
+||Returns level 1 template name
+| style="text-align: center;"|✓
-| style="border: 1px solid gray;" width="25%"|
+| style="text-align: center;"|✓
-'''GET Method'''
+||Update using Type ID as value
-| style="border: 1px solid gray;" width="20%"|
-'''UPDATE Method'''
 |-
+||sf_Application Name
+||Returns value of Name standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
+|-
+||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_Level One ID
-||
-Tracking ID of level 1
-||
-||
-'''Not Updatable'''
 |-
+||sf_Currency
+||Currency standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Application ID
-||
-UTA ID
-||
-||
 |-
+||sf_Close Date
+||Close Date standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-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
 ||
-||
-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
 ||
-||
-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
 ||
-||
-Sf_Person
-||
-Name of Person
-||
-||
 |-
+||sf_Probability
+||Probability standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Type ID
-||
-ID of level 1 template
-||
-||
 |-
+||sf_Description
+||Returns value from Description standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Application Type
-||
-Level 1 template type name
-||
-||
 |-
+||sf_Requirement
+||Requirement standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_Application Name
-||
-Name standard field
-||
-||
 |-
-||
+||sf_Owner
+||Returns name of level 1 owner standard field
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Description
+||Update using Owner ID as value
-||
-Description standard field
-||
-||
 |-
-||
+||sf_Branch
+||Returns company name on Branch standard field
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Requirement
+||Update using Branch ID as value
-||
-Requirement standard field
-||
-||
 |-
+||sf_End Date
+||Returns End Date and Time in YYYY-MM-DD HH:MM:SS
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-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;"|✓
 ||
-||
-sf_Status
-||
-Name of level 1 status
-||
-||
 |-
+||sf_Archived
+||Flag (1=Archived, 0=Not Archived)
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-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
 ||
+Mandatory field for updating records
-||
-sf_Start Date
-||
-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;"|✓
 ||
-||
-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;"|✓
 ||
-||
-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;"|✓
 ||
-||
-sf_Probability
-||
-Probability standard field
-||
-||
 |-
-||
+||sf_Type ID
-.19
+||ID of level 1 template
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Owner ID
+||Mandatory field for adding records<br /> Update using Type ID as value
-||
-ID of level 1 owner.
-||
-||
 |-
-||
+||sf_Status ID
+||Status ID of level 1 status. 0 if empty
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Owner
+||Mandatory field for adding records<br /> Update using Status ID as value
-||
-Name of level 1 owner
-||
-||
 |-
+||sf_Owner ID
+||ID of level 1 owner.
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-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
 ||
-||
-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
 ||
-||
-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
 ||
-||
-sf_Created Date
-||
-Date record was created
-||
-||
-'''Not Updatable'''
 |}
 ==Level 2==
-{| class="wikitable" cellpadding="5px" align="center"
+{| class="wikitable" width="85%" cellpadding="5px" align="center"
-|- style="font-weight: bold; text-align: center;"
+|-
-| style="border: 1px solid gray;" width="5%"|
+! width="20%"|API Field Reference
-''' '''
+! width="25%"|Field Description
+! style="text-align: center;" width="15%"|Allow Get/List
-| style="border: 1px solid gray;" width="25%"|
+! style="text-align: center;" width="15%"|Allow Update
-'''Standard Field Name'''
+! width="25%"|External Notes
+|-
-| style="border: 1px solid gray;" width="25%"|
+||sf_Activity Type
-'''Description'''
+||Returns level 2 type name
+| style="text-align: center;"|✓
-| style="border: 1px solid gray;" width="25%"|
+| style="text-align: center;"|✓
-'''GET Method'''
+||Update using Type ID as value
-| style="border: 1px solid gray;" width="20%"|
-'''UPDATE Method'''
 |-
+||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;"|✓
 ||
-sf_Level Two ID
+|-
+||sf_Duration
+||Duration standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-Activity ID of level 2
+|-
+||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
 ||
+|-
+||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
 ||
+|-
+||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;"|✓
 ||
+|-
+||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;"|✓
 ||
+|-
+||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 standard field
+|-
+||sf_Parent Name
-||
+||Returns Name standard field from parent level 1
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
 |-
+||sf_Longitude
 ||
+| 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
 ||
+Mandatory field for updating records
-||
+Use "recordid" in place of "sf_Level Two ID" in updating records
-sf_Activity Type
+|-
+||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
 ||
+|}
+==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 ID
+|-
+||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;"|✓
 ||
-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
 ||
+|-
+||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 in assigned 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;"|✓
 ||
+|-
+||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 of user IDs in contact 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;"|✓
 ||
+|-
+||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 standard field
+|-
+||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_Start Date
-||
-Start date standard field
-||
-||
 |-
+||sf_Amount
+||Returns value from Amount standard field
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-sf_End Date
-||
-End date standard field
-||
-||
 |-
+||sf_Longitude
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
-||
-sf_Duration
-||
-Duration standard field
-||
 ||
 |-
+||sf_Latitude
 ||
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
-||
-sf_Amount
-||
-Amount standard field
-||
 ||
 |-
+||sf_Level Three ID
+||Returns unique level 3 ID
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
+Mandatory field for updating records
-||
-sf_Status ID
-||
-Status ID of status. 0 if empty
-||
-||
+Use "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;"|✓
-sf_Status
+||Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L3 records
-||
-Status name
-||
-||
 |-
-||
+||sf_Type ID
+||ID of level 3 template
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Owner ID
+||Mandatory field for adding records
-||
-User ID of owner. 0 if empty
-||
-||
 |-
-||
+||sf_Status ID
+||Status ID of level 1 status. 0 if empty
+| style="text-align: center;"|✓
-||
+| style="text-align: center;"|✓
-sf_Owner
+||Mandatory field for adding records
-||
-Name of owner. 0 if empty
-||
-||
 |-
+||sf_Owner ID
+||ID of level 1 owner.
+| style="text-align: center;"|✓
+| style="text-align: center;"|✓
 ||
-||
-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
 ||
-||
-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
 ||
-||
-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
 ||
-||
-sf_Created Date
-||
-Date record was created
-||
-||
-'''Not Updatable'''
 |}
-==Level 3==
-See Level 2.
 ==Multiple Address==
-{| class="wikitable" cellpadding="5px" align="center"
+{| class="wikitable" width="85%" cellpadding="5px" align="center"
-|- style="font-weight: bold; text-align: center;"
+|-
-| style="border: 1px solid gray;" width="5%"|
+! width="20%"|API Field Reference
-| style="border: 1px solid gray;" width="25%"|
+! width="25%"|Field Description
-'''Standard Field Name'''
+! style="text-align: center;" width="15%"|Allow Get/List
+! style="text-align: center;" width="15%"|Allow Update
-| style="border: 1px solid gray;" width="25%"|
+! width="25%"|External Notes
-'''Description'''
+|-
+||sf_Address ID
-| style="border: 1px solid gray;" width="25%"|
+||Unique id in Multiple Address table
-'''GET Method'''
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
-| style="border: 1px solid gray;" width="20%"|
+||Mandatory field for updating records
-'''UPDATE Method'''
+|-
+||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
 ||
-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
 ||
+| 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
 ||
+| 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
 ||
+|}
+==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
 ||
+| 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
 ||
+| 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
 ||
+|-
+||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 field
+Notes 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
 ||
+|-
+||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;"|✓
 ||
+|-
+||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
 ||
+|-
+||consumerid
-||
+||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the consumer UTA L1/L2
-sf_Country
+| style="text-align: center;"|✓
+| style="text-align: center;"|Not Updatable
 ||
-Country name
-||
-''Displays country name''
-||
-''Update using country id or country name<br />''
 |-
+||roleid
+||Connection roleid between consumer/provider
+| style="text-align: center;"|✓
+| style="text-align: center;"|Updatable
 ||
-||
-sf_Last Modified
-||
-date the record was last updated
-||
-||
 |-
+||rolename
+||Connection rolename between consumer/provider
+| style="text-align: center;"|✓
+| style="text-align: center;"|Updatable
 ||
-||
-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;"|
 ||
-||
-sf_Updated By
-||
-Last updated user id
-||
 ||
 |}
 ==See Also==
-[[JSON API (SmartConnect)]] <br />
+[[SmartConnect_-_RESTful_API|SmartConnect - RESTful API]]
-[[JSON API (SmartConnect) Prerequisite]]
 [[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]