PeopleProject/Structures

Structures

A list of many people and companies which are contacts.

Field Name	Is Required	Type	Description
Name	Required	Text	A short simple name describing the address book.
People	Required	Object List	List of people who are contactable.
Companies	Required	Object List	List of companies who are contactable.

Information about a location which allows you to find the place and send mail there.

Field Name	Is Required	Type	Description
Type	Optional	Selection	The type of address:* Work Place, * Residence, * Public Place
Building	Required	Text	Name or house number of the building.
Street	Required	Text	Street or Road the building is on.
District	Optional	Text	City or Town.
Region	Optional	Text	State or County.
Country	Optional	ISO Country Code	Country code.
Code	Optional	Text	Mailing Post Code.
Phone	Optional	Text	General phone number for this address.
Fax	Optional	Text	Fax phone number for this address.

An object describing a contact, friend or relation.

Field Name	Is Required	Type	Description
Name	Required	Object	Full name of the person, Person Name Object
Relationship	Optional	Text	The relationship roll this person has with you.
Residence	Optional	Object List	List of Address objects for where this person lives.
Work	Optional	Object List	List of Company Person objects for who this person works for.
Phone	Optional	Text List	List of mobile phone numbers.
Email	Optional	Text List	List of personal email addresses.
IM	Optional	Object List	List of instant message addresses, IM Objects
Occasion	Optional	Object List	List of important dates, birthdays, anniversaries etc. Event Objects?
Website	Optional	HTTP Address	Personal website address.
Avatar	Optional	PNG Image	No more than 128x128 pixel image used as an Avatar. Photo is used by default.
Photo	Optional	PNG Image	No more than 400x400 pixel photo used as a physical image of the person.

Describes all parts of a name as well as allowing a single name string to be allowed.

Field Name	Is Required	Type	Description
Title	Optional	Text	Title to use, i.e. Her Royal Highness.
Personal	Optional	Text	Personal, given or first name.
Middle	Optional	Text List	Middle Names, list of
Family	Optional	Text	Family Name
Suffix	Optional	Text List	List of suffixes
Full	Required	Text	The full name, will combine all other fields to get full name.

A simple object for describing a user of an IM system.

Field Name	Is Required	Type	Description
Username	Required	Text	The unique name this person uses.
System	Required	Text	The IM system this user is on, if an ip or address is provided Jabber is assumed.
Status	Optional	Selection	What status is this IM in, offline, online, busy, away.

Inherits from Company, ties a person to a company.

Field Name	Is Required	Type	Description
Position	Optional	Text	What position or roll does this person have at this company.
Office	Optional	Object	Address where this person works, default is company primary address.
Department	Optional	Text	Department this person occupies in the company.
Manager	Optional	Person	Person that directly manages this person at this job.
Assistant	Optional	Person	Person that assists this person at this job.

Field Name	Is Required	Type	Description
Name	Optional	Text	Company name (trading name)
Offices	Optional	Object List	List of addresses that this company has as offices.
Contact	Optional	Object	Person who is elected main contact.
Phone	Optional	Text	Public company phone number (default is first address phone number)

PeopleProject/Structures (last edited 2008-08-06 16:26:33 by localhost)