Difference between revisions of "SmartConnect - Appendix: Standard Field Names"
(Updating table format for all sections.) |
|||
Line 19: | Line 19: | ||
==Companies== | ==Companies== | ||
− | {| class="wikitable" cellpadding="5px" align="center" | + | {| 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_Name | ||
+ | ||Name of current company | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|✓ | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Phone | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||sf_Fax | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
+ | || | ||
+ | |- | ||
+ | ||sf_Address | ||
+ | || | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|✓ | ||
|| | || | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
+ | ||sf_Address 2 | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
− | || | ||
− | |||
− | |||
|| | || | ||
− | + | |- | |
− | + | ||sf_City | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_State / Province | ||
|| | || | ||
− | + | | 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_Web Site | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
+ | || | ||
+ | |- | ||
+ | ||sf_Longitude | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||sf_Latitude | |
|| | || | ||
− | + | | 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 | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Owner | |
+ | ||Name of User in Owner Standard Field | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|Not Updatable | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Company Workflow | |
+ | ||ID of Company workflow standard field | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|✓ | ||
|| | || | ||
− | + | |- | |
− | + | ||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 | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Created By | |
+ | ||Name of user that created 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_Status | |
+ | ||Returns Status name | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|✓ | ||
+ | ||Update using Status ID as value | ||
+ | |- | ||
+ | ||sf_Company ID | ||
+ | ||Company id. (0 if new company) | ||
+ | | style="text-align: center;"|✓ | ||
+ | | 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;"|✓ | ||
|| | || | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
+ | ||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;"|✓ | ||
|| | || | ||
− | + | |- | |
− | + | ||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;"|✓ | ||
+ | ||Mandatory field for adding records | ||
+ | |- | ||
+ | ||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 | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_Last Name | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
+ | || | ||
+ | |- | ||
+ | ||sf_Email | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||sf_Title | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_Prefix | ||
+ | || | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|✓ | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Suffix | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||sf_Phone | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_Phone Ext. | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
+ | || | ||
+ | |- | ||
+ | ||sf_Address | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||sf_Address 2 | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_City | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
+ | || | ||
+ | |- | ||
+ | ||sf_State / Province | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||sf_Country | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_Zip / Postal Code | ||
|| | || | ||
− | + | | 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 Country ID or Country name as value | ||
+ | |- | ||
+ | ||sf_Middle Name | ||
+ | || | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|✓ | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Longitude | |
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | |||
− | |||
|- | |- | ||
+ | ||sf_Latitude | ||
|| | || | ||
− | + | | style="text-align: center;"|✓ | |
− | + | | style="text-align: center;"|✓ | |
|| | || | ||
− | + | |- | |
− | + | ||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 | ||
|| | || | ||
− | + | 1 ('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 | ||
|| | || | ||
− | + | |- | |
− | + | ||sf_Last Updated | |
+ | ||Date record was last updated | ||
+ | | 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_Created Date | |
+ | ||Date the record was created | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|Not Updatable | ||
|| | || | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
+ | ||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;"|✓ | ||
+ | ||Mandatory field for adding records | ||
+ | |- | ||
+ | ||sf_Status Caption | ||
+ | ||Returns Status Caption | ||
+ | | style="text-align: center;"|✓ | ||
+ | | style="text-align: center;"|Not Updatable | ||
|| | || | ||
− | + | |} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==Level 1== | ==Level 1== | ||
Line 1,978: | Line 1,470: | ||
==Associations== | ==Associations== | ||
+ | not implemented at the moment. | ||
− | |||
Revision as of 11:34, 22 June 2018
The following lists the database field names associated with Standard Fields.
These are used in JSON API (SmartConnect).
Contents
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) | ✓ | ✓ | Mandatory field for adding records |
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 Country ID or Country 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) | ✓ | ✓ | Mandatory field for adding records |
sf_Status Caption | Returns Status Caption | ✓ | Not Updatable |
Level 1
|
Standard Field Name |
Description |
GET Method |
UPDATE Method |
1 |
sf_Level One ID |
Tracking ID of level 1 |
✓ |
Not Updatable Mandatory field for updating records |
2 |
sf_Application ID |
UTA ID |
✓ |
✓ Mandatory field for updating records |
3 |
sf_Company ID |
Company ID of level 1 company/client field. 0 if empty |
✓ |
✓ |
4 |
sf_Customer |
Name of company |
✓ |
✓ |
5 |
sf_Branch ID |
Company ID of level 1 branch field. 0 if empty |
✓ |
✓ |
6 |
sf_Person ID |
User ID of level 1 people field. 0 if empty |
✓ |
✓ |
7 |
Sf_Person |
Name of Person |
✓ |
✓ |
8 |
sf_Type ID |
ID of level 1 template |
✓ |
✓ Mandatory field for adding records |
9 |
sf_Application Type |
Level 1 template type name |
✓ |
✓ |
10 |
sf_Application Name |
Name standard field |
✓ |
✓ |
11 |
sf_Description |
Description standard field |
✓ |
✓ |
12 |
sf_Requirement |
Requirement standard field |
✓ |
✓ |
13 |
sf_Status ID |
Status ID of level 1 status. 0 if empty |
✓ |
✓ Mandatory field for adding records |
14 |
sf_Status |
Name of level 1 status |
✓ |
✓ |
15 |
sf_Revenue |
Revenue standard field |
✓ |
✓ |
16 |
sf_Start Date |
Start date standard field |
✓ |
✓ |
17 |
sf_End Date |
End date standard field |
✓ |
✓ |
18 |
sf_Close Date |
Close date standard field |
✓ |
✓ |
19 |
sf_Probability |
Probability standard field |
✓ |
✓ |
20 |
sf_Owner ID |
ID of level 1 owner. |
✓ |
✓ |
21 |
sf_Owner |
Name of level 1 owner |
✓ |
✓ |
22 |
sf_Modified By |
Name of user who modified the record |
✓ |
Not Updatable |
23 |
sf_Modified Date |
Date the record was modified |
✓ |
Not Updatable |
24 |
sf_Created By |
Name of user who created the record |
✓ |
Not Updatable |
25 |
sf_Created Date |
Date record was created |
✓ |
Not Updatable |
Level 2
|
Standard Field Name |
Description |
GET Method |
UPDATE Method |
1 |
sf_Level Two ID |
Activity ID of level 2 |
✓ |
Not Updatable Mandatory field for updating records |
2 |
sf_Application ID |
UTA ID |
✓ |
✓ Mandatory field for updating records |
3 |
sf_Description |
Description standard field |
✓ |
✓ |
4 |
sf_Subject |
Subject standard field |
✓ |
✓ |
5 |
sf_Type ID |
ID of level 2/3 type |
✓ |
✓ Mandatory field for adding records |
6 |
sf_Activity Type |
Level 2/3 type name |
✓ |
✓ |
7 |
sf_Parent ID |
Parent object ID |
✓ |
✓ Mandatory field for adding records User "objectid" in place of "sf_Parent ID" for new L2 records |
8 |
sf_Assign Person |
Comma delimited list of user IDs in assigned standard field |
✓ |
✓ |
9 |
sf_Contact Person |
Comma delimited list of user IDs in contact standard field |
✓ |
✓ |
10 |
sf_Location |
Location standard field |
✓ |
✓ |
11 |
sf_Start Date |
Start date standard field |
✓ |
✓ |
12 |
sf_End Date |
End date standard field |
✓ |
✓ |
13 |
sf_Duration |
Duration standard field |
✓ |
✓ |
14 |
sf_Amount |
Amount standard field |
✓ |
✓ |
15 |
sf_Status ID |
Status ID of status. 0 if empty |
✓ |
✓ Mandatory field for adding records |
16 |
sf_Status |
Status name |
✓ |
✓ |
17 |
sf_Owner ID |
User ID of owner. 0 if empty |
✓ |
✓ |
18 |
sf_Owner |
Name of owner. 0 if empty |
✓ |
✓ |
19 |
sf_Updated By |
Name of user who updated the record |
✓ |
Not Updatable |
20 |
sf_Last Modified |
Date the record was modified |
✓ |
Not Updatable |
21 |
sf_Created By |
Name of user who created the record |
✓ |
Not Updatable |
22 |
sf_Created Date |
Date record was created |
✓ |
Not Updatable |
Level 3
See Level 2.
Multiple Address
Standard Field Name |
Description |
GET Method |
UPDATE Method | |
1 |
sf_Address ID |
Unique id in Multiple Address table |
✓ |
Not Updatable Mandatory field for updating records |
2 |
sf_Object ID |
companyid / contactid / providerid / consumerid |
✓ |
✓ Mandatory field for adding records |
3 |
sf_Type ID |
Multiple Address Type ID |
✓ |
✓ Mandatory field for adding records |
4 |
sf_Type |
Type name |
✓ |
✓ |
5 |
sf_Address |
Address standard field |
✓ |
✓ |
6 |
sf_Address 2 |
Address 2 standard field |
✓ |
✓ |
7 |
sf_City |
City standard field |
✓ |
✓ |
8 |
sf_State / Province |
Province standard field |
✓ |
✓ |
9 |
sf_Zip / Postal Code |
Postal code standard field |
✓ |
✓ |
10 |
sf_Country |
Country name |
✓ Displays country name |
✓ Update using country id or country name |
11 |
sf_Last Modified |
date the record was last updated |
✓ |
Not Updatable |
12 |
sf_Primary Address |
Is primary address (1=yes, 0=no) |
✓ |
✓ Mandatory field for adding records |
13 |
sf_Updated By |
Last updated user id |
✓ |
Not Updatable |
Associations
not implemented at the moment.
See Also
JSON API (SmartConnect)
JSON API (SmartConnect) Prerequisite