UnifiedPerson DTO v8

Field Name Type Required Constraint Reference Description
branchCode String Optional length >= 1 & length <= 255 System code of the employee branch object.
branchName String Optional length >= 1 & length <= 255 System name of the employee branch object.
code String Optional length >= 1 & length <= 255 System code of this object, normally this correlates to the erp id given by the source system.
maxDistanceRadius Integer Optional Radius of service area for the given technician (km).
departmentCode String Optional length >= 1 & length <= 255 System code of the employee department object.
departmentName String Optional length >= 1 & length <= 255 System name of the employee department object.
emailAddress String Optional length >= 1 & length <= 255 EMail address.
externalResource Boolean Optional Whether the resource is external.
fax String Optional length >= 1 & length <= 255 Fax.
firstName String Optional length >= 1 & length <= 255 First name.
homePhone String Optional length >= 1 & length <= 255 Home phone.
jobTitle String Optional length >= 1 & length <= 255 Job title.
lastName String Optional length >= 1 & length <= 255 Last name.
locationLastUserChangedDate DateTime Optional Required to know when the person location has been last time updated.
loginEnabled Boolean Optional Flag used to indicate if we have a cloud user (user account) created on MC for this person. Is applicable only for persons of type PersonType.ERPUSER
manager Identifier Optional UnifiedPerson : 8 References the person of PersonType.EMPLOYEE which is the manager of this person.
mobilePhone String Optional length >= 1 & length <= 255 Mobile phone.
officePhone String Optional length >= 1 & length <= 255 Office phone.
otherPhone String Optional length >= 1 & length <= 255 Other phone.
pager String Optional length >= 1 & length <= 255 Pager.
personStatus UnifiedPersonStatusDTO_V8 Optional The status of the person.
plannableResource boolean Required True if the person can be planned in the resource planner and displayed in the map. By default is set to TRUE to ensure backward compatibility.
positionCode String Optional length >= 1 & length <= 255 System code of the employee position object.
positionName String Optional length >= 1 & length <= 255 System name of the employee position object.
refId Identifier Required UnifiedPerson : 8 Unique identifier of the physical representation multiple person objects. See header for more information.
remarks String Optional length >= 1 Remarks or notes of this activity, can be used for any string based content which contains necessary information.
salesEmployee Identifier Optional Person : 15, 16, 17, 18, 19, 20 Used in sales documents.
skypeName String Optional length >= 1 & length <= 255 The account name of the Skype service.
types Set<PersonType> Optional
userName String Optional length >= 1 & length <= 255 The user name of the person in the backend system.