Request

Description

deleteContact

Deletes the contact specified by the unique key.

insertContact

Saves a new Contact object to the repository.

readContact

Retrieves a Contact from the repository based on a unique key. For a list of available properties, see the type class, contact.

readContactsByCriteria

Retrieves a set of contacts based on specified criteria. If the criteria is empty, then the search will be for all contacts. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, contact.

ReadRecentlyViewedContacts

Retrieve a list of recently viewed contacts.

updateContact

Updates a previously saved contact.

Data Object

Description

1 Company

2 CompanyCreate

3 CompanyUpdate

All three objects are subclasses of the related Contact objects. The Company objects are used to work with contact records of type, Company.

1 Company contact record property container returned when you read or search companies. When defining a repository search's return properties, refer to the property names defined in this object.

2 Company contact record property container used to set a new company's properties. This object is passed as a request parameter when you create (insert) a company.

3 Company contact record property container used to update or clear a company's properties. This object is passed as a request parameter when you update a company.

Note: CompanyCreate is a subclass of ContactCreate. CompanyUpdate is a subclass of ContactUpdate.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TContact object.

1 Person

2 PersonCreate

3 PersonUpdate

All three objects are subclasses of the related Contact objects. The Person objects are used to work with contact records of type, Person.

1 Person contact record property container returned when you read or search person contacts. When defining a repository search's return properties, refer to the property names defined in this object.

2 Person contact record property container used to set a new person contact's properties. This object is passed as a request parameter when you create (insert) a person contact.

3 Person contact record property container used to update or clear a person contact's properties. This object is passed as a request parameter when you update a person contact.

Note: PersonCreate is a subclass of ContactCreate. PersonUpdate is a subclass of ContactUpdate.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TContact object.

1 ContAddress

2 ContAddressCreate

3 ContAddressUpdate

All three objects are used to work with contact mailing addresses within contact records.

1 Contact address object property container returned when you read or search contacts, including the ContAddress property.

2 Contact address object property container used to set properties for a contact address.

3 Contact address object property container used to update or clear properties for a contact address.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContAddress object.

contAddressType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact address type.

countryItem

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact address country.

1 ContEmailAddress

2 ContEmailAddressCreate

3 ContEmailAddressUpdate

All three objects are used to work with contact email addresses within contact records.

1 Contact email address object property container returned when you read or search contact email addresses.

2 Contact email address object property container used to set properties for a contact email address.

3 Contact email address object property container used to update or clear properties for a contact email address.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContEmail object.

contEmailAddressType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact email address' associated type.

1 ContFaxNumber

2 ContFaxNumberCreate

3 ContFaxNumberUpdate

All three objects are used to work with contact fax numbers within contact records.

1 Contact fax number object property container returned when you read or search contact fax numbers.

2 Contact fax number object property container used to set properties for a new contact fax number.

3 Contact fax number object property container used to update or clear properties for a contact fax number.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContFax object.

contFaxNumberType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact fax number's associated type.

1 ContInetAddress

2 ContInetAddressCreate

3 ContInetAddressUpdate

All three objects are used to work with contact internet addresses (website URL's) within contact records.

1 Contact internet address object property container returned when you read or search contact internet addresses.

2 Contact internet address object property container used to set properties for a new contact internet address.

3 Contact internet address object property container used to update or clear properties for a contact internet address.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContInetAddress object.

contInetAddressType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact email address' associated type.

1 ContPhoneNumber

2 ContPhoneNumberCreate

3 ContPhoneNumberUpdate

All three objects are used to work with contact phone numbers within contact records.

1 Contact phone number object property container returned when you read or search contact phone numbers.

2 Contact phone number object property container used to set properties for a new contact phone number.

3 Contact phone number object property container used to update or clear properties for a contact phone number.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContPhone object.

contPhoneNumberType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact phone number's associated type.

1 ContDefaultRate

2 ContDefaultRateCreate

3 ContDefaultRateUpdate

All three objects are used to work with contact default rates within contact records.

1 Contact default rate object property container returned when you read or search contact default rates.

2 Contact default rate object property container used to set properties for a new contact default rate.

3 Contact default rate object property container used to update or clear properties for a contact default rate.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

1 contTaskRate

2 contTaskRateCreate

3 contTaskRateUpdate

All three objects are used to work with contact task rates within contact records.

1 Contact task rate object property container returned when you read or search contacts.

2 Container used to set properties for contact invoice task rates.

3 Contact rate object property container used to update or clear properties for contact invoice task rates.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

1 contInvoiceTaskRate

2 contInvoiceTaskRateCreate

3 contInvoiceTaskRateUpdate

All three objects are used to work with contact invoice task rates within contact records.

1 Contact invoice task rate object property container returned when you read or search contacts.

2 Container used to set properties for contact invoice task rates.

3 Contact rate object property container used to update or clear properties for contact invoice task rates.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

1 contDefaultRate

2 contDefaultRateCreate

3 contDefaultRateUpdate

All three objects are used to work with default contact rates within contact records.

1 Default contact rate object property container returned when you read or search contacts.

2 Default contact rate object property container used to set properties for a default contact rate.

3 Default contact rate object property container used to update or clear properties for a default contact rate.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

currencyItem

Subclass of lookupItem. This class corresponds to the TeamConnect Multi-currency lookup table's items.

Use the provided get methods to read the properties related to either a contact rate's currency or invoice currency.

The currencyItem name property corresponds to the TeamConnect multi-currency lookup table Currency code.

The currencyItem name property

1 ContRelation

2 ContRelationCreate

3 ContRelationUpdate

All three objects are used to work with contact relations within contact records.

1 Contact relation object property container returned when you read or search contact relations.

2 Contact relation object property container used to set properties for a new contact relation.

3 Contact relation object property container used to update or clear properties for a contact relation.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRelation object.

contRelationType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact relation's associated type.

relationDirection

An enumeration used to identify the direction between two relations. Options include:

•FROM_THIS

•TO_THIS

1 ContSkill

2 ContSkillCreate

3 ContSkillUpdate

All three objects are used to work with contact skills within contact records.

1 Contact skill object property container returned when you read or search contact skills.

2 Contact skill object property container used to set properties for a new contact skill.

3 Contact skill object property container used to update or clear properties for a contact skill.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContSkill object.

contSkillType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact skill's associated type.

1 ContTerritory

2 ContTerritoryCreate

3 ContTerritoryUpdate

All three objects are used to work with contact territories within contact records.

1 Contact territory object property container returned when you read or search contact territories.

2 Contact territory object property container used to set properties for a new contact territory.

3 Contact territory object property container used to update or clear properties for a contact territory.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContTerritory object.

contTerritoryItem

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact territory.