Person address

Important

The functionality noted in this article is currently available in both the stand-alone Dynamics 365 Human Resources and the merged Finance infrastructure. Navigation might be different than noted while we make updates. If you need to find a specific page, you can use Search.

Applies to these Dynamics 365 apps:
Human Resources

This article describes the Person address entity for Dynamics 365 Human Resources.

Physical name: mshr_hcmpersonaddressentities

Description

This entity contains the list of postal addresses for candidate records.

JSON representation

{
    "mshr_partynumber": "String",
    "mshr_locationid": "String",
    "mshr_description": "String",
    "mshr_roles": "String",
    "mshr_countryregionid": "String",
    "mshr_zipcode": "String",
    "mshr_street": "String",
    "mshr_city": "String",
    "mshr_state": "String",
    "mshr_county": "String",
    "mshr_isprimary": Int,
    "mshr_isprivate": Int,
    "mshr_primaryfield": "String",
    "_mshr_fk_person_id_value": "Guid",
    "_mshr_fk_countryregion_id_value": "Guid",
    "mshr_hcmpersonaddressentityid": "Guid"
}

Properties

Property
Physical name
Type
Use Description
Person Address Entity ID
mshr_hcmpersonaddressentityid
String
Read-only
Required
System-generated unique identifier for the entity record.
Party Number
mshr_partynumber
String
Read/write
Required
The ID of the associated party (person) record.
Person ID Value
_mshr_fk_person_id_value
GUID
Read-only
Required
Foreign key: mshr_dirpersonentityid of mshr_dirpersonentity
The system-generated identifier of the party (person) entity record.
Location ID
mshr_locationid
String
Read/write
Required
The location ID of the address record. Set up in mshr_logisticspostaladdresslocationcdsentity entity.
Description
mshr_description
String
Read/write
Required
A description of the candidate’s address.
Roles
mshr_roles
String
Read/write
Required
The roles assigned for this address. More than one role can be assigned. Each role should be separated by a semicolon. Valid values contained in the mshr_logisticslocationroleentity entity.
Street
mshr_street
String
Read/write
Optional
The street number.
City
mshr_city
String
Read/write
Optional
The city of the address. Set up in mshr_logisticsaddresscityentity entity.
State
mshr_state
String
Read/write
Optional
The state of the address. Set up in mshr_logisticsaddressstateentity entity.
County
mshr_county
String
Read/write
Optional
The county of the address. Set up in mshr_logisticsaddresscountyentity entity.
Zip Code
mshr_zipcode
String
Read/write
Optional
The zip/postal code of the address. Set up in mshr_logisticsaddresspostalcodeentity entity.
Country Region ID
mshr_countryregionid
String
Read/write
Optional
The country or region of the address.
Country/Region ID Value
_mshr_fk_countriregion_id_value
GUID
Read-only
Optional
Foreign key: mshr_logisticaddresscountryregionentityid of mshr_logisticsaddresscountryregionentity
System-generated unique identifier of the country/region of the address.
Is Primary
mshr_isprimary
mshr_noyes option set
Read/write
Required
Identifies whether this address is the primary address for the person of the defined role.
Is Private
mshr_isprivate
mshr_noyes option set
Read/write
Required
Identifies whether this address is a private address for the person.
Primary Field
mshr_primaryfield
String
Read-only
Required
Field used as a primary identifier of the entity record. Combination of party number and location ID.

See also

Applicant Tracking System integration API introduction
Example query for Candidate to hire