==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 GET'''Update | style="border: 1px solid gray;" ! width="2025%"|'''Allow UPDATE'''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;"|✓|||-||sf_Address||| style="text-align: center;"|✓| style="text-align: center;"|✓
||
''' Not Updatable'''
Mandatory field for updating records
|-
||sf_Address 2
||
2| style="text-align: center;"|✓|style="text-align: center;"|sf_Parent Company✓
||
Parent company name|-||sf_City
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
✓
|-
||sf_State / Province
||
3| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Parent Company ID|-||sf_Country
||
Parent company id| 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;"|✓
||
✓
Mandatory field for adding records
|-
||sf_Web Site
||
4| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Longitude
||
sf_Status ID| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Status id|-||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
||
5|-||sf_Parent Company||Parent company name| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Status|-||sf_Owner||Name of User in Owner Standard Field| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Status|-||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
||
6|-||sf_Last Updated||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_Is External|-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
Flag (1|-||sf_Created Date||Date the record was created| style=external, 0"text-align: center;"|✓| style=internal)"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;"|✓
||
✓
Mandatory field for adding records
|-
||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;"|✓
||
7|-||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_Owner |-||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
||
user who created the company|}
==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
||
8| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Email
||
sf_Primary Contact ID| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Primary Contact ID (0 if empty)|-||sf_Title
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
✓
|-
||sf_Prefix
||
| style="text-align: center;"|✓
| style="text-align: center;"|✓
||
9|-||sf_Suffix
||
sf_Primary Contact| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Primary contact name|-||sf_Phone
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
✓
|-
||sf_Phone Ext.
||
10| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Address
||
sf_Name| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Name standard field|-||sf_Address 2
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
✓
|-
||sf_City
||
11| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_State / Province
||
sf_Address| style="text-align: center;"|✓| style="text-align: center;"|✓
||
Address standard field|-||sf_Country
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
✓
|-
||sf_Zip / Postal Code
||
12| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_Address 2|-||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;"|✓
||
Address 2 standard field|-||sf_Longitude
||
| style="text-align: center;"|✓| style="text-align: center;"|✓
||
✓
|-
||sf_Latitude
||
13| style="text-align: center;"|✓| style="text-align: center;"|✓
||
sf_City|-||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
||
City standard field1 ('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
||
14|-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable
||
sf_State / Province
||
Province standard field
||
✓
||
✓
|-
||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
||
15|}
||
sf_Zip / Postal Code
||
Postal code standard field
||
✓
||
✓
|-
||
16
||
sf_Country
||
Country name
||
'' ✓''
'' Displays country name''
||
'' ✓''
''Update using country id or country name<br />''
|-
||
17
||
sf_Phone
||
Phone standard field
||
✓
||
✓
|-
||
18
||
sf_Fax
||
Fax standard field
||
✓
||
✓
|-
||
19
||
sf_Web Site
||
Website standard field
||
✓
||
✓
|-
||
20
||
sf_Category ID List
||
Comma delimited list of category IDs. (Starts and ends with a comma)
||
✓
||
✓
|-
||
21
||
sf_Last Updated
||
date the record was last updated on SmartSimple
||
✓
||
''' Not Updatable'''
|-
||
22
||
sf_Updated By
||
Last updated user name
||
✓
||
''' Not Updatable'''
|-
||
23
||
sf_Created Date
||
date the record was last created on SmartSimple
||
✓
||
''' Not Updatable'''
|-
||
24
||
sf_Created By
||
Created by user name
||
✓
||
''' Not Updatable'''
|}
==Users==
{| class="wikitable" cellpadding="5px" align="center"
|- style="font-weight: bold; text-align: center;"
| style="border: 1px solid gray;" width="5%"|
''' '''
| style="border: 1px solid gray;" width="25%"|
'''Standard Field Name'''
| 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'''
|-
||
1
||
sf_User ID
||
User ID (0 if new user)
||
✓
||
''' Not Updatable'''
Mandatory field for updating records
|-
||
2
||
sf_Is External
||
Flag (1=external, 0=internal)
||
✓
||
✓
''Mandatory field for adding records''
|-
||
3
||
sf_Company ID
||
ID of user's company. 0 if empty.
||
✓
||
'' ✓''
''Mandatory field for adding records''
|-
||
4
||
sf_Company
||
name of user's company
||
✓
||
'' ✓''
|-
||
5
||
sf_Title
||
Title standard field.
||
✓
||
'' ✓''
|-
||
6
||
sf_Prefix
||
Prefix standard field
||
✓
||
'' ✓''
|-
||
7
||
sf_Suffix
||
Suffix standard field
||
✓
||
'' ✓''
|-
||
8
||
sf_First Name
||
First name standard field
||
✓
||
'' ✓''
|-
||
9
||
sf_Last Name
||
Last name standard field
||
✓
||
'' ✓''
|-
||
10
||
sf_Middle Name
||
Middle name standard field
||
✓
||
'' ✓''
|-
||
11
||
sf_Email
||
Email standard field
||
✓
||
'' ✓''
|-
||
12
||
sf_Address
||
Address standard field
||
✓
||
'' ✓''
|-
||
13
||
sf_Address 2
||
Address 2 standard field
||
✓
||
'' ✓''
|-
||
14
||
sf_City
||
City standard field
||
✓
||
'' ✓''
|-
||
15
||
sf_State / Province
||
Province standard field
||
✓
||
'' ✓''
|-
||
16
||
sf_Country
||
Name of country field.
||
'' ✓''
'' Displays country name''
||
'' ✓''
''Update using country id or country name<br />''
|-
||
17
||
sf_Zip / Postal Code
||
Postal code standard field
||
✓
||
'' ✓''
|-
||
18
||
sf_Phone
||
Phone standard field
||
✓
||
'' ✓''
|-
||
19
||
sf_Phone Ext.
||
Phone extension field. (includes period at the end)
||
✓
||
'' ✓''
|-
||
20
||
sf_Role ID List
||
Comma delimited list of role IDs. (Starts and ends with a comma)
||
✓
||
'' ✓''
|-
||
21
||
sf_Access Type
||
1 ('Administration or Portal Interface'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service User','No Access')
||
'' ✓''
'' Displays id''
||
'' ✓''
'' Update using id''
|-
||
22
||
sf_User Type
||
10 (‘User’), 30 (‘Local User Administrator’), 50 (‘Global User Administrator’)
||
'' ✓''
'' Displays name''
||
'' ✓''
'' Update using id''
|-
||
23
||
sf_Status*
||
status name of user
||
'' ✓''
'' Displays name''
||
'' ✓''
'' Update using id''
|-
||
24
||
sf_Status ID*
||
status ID of user
||
'' ✓''
||
'' ✓'''' ''
|-
||
25
||
sf_Updated By
||
name of user who updated the record
||
'' ✓''
||
''' Not Updatable'''
|-
||
||
sf_Last Updated
||
date record was last updated
||
'' ✓''
||
''' Not Updatable'''
|-
||
27
||
sf_Created Date
||
date record was created
||
'' ✓''
||
''' Not Updatable'''
|-
||
28
||
sf_Created By
||
user who created the user
||
'' ✓''
||
''' Not Updatable'''
|}
==Level 1==
==Associations==
not implemented at the moment.
not implemented at the moment.
