Contact object

Methods

The Return Value for all methods is Contact.PagedReturnObject.
Method Name Parameters Contact.PagedReturnObject.ReturnCode Description

Name

Data type (in C#)

RetrievePagedContacts

criteria

Contact.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns a paged list of contacts that meet the criteria

Properties and column mapping

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

c = companyemail
Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

Address1

string

c.ce_address1

varchar(100)

Insert/Update

2

Address2

string

c.ce_address2

varchar(100)

Insert/Update

3

Address3

string

c.ce_address3

varchar(100)

Insert/Update

4

Branch

string

c.ce_branch

varchar(12)

Insert/Update

5

City

string

Insert/Update

6

CityCode

int

c.ce_cty_code

int

Insert/Update

7

Comment

string

c.ce_comment

varchar(256)

Insert/Update

8

ContactId

int

c.ce_id

int

Insert/Update

9

DatasourceID

string

N/A

Not mapped

10

EdiActive

bool

N/A

11

EmailAddress

string

c.email_address

varchar(300)

Insert/Update

12

FaxNumber

string

c.ce_faxnumber

varchar(20)

Insert/Update

13

FirstName

string

c.ce_fname

varchar(40)

Insert/Update

14

HoursOfOperation

string

c.ce_hours_of_operation

varchar(100)

Insert/Update

15

IsAfterHours

bool

c.ce_after_hours

char(1)

Insert/Update

16

IsDefaultContact

bool

c.ce_defaultcontact

char(1)

Insert/Update

17

IsDirty

bool

N/A

Not mapped or used in service

18

IsNew

bool

N/A

Not mapped, set to false during save to update

19

IsValid

bool

N/A

Not mapped or used in service

20

JobTitle

string

c.ce_title

varchar(30)

Insert/Update

21

LoadTimeStamp

DateTime

Insert/Update

Not mapped

22

MailingAddress1

string

c.ce_mail_address1

varchar(100)

Insert/Update

23

MailingAddress2

string

c.ce_mail_address2

varchar(100)

Insert/Update

24

MailingAddress3

string

c.ce_mail_address3

varchar(100)

Insert/Update

25

MailingCity

string

Insert/Update

26

MailingCityCode

int

c.ce_mail_cty_code

int

Insert/Update

27

MailingState

string

Read only

Not mapped

28

MailingZip

string

c.ce_mail_zip

varchar(10)

Insert/Update

29

MobilePhone

string

c.ce_mobilenumber

varchar(20)

Insert/Update

30

Name

string

c.contact_name

varchar(40)

Insert/Update

31

OwnerId

string

c.cmp_id

varchar(8)

Insert/Update

32

OwnerType

string

c.ce_source

varchar(6)

Insert/Update

33

Phone1

string

c.ce_phone1

varchar(20)

Insert/Update

34

Phone1Ext

string

c.ce_phone1_ext

varchar(6)

Insert/Update

35

Phone2

string

c.ce_phone2

varchar(20)

Insert/Update

36

Phone2Ext

string

c.ce_phone2_ext

varchar(6)

Insert/Update

37

Retired

bool

c.ce_retired

char(1)

Insert/Update

38

State

string

Read only

Not mapped

39

TimestampRepoKey

string

Read only

40

Type

string

c.type

varchar(6)

Insert/Update

41

UpdateableProperties

ContactUpdateInfo

N/A

Not mapped

42

UpdateDate

DateTime

c.ce_updatedt

datetime

Read only

43

UpdatedBy

string

c.ce_updatedby

varchar(20)

Read only

44

Zip

string

c.ce_zip

varchar(10)

Insert/Update

Contact.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List<Contact>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

Contact.PagedReturnObject

Property Name Data Type (in C#) Comments

1

PageIndex

int

2

PageSize

int

3

TotalRecords

int

ContactUpdateInfo object

  • Data types (in C#) for all properties are bool.

  • Set the property to true to update the corresponding City property.
Property Name

1

Address1

2

Address2

3

Address3

4

Branch

5

City

6

CityCode

7

Comment

8

ContactId

9

EdiActive

10

EmailAddress

11

FaxNumber

12

FirstName

13

HoursOfOperation

14

IsAfterHours

15

IsDefaultContact

16

JobTitle

17

LoadTimeStamp

18

MailingAddress1

19

MailingAddress2

20

MailingAddress3

21

MailingCity

22

MailingCityCode

23

JobTitle

24

LoadTimeStamp

25

MailingZip

26

MobilePhone

27

Name

28

OwnerId

29

OwnerType

30

Phone1

31

Phone1Ext

32

Phone2

33

Phone2Ext

34

Retired

35

Type

36

Zip

Criteria object

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

c = companyemail
Name Database Column Data Type (in C#) Comments

1

Address1

c.ce_address1

string

2

Address2

c.ce_address2

string

3

Address3

c.ce_address3

string

4

Branch

c.ce_branch

string

5

City

string

6

CityCode

c.ce_cty_code

int?

7

Comment

c.ce_comment

string

8

ContactId

c.ce_id

int?

9

EdiActive

bool?

10

EmailAddress

c.email_address

string

11

FaxNumber

c.ce_faxnumber

string

12

FirstName

c.ce_fname

string

13

HoursOfOperation

c.ce_hours_of_operation

string

14

IsAfterHours

c.ce_after_hours

bool?

15

IsDefaultContact

c.ce_defaultcontact

bool?

16

JobTitle

c.ce_title

string

17

MailingAddress1

c.ce_mail_address1

string

18

MailingAddress2

c.ce_mail_address2

string

19

MailingAddress3

c.ce_mail_address3

string

20

MailingCity

string

21

MailingCityCode

c.ce_mail_cty_code

int?

22

MailingState

string

23

MailingZip

c.ce_mail_zip

string

24

MobilePhone

c.ce_mobilenumber

string

25

Name

c.contact_name

string

26

OwnerId

c.cmp_id

string

27

OwnerType

c.ce_source

string

28

Phone1

c.ce_phone1

string

29

Phone1Ext

c.ce_phone1_ext

string

30

Phone2

c.ce_phone2

string

31

Phone2Ext

c.ce_phone2_ext

string

32

State

string

33

Type

c.type

string

34

UpdateDate

c.ce_updatedt

DateTime?

35

UpdatedBy

c.ce_updatedby

string

36

Zip

c.ce_zip

string

CriteriaSettings object

Name Comments

1

ContactId

2

Type

3

OwnerType

4

OwnerId

5

FirstName

6

Name

7

IsDefaultContact

8

JobTitle

9

EmailAddress

10

EdiActive

11

Comment

12

Phone1

13

Phone1Ext

14

Phone2

15

Phone2Ext

16

MobilePhone

17

FaxNumber

18

Branch

19

Address1

20

Address2

21

Address3

22

CityCode

23

City

24

State

25

Zip

26

MailingAddress1

27

MailingAddress2

28

MailingAddress3

29

MailingCityCode

30

MailingCity

31

MailingState

32

MailingZip

33

UpdatedBy

34

UpdateDate

35

IsAfterHours

36

HoursOfOperation

CriteriaExpression object

Name Data Type (in C#) Comments

1

Criteria

Criteria

2

Conjuction

CriteriaSetting.ConjuctionEnum