Service: Person

Reading and editing persons

Provices read/write access to the person Data Objects.

Functions

Result	Name / Params			Comment
GetResult	person.Get			Returns a filtered list of Person Objects.
		filter	string	(Optional) Filter expression which determines the result set.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
GetResult	person.Get			Returns a filtered list of Person Objects as a follow up to a previous Get call.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		scroll	int	Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
Person	person.GetOne			Returns a single Person Object identified by the given id.
		id	guid	The Person's id.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	person.Create			Creates the Person in the system and returns the id of the Person. The Person must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	Person	The Person to create.
bool	person.Update			Updates a Person with data from the provided Object.
bool		object	Person	Person to update
bool	person.Set			Sets specific properties of a Person Object.
		id	guid	Id of the Person to modify.
		props	value{}	List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	person.Delete			Deletes a Person Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Person to delete.
bool	person.BulkModify			Performs a bulk of changes at once.
		create	Person[]	(Optional) List of Person Objects to create.
		update	Person[]	(Optional) List of Person Objects to update.
		set	ObjectAspect[]	(Optional) List of Person Object properties to set.
		delete	guid[]	(Optional) List of Person ids to delete.

Notifications

Name / Params			Comment
person.Created			Notifies about new Person Objects.
	objects	Person[]	Newly created Person Objects.
person.Updated			Notifies about updated Person Objects.
	objects	Person[]	Changed Person Objects.
person.Deleted			Notifies about deleted Person Objects.
	ids	guid[]	Ids of the deleted Person Objects.

Objects

Person

Property	Type	Description
Id	guid	(Unique, Readonly) Internal unique id of the Person Data Object.
SegmentId	guid	Assigned data segment.
LastName	string
FirstName	string
Title	string
Company	string
Department	string
Position	string
Street	string
Zip	string
City	string
PhoneCompany	string
PhonePrivate	string
PhoneMobile	string
PhoneMobilePrivate ≥wg 0.5.2	string
PhoneMobileAssistant ≥wg 0.5.2	string
Pager	string
Fax	string
SipAddress	string
Email	string
Website	string
Language	string
Info	string
SubstituteId	guid
IsSubstituted	bool
IsDeactivated ≥wg 0.5.2	bool	Whether the person is deactivated.
ExtRef	string
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

Last modified September 25, 2026