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

From SmartWiki
Jump to: navigation, search
(→‎Level 2)
Line 1,553: Line 1,553:
 
==Level 3==
 
==Level 3==
 
See Level 2.
 
See Level 2.
 +
 +
 +
==Multiple Address==
 +
 +
{| 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_Address ID
 +
 +
||
 +
Unique id in Multiple Address table
 +
 +
||
 +
 +
||
 +
 +
|-
 +
||
 +
2
 +
 +
||
 +
sf_Object ID
 +
 +
||
 +
companyid / contactid / providerid / consumerid
 +
 +
||
 +
 +
||
 +
 +
|-
 +
||
 +
3
 +
 +
||
 +
sf_Type ID
 +
 +
||
 +
Multiple Address Type ID
 +
 +
||
 +
 +
||
 +
 +
|-
 +
||
 +
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''
 +
 +
|-
 +
||
 +
11
 +
 +
||
 +
sf_Last Modified
 +
 +
||
 +
date the record was last updated on SmartSimple
 +
 +
||
 +
 +
||
 +
 +
|-
 +
||
 +
12
 +
 +
||
 +
sf_Primary Address
 +
 +
||
 +
Is primary address (1=yes, 0=no)
 +
 +
||
 +
 +
||
 +
 +
|-
 +
||
 +
13
 +
 +
||
 +
sf_Updated By
 +
 +
||
 +
Last updated user id
 +
 +
||
 +
 +
||
 +
 +
|}
 +
  
  

Revision as of 12:21, 5 May 2017

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
Prefix Standard fields with "sf_" sf_Name

Companies

 

Standard Field Name

Description

GET Method

UPDATE Method

1

sf_Company ID

Company id. (0 if new company)

Not Updatable

2

sf_Parent Company

Parent company name

3

sf_Parent Company ID

Parent company id

4

sf_Status ID

Status id

5

sf_Status Caption

Status Caption

6

sf_Status

Status

7

sf_Is External

Flag (1=external, 0=internal)

8

sf_Owner ID

user who created the company

9

sf_Primary Contact ID

Primary contact ID. (0 if empty)

10

sf_Primary Contact

Primary contact name

11

sf_Name

Name 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_Zip / Postal Code

Postal code standard field

17

sf_Country

Country name

Displays country name

Update using country id

18

sf_Phone

Phone standard field

19

sf_Fax

Fax standard field

20

sf_Web Site

Website standard field

21

sf_Category List

Comma delimited list of category IDs. (Starts and ends with a comma)

22

sf_Last Updated

date the record was last updated on SmartSimple

Not Updatable

23

sf_Last Updated By

Last updated user name

24

sf_Created Date

date the record was last created on SmartSimple

Not Updatable

25

sf_Created By

Created by user name

Not Updatable

Users

 

Standard Field Name

Description

GET Method

UPDATE Method

1

sf_User ID

User ID (0 if new user)

Not Updatable


2

sf_Is External

Flag (1=external, 0=internal)

3

sf_Company ID

ID of user's company. 0 if empty.

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

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_User Role

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_Status Caption

Status caption

 

 

26

sf_Updated By

name of user who updated the record

27

sf_Last Updated

date record was last updated

Not Updatable


28

sf_Created Date

date record was created

Not Updatable


29

sf_Created By

user who created the user

Level 1

 

Standard Field Name

Description

GET Method

UPDATE Method

1

sf_Level One ID

Tracking ID of level 1

Not Updatable


2

sf_Application ID

UTA ID

3

sf_Company ID

Company ID of level 1 company/client field. 0 if empty

sf_Customer

Name of company

4

sf_Branch ID

Company ID of level 1 branch field. 0 if empty

5

sf_Person ID

User ID of level 1 people field. 0 if empty

6

Sf_Person

Name of Person

7

sf_Type ID

ID of level 1 template

8

sf_Application Type

Level 1 template type name

9

sf_Application Name

Name standard field

10

sf_Description

Description standard field

11

sf_Requirement

Requirement standard field

12

sf_Status ID

Status ID of level 1 status. 0 if empty

13

sf_Status

Name of level 1 status

14

sf_Revenue

Revenue standard field

15

sf_Start Date

Start date standard field

16

sf_End Date

End date standard field

17

sf_Close Date

Close date standard field

18

sf_Probability

Probability standard field

41.19

sf_Owner ID

ID of level 1 owner.

20

sf_Owner

Name of level 1 owner

21

sf_Modified By

Name of user who modified the record

Not Updatable


22

sf_Modified Date

Date the record was modified

Not Updatable


23

sf_Created By

Name of user who created the record

Not Updatable

 

24

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


2

sf_Application ID

UTA ID

3

sf_Description

Description standard field

4

sf_Subject

Subject standard field

5

sf_Type ID

ID of level 2/3 type

6

sf_Activity Type

Level 2/3 type name

7

sf_Parent ID

Parent object ID

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

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

20

sf_Last Modified

Date the record was modified

Not Updatable


21

sf_Created By

Name of user who created the record

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

2

sf_Object ID

companyid / contactid / providerid / consumerid

3

sf_Type ID

Multiple Address Type ID

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

11

sf_Last Modified

date the record was last updated on SmartSimple

12

sf_Primary Address

Is primary address (1=yes, 0=no)

13

sf_Updated By

Last updated user id



See Also

JSON API (SmartConnect)
JSON API (SmartConnect) Prerequisite

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=SmartConnect_-_Appendix:_Standard_Field_Names&oldid=29430’