Jump to

• Request
• Response

Get all person profiles

get

/fscmRestApi/resources/11.13.18.05/hedPersonProfiles

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • AdvancedSearchFinder Finds all person profiles that match the specified finder variables.
    Finder Variables
    • DateOfBirth_EQUAL_TO; string; Date value to find person profiles whose date of birth is equal to this value.
    • DateOfBirth_GREATER_OR_EQUALS; string; Date value to find person profiles whose date of birth is greater or equal to this value.
    • DateOfBirth_GREATER_THAN; string; Date value to find person profiles whose date of birth is greater than this value.
    • DateOfBirth_LESS_OR_EQUALS; string; Date value to find person profiles whose date of birth is less or equal to this value.
    • DateOfBirth_LESS_THAN; string; Date value to find person profiles whose date of birth is less than this value.
    • DateOfBirth_NOT_EQUAL; string; Date value to find person profiles whose date of birth isn't equal to this value.
    • Keyword; string; Keyword; string; to search from Name, Email ID, Party ID, User Name, and Constituent ID.
    • ResidencyCode_EQUAL_TO; string; String value to find person profiles with at least one residency code matching this value.
    • ResidencyCode_NOT_EQUAL; string; String value to find person profiles with no residency code matching this value.
    • TagCodeEight_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeEight_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeFive_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeFive_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeFour_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeFour_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeNine_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeNine_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeOne_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeOne_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeSeven_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeSeven_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeSix_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeSix_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeTen_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeTen_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeThree_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeThree_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
    • TagCodeTwo_EQUAL_TO; string; String value to find person profiles with one assigned tag code matching this value.
    • TagCodeTwo_NOT_EQUAL; string; String value to find person profiles with no assigned tag code matching this value.
  • ByEmailFinder Find the person profile that has the specified email address.
    Finder Variables
    • EmailAddress; string; Email address to search for the person profile.
  • ByIntentFinder Finds all person profiles for a particular intent.
    Finder Variables
    • Intent; string; Intent; string; is a value that represents how the returned records are used. For example, if the intent value is HEY_CREATE_ADMISSIONS_APPLICATION_DATA, that means the server understands that it should only return person profiles for which the user can create admissions applications. If no intent is passed, the server will assume that the intent is to only view person profiles.
  • ByKeywordFinder Finds all person profiles that match the Name, Email ID, Party ID, User Name, and Constituent ID.
    Finder Variables
    • Keyword; string; Keyword; string; to search from Name, Email ID, Party ID, User Name, and Constituent ID.
  • ByPartyIdFinder Finds the person profile that matches the Party ID.
    Finder Variables
    • PartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
  • PrimaryKey Finds the person profile that matches the Party ID, Person Profile ID, and Citizenship ID.
    Finder Variables
    • PartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BirthCountryCode; string; The country where this person was born.
  • BirthCountryName; string; The name of the birth country code.
  • CitizenshipStatusCode; string; The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
  • CitizenshipStatusDate; string; The date from which the citizenship status was valid.
  • CitizenshipStatusMeaning; string; The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
  • ConstituentId; string; The unique identifier for a constituent.
  • CriminalHistoryExplanation; string; The description of any criminal history.
  • CriminalHistoryFlag; boolean; Indicates whether criminal history exists for the person.
  • DateOfBirth; string; The date when the person was born.
  • DateOfDeath; string; The date when the person died.
  • DeathCertificateNumber; string; The death certificate number of the person.
  • DeceasedFlag; boolean; Indicates if the person is deceased.
  • EthnicityCode; string; The unique code for ethnicity. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
  • EthnicityMeaning; string; The meaning of ethnicity for a person. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
  • EthnicityValue; string; The value of ethnicity for a person.
  • FirstName; string; The first name of the person.
  • FullName; string; The full name of the person.
  • GenderCode; string; The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.
  • GenderExpressionCode; string; The unique code for gender expression. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
  • GenderExpressionMeaning; string; The gender expression that defines how user shows their gender. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
  • GenderExpressionValue; string; The value of gender expression for a person.
  • GenderIdentityCode; string; The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
  • GenderIdentityMeaning; string; The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
  • GenderIdentityValue; string; The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.
  • GenderMeaning; string; The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER.
  • HispanicOrLatinoCode; string; The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
  • HispanicOrLatinoMeaning; string; The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
  • LastName; string; The last name of the person.
  • MaritalStatusCode; string; The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.
  • MaritalStatusEffectiveDate; string; The date when the person's marital status changed.
  • MaritalStatusMeaning; string; The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.
  • PartyId; integer; The unique identifier for the party. Party can be a person. For example, a student can be a party.
  • PlaceOfBirth; string; The place of birth of the student.
  • PlaceOfDeath; string; The place of death of the person.
  • PreferredFirstName; string; The preferred first name of the person.
  • PreferredFullName; string; The preferred full name of the person.
  • PreferredLastName; string; The preferred last name of the person.
  • PreferredMiddleName; string; The preferred middle name of the person.
  • PreferredPronounsCode; string; The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
  • PreferredPronounsMeaning; string; The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
  • PreferredPronounsValue; string; The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.
  • PreferredTitle; string; The preferred title of the person, such as Mr or Mrs.
  • PrimaryEmailAddress; string; The primary email address of the person.
  • PrimaryLanguageCode; string; The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
  • PrimaryLanguageMeaning; string; The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
  • PrimaryLanguageValue; string; The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.
  • PrimaryPhoneAreaCode; string; The country area code for the primary phone number of the person.
  • PrimaryPhoneCountryCode; string; The international country code for the primary phone number of the person.
  • PrimaryPhoneExtension; string; The extension number for the primary phone number of the person.
  • PrimaryPhoneNumber; string; The primary phone number of the person.
  • PrivacyFlag; boolean; Indicates whether privacy restrictions are activated for this person. The default value is: true.
  • ResidenceCountryCode; string; The country this person normally resides in.
  • ResidenceCountryName; string; The name of the residency country code.
  • SchoolDisciplineExplanation; string; The description of any disciplinary action at another academic institution.
  • SchoolDisciplineFlag; boolean; Indicates whether the person has received disciplinary action at another academic institution.
  • Title; string; The title of the person, such as Mr or Mrs.
  • UserName; string; The user name of the person.
  • VisaTypeCode; string; The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
  • VisaTypeMeaning; string; The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedPersonProfiles

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hedPersonProfiles-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-item-response

Type: object

Show Source

• addresses: array Addresses
  Title: Addresses

  The addresses resource provides information about the various addresses associated with the user.
• BirthCountryCode: string
  Title: Country of Birth

  Maximum Length: 30

  The country where this person was born.
• BirthCountryName: string
  Title: Country of Birth

  Read Only: true

  Maximum Length: 80

  The name of the birth country code.
• citizenships: array Citizenships
  Title: Citizenships

  Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.
• CitizenshipStatusCode: string
  Title: Citizenship Status

  Maximum Length: 30

  The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
• CitizenshipStatusDate: string (date)
  Title: Citizenship Status Date

  The date from which the citizenship status was valid.
• CitizenshipStatusMeaning: string
  Title: Citizenship Status

  Read Only: true

  Maximum Length: 80

  The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
• ConstituentId: string
  Title: Constituent ID

  Read Only: true

  Maximum Length: 30

  The unique identifier for a constituent.
• CriminalHistoryExplanation: string
  Title: Criminal History Explanation

  Maximum Length: 1000

  The description of any criminal history.
• CriminalHistoryFlag: boolean
  Title: Criminal History Indicator

  Maximum Length: 1

  Indicates whether criminal history exists for the person.
• DateOfBirth: string (date)
  Title: Date of Birth

  The date when the person was born.
• DateOfDeath: string (date)
  Title: Date of Death

  The date when the person died.
• DeathCertificateNumber: string
  Title: Death Certificate Number

  Maximum Length: 100

  The death certificate number of the person.
• DeceasedFlag: boolean
  Title: Person Deceased

  Maximum Length: 1

  Indicates if the person is deceased.
• emails: array Emails
  Title: Emails

  The emails resource provides information about the various email addresses associated with the user.
• emergencyContacts: array Emergency Contacts
  Title: Emergency Contacts

  The emergency contacts resource provides information about the various emergency contacts provided by the user.
• EthnicityCode: string
  Title: Ethnicity

  Maximum Length: 30

  The unique code for ethnicity. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
• EthnicityMeaning: string
  Title: Ethnicity

  Read Only: true

  Maximum Length: 80

  The meaning of ethnicity for a person. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.
• EthnicityValue: string
  Title: Ethnicity Value

  Maximum Length: 100

  The value of ethnicity for a person.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the person.
• FullName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The full name of the person.
• GenderCode: string
  Title: Gender

  Maximum Length: 30

  The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.
• GenderExpressionCode: string
  Title: Gender Expression

  Maximum Length: 30

  The unique code for gender expression. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
• GenderExpressionMeaning: string
  Title: Gender Expression

  Read Only: true

  Maximum Length: 80

  The gender expression that defines how user shows their gender. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.
• GenderExpressionValue: string
  Title: Gender Expression Value

  Maximum Length: 100

  The value of gender expression for a person.
• GenderIdentityCode: string
  Title: Gender Identity

  Maximum Length: 30

  The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
• GenderIdentityMeaning: string
  Title: Gender Identity

  Read Only: true

  Maximum Length: 80

  The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.
• GenderIdentityValue: string
  Title: Gender Identity Value

  Maximum Length: 100

  The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.
• GenderMeaning: string
  Title: Gender

  Read Only: true

  Maximum Length: 80

  The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER.
• HispanicOrLatinoCode: string
  Title: Hispanic or Latino

  Maximum Length: 60

  The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
• HispanicOrLatinoMeaning: string
  Title: Hispanic or Latino

  Read Only: true

  Maximum Length: 80

  The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
• images: array Images
  Title: Images

  The images resource provides information about the image uploaded by the user.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaritalStatusCode: string
  Title: Marital Status

  Maximum Length: 30

  The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.
• MaritalStatusEffectiveDate: string (date)
  Title: Marital Status as Of

  The date when the person's marital status changed.
• MaritalStatusMeaning: string
  Title: Marital Status

  Read Only: true

  Maximum Length: 80

  The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.
• MiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The middle name of the person.
• missingPersonContacts: array Missing Person Contacts
  Title: Missing Person Contacts

  Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.
• names: array Names
  Title: Names

  The names resource provides information about the various names associated with the user.
• NameSuffix: string
  Title: Suffix

  Read Only: true

  Maximum Length: 30

  The name suffix of the person.
• nationalIdentifiers: array National Identifiers
  Title: National Identifiers

  The national identifiers resource provides information about the various national identifiers associated with the user.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier for the party. Party can be a person. For example, a student can be a party.
• phones: array Phones
  Title: Phones

  The phones resource provides information about the various phone numbers associated with the user.
• PlaceOfBirth: string
  Title: Place of Birth

  Maximum Length: 60

  The place of birth of the student.
• PlaceOfDeath: string
  Title: Place of Death

  Maximum Length: 100

  The place of death of the person.
• PreferredFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The preferred first name of the person.
• PreferredFullName: string
  Title: Full Name

  Read Only: true

  Maximum Length: 360

  The preferred full name of the person.
• PreferredLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The preferred last name of the person.
• PreferredMiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The preferred middle name of the person.
• PreferredNameSuffix: string
  Title: Name Suffix

  Read Only: true

  Maximum Length: 30

  The preferred name suffix of the person.
• PreferredPronounsCode: string
  Title: Preferred Pronouns

  Maximum Length: 30

  The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
• PreferredPronounsMeaning: string
  Title: Preferred Pronouns

  Read Only: true

  Maximum Length: 80

  The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.
• PreferredPronounsValue: string
  Title: Preferred Pronouns Value

  Maximum Length: 100

  The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.
• PreferredTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The preferred title of the person, such as Mr or Mrs.
• PrimaryEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The primary email address of the person.
• PrimaryLanguageCode: string
  Title: Primary Language

  Maximum Length: 30

  The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
• PrimaryLanguageMeaning: string
  Title: Primary Language

  Read Only: true

  Maximum Length: 80

  The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.
• PrimaryLanguageValue: string
  Title: Primary Language Value

  Maximum Length: 100

  The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.
• PrimaryPhoneAreaCode: string
  Title: Phone Area Code

  Read Only: true

  Maximum Length: 20

  The country area code for the primary phone number of the person.
• PrimaryPhoneCountryCode: string
  Title: Phone Country Code

  Read Only: true

  Maximum Length: 10

  The international country code for the primary phone number of the person.
• PrimaryPhoneExtension: string
  Title: Phone Extension

  Read Only: true

  Maximum Length: 20

  The extension number for the primary phone number of the person.
• PrimaryPhoneNumber: string
  Title: Phone Number

  Read Only: true

  Maximum Length: 40

  The primary phone number of the person.
• PrivacyFlag: boolean
  Title: Privacy Indicator

  Maximum Length: 1

  Indicates whether privacy restrictions are activated for this person. The default value is: true.
• races: array Races
  Title: Races

  The races resource provides information about the various races associated with the user.
• ResidenceCountryCode: string
  Title: Country of Residence

  Maximum Length: 30

  The country this person normally resides in.
• ResidenceCountryName: string
  Title: Country of Residence

  Read Only: true

  Maximum Length: 80

  The name of the residency country code.
• SchoolDisciplineExplanation: string
  Title: School Discipline Explanation

  Maximum Length: 1000

  The description of any disciplinary action at another academic institution.
• SchoolDisciplineFlag: boolean
  Title: School Discipline Indicator

  Maximum Length: 1

  Indicates whether the person has received disciplinary action at another academic institution.
• socialNetworks: array Social Networks
  Title: Social Networks

  The social networks resource provides information about the various networks associated with the user.
• Title: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title of the person, such as Mr or Mrs.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  The user name of the person.
• VisaTypeCode: string
  Title: Visa Type

  Maximum Length: 30

  The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
• VisaTypeMeaning: string
  Title: Visa Type

  Read Only: true

  Maximum Length: 80

  The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.

{
    "type":"object",
    "properties":{
        "PrimaryLanguageCode":{
            "title":"Primary Language",
            "maxLength":"30",
            "type":"string",
            "description":"The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "addresses":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource provides information about the various addresses associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-addresses-item-response"
            }
        },
        "PreferredFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred first name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "PrivacyFlag":{
            "title":"Privacy Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether privacy restrictions are activated for this person. The default value is: true.",
            "nullable":true,
            "x-queryable":true
        },
        "CriminalHistoryFlag":{
            "title":"Criminal History Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether criminal history exists for the person.",
            "nullable":true,
            "x-queryable":true
        },
        "GenderIdentityCode":{
            "title":"Gender Identity",
            "maxLength":"30",
            "type":"string",
            "description":"The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferredPronounsValue":{
            "title":"Preferred Pronouns Value",
            "maxLength":"100",
            "type":"string",
            "description":"The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.",
            "nullable":true,
            "x-queryable":true
        },
        "MaritalStatusMeaning":{
            "title":"Marital Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConstituentId":{
            "title":"Constituent ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a constituent.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The preferred title of the person, such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderMeaning":{
            "title":"Gender",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix"
            }
        },
        "missingPersonContacts":{
            "title":"Missing Person Contacts",
            "type":"array",
            "description":"Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-missingPersonContacts-item-response"
            }
        },
        "HispanicOrLatinoCode":{
            "title":"Hispanic or Latino",
            "maxLength":"60",
            "type":"string",
            "description":"The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "protectionKey":"PersonDEO.DeclaredEthnicity",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Declared Ethnicity"
            },
            "x-queryable":true
        },
        "nationalIdentifiers":{
            "title":"National Identifiers",
            "type":"array",
            "description":"The national identifiers resource provides information about the various national identifiers associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-nationalIdentifiers-item-response"
            }
        },
        "GenderExpressionMeaning":{
            "title":"Gender Expression",
            "maxLength":"80",
            "type":"string",
            "description":"The gender expression that defines how user shows their gender. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date when the person was born.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GenderCode":{
            "title":"Gender",
            "maxLength":"30",
            "type":"string",
            "description":"The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VisaTypeCode":{
            "title":"Visa Type",
            "maxLength":"30",
            "type":"string",
            "description":"The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource provides information about the image uploaded by the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-images-item-response"
            }
        },
        "PrimaryPhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The country area code for the primary phone number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "GenderExpressionValue":{
            "title":"Gender Expression Value",
            "maxLength":"100",
            "type":"string",
            "description":"The value of gender expression for a person.",
            "nullable":true,
            "x-queryable":true
        },
        "CitizenshipStatusMeaning":{
            "title":"Citizenship Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HispanicOrLatinoMeaning":{
            "title":"Hispanic or Latino",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeceasedFlag":{
            "title":"Person Deceased",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person is deceased.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredPronounsCode":{
            "title":"Preferred Pronouns",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaritalStatusCode":{
            "title":"Marital Status",
            "maxLength":"30",
            "type":"string",
            "description":"The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The primary phone number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "races":{
            "title":"Races",
            "type":"array",
            "description":"The races resource provides information about the various races associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-races-item-response"
            }
        },
        "CitizenshipStatusCode":{
            "title":"Citizenship Status",
            "maxLength":"30",
            "type":"string",
            "description":"The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResidenceCountryName":{
            "title":"Country of Residence",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the residency country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PreferredFullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"The preferred full name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "EthnicityMeaning":{
            "title":"Ethnicity",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of ethnicity for a person. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityMeaning":{
            "title":"Gender Identity",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SchoolDisciplineExplanation":{
            "title":"School Discipline Explanation",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of any disciplinary action at another academic institution.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryLanguageMeaning":{
            "title":"Primary Language",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BirthCountryCode":{
            "title":"Country of Birth",
            "maxLength":"30",
            "type":"string",
            "description":"The country where this person was born.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CriminalHistoryExplanation":{
            "title":"Criminal History Explanation",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of any criminal history.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredNameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred name suffix of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MaritalStatusEffectiveDate":{
            "title":"Marital Status as Of",
            "type":"string",
            "description":"The date when the person's marital status changed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "VisaTypeMeaning":{
            "title":"Visa Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityValue":{
            "title":"Gender Identity Value",
            "maxLength":"100",
            "type":"string",
            "description":"The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.",
            "nullable":true,
            "x-queryable":true
        },
        "phones":{
            "title":"Phones",
            "type":"array",
            "description":"The phones resource provides information about the various phone numbers associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-phones-item-response"
            }
        },
        "emergencyContacts":{
            "title":"Emergency Contacts",
            "type":"array",
            "description":"The emergency contacts resource provides information about the various emergency contacts provided by the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-emergencyContacts-item-response"
            }
        },
        "PlaceOfBirth":{
            "title":"Place of Birth",
            "maxLength":"60",
            "type":"string",
            "description":"The place of birth of the student.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PlaceOfBirth",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Place of Birth"
            },
            "x-queryable":true
        },
        "SchoolDisciplineFlag":{
            "title":"School Discipline Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the person has received disciplinary action at another academic institution.",
            "nullable":true,
            "x-queryable":true
        },
        "emails":{
            "title":"Emails",
            "type":"array",
            "description":"The emails resource provides information about the various email addresses associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-emails-item-response"
            }
        },
        "PrimaryPhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension number for the primary phone number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "PrimaryLanguageValue":{
            "title":"Primary Language Value",
            "maxLength":"100",
            "type":"string",
            "description":"The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.",
            "nullable":true,
            "x-queryable":true
        },
        "socialNetworks":{
            "title":"Social Networks",
            "type":"array",
            "description":"The social networks resource provides information about the various networks associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-socialNetworks-item-response"
            }
        },
        "DateOfDeath":{
            "title":"Date of Death",
            "type":"string",
            "description":"The date when the person died.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlaceOfDeath":{
            "title":"Place of Death",
            "maxLength":"100",
            "type":"string",
            "description":"The place of death of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ResidenceCountryCode":{
            "title":"Country of Residence",
            "maxLength":"30",
            "type":"string",
            "description":"The country this person normally resides in.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"The user name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "GenderExpressionCode":{
            "title":"Gender Expression",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for gender expression. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_EXPRESSION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BirthCountryName":{
            "title":"Country of Birth",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the birth country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "EthnicityValue":{
            "title":"Ethnicity Value",
            "maxLength":"100",
            "type":"string",
            "description":"The value of ethnicity for a person.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredPronounsMeaning":{
            "title":"Preferred Pronouns",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeathCertificateNumber":{
            "title":"Death Certificate Number",
            "maxLength":"100",
            "type":"string",
            "description":"The death certificate number of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for the primary phone number of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipStatusDate":{
            "title":"Citizenship Status Date",
            "type":"string",
            "description":"The date from which the citizenship status was valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryEmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The primary email address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "names":{
            "title":"Names",
            "type":"array",
            "description":"The names resource provides information about the various names associated with the user.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-names-item-response"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the party. Party can be a person. For example, a student can be a party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The full name of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "citizenships":{
            "title":"Citizenships",
            "type":"array",
            "description":"Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.",
            "items":{
                "$ref":"#/components/schemas/hedPersonProfiles-citizenships-item-response"
            }
        },
        "EthnicityCode":{
            "title":"Ethnicity",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for ethnicity. A list of accepted values is defined in the lookup type ORA_HEY_DECLARED_ETHNICITY.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferredMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The preferred middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

The addresses resource provides information about the various addresses associated with the user.

Show Source

• Array of: object hedPersonProfiles-addresses-item-response

{
    "title":"Addresses",
    "type":"array",
    "description":"The addresses resource provides information about the various addresses associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-addresses-item-response"
    }
}

Nested Schema : Citizenships

Type: array

Title: Citizenships

Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.

Show Source

• Array of: object hedPersonProfiles-citizenships-item-response

{
    "title":"Citizenships",
    "type":"array",
    "description":"Citizenships represent one or more countries in which the user is a citizen. For example, the user could be a citizen of the United States of America.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-citizenships-item-response"
    }
}

Nested Schema : Emails

Type: array

Title: Emails

The emails resource provides information about the various email addresses associated with the user.

Show Source

• Array of: object hedPersonProfiles-emails-item-response

{
    "title":"Emails",
    "type":"array",
    "description":"The emails resource provides information about the various email addresses associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-emails-item-response"
    }
}

Nested Schema : Emergency Contacts

Type: array

Title: Emergency Contacts

The emergency contacts resource provides information about the various emergency contacts provided by the user.

Show Source

• Array of: object hedPersonProfiles-emergencyContacts-item-response

{
    "title":"Emergency Contacts",
    "type":"array",
    "description":"The emergency contacts resource provides information about the various emergency contacts provided by the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-emergencyContacts-item-response"
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource provides information about the image uploaded by the user.

Show Source

• Array of: object hedPersonProfiles-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource provides information about the image uploaded by the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Missing Person Contacts

Type: array

Title: Missing Person Contacts

Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.

Show Source

• Array of: object hedPersonProfiles-missingPersonContacts-item-response

{
    "title":"Missing Person Contacts",
    "type":"array",
    "description":"Missing person contacts represent the contacts that are notified when a person is missing. For example, spouse and parent of a student.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-missingPersonContacts-item-response"
    }
}

Nested Schema : Names

Type: array

Title: Names

The names resource provides information about the various names associated with the user.

Show Source

• Array of: object hedPersonProfiles-names-item-response

{
    "title":"Names",
    "type":"array",
    "description":"The names resource provides information about the various names associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-names-item-response"
    }
}

Nested Schema : National Identifiers

Type: array

Title: National Identifiers

The national identifiers resource provides information about the various national identifiers associated with the user.

Show Source

• Array of: object hedPersonProfiles-nationalIdentifiers-item-response

{
    "title":"National Identifiers",
    "type":"array",
    "description":"The national identifiers resource provides information about the various national identifiers associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-nationalIdentifiers-item-response"
    }
}

Nested Schema : Phones

Type: array

Title: Phones

The phones resource provides information about the various phone numbers associated with the user.

Show Source

• Array of: object hedPersonProfiles-phones-item-response

{
    "title":"Phones",
    "type":"array",
    "description":"The phones resource provides information about the various phone numbers associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-phones-item-response"
    }
}

Nested Schema : Races

Type: array

Title: Races

The races resource provides information about the various races associated with the user.

Show Source

• Array of: object hedPersonProfiles-races-item-response

{
    "title":"Races",
    "type":"array",
    "description":"The races resource provides information about the various races associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-races-item-response"
    }
}

Nested Schema : Social Networks

Type: array

Title: Social Networks

The social networks resource provides information about the various networks associated with the user.

Show Source

• Array of: object hedPersonProfiles-socialNetworks-item-response

{
    "title":"Social Networks",
    "type":"array",
    "description":"The social networks resource provides information about the various networks associated with the user.",
    "items":{
        "$ref":"#/components/schemas/hedPersonProfiles-socialNetworks-item-response"
    }
}

Nested Schema : hedPersonProfiles-addresses-item-response

Type: object

Show Source

• AddrElementAttributeFive: string
  Title: Additional Address Element 5

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeFour: string
  Title: Additional Address Element 4

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeOne: string
  Title: Additional Address Element 1

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeThree: string
  Title: Additional Address Element 3

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeTwo: string
  Title: Additional Address Element 2

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddressFour: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address line. Used in Japan.
• AddressOne: string
  Title: Address Line 1

  Maximum Length: 240

  The first line for address.
• AddressThree: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• AddressTwo: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• AddressUseId: integer (int64)
  Title: Address Use ID

  Read Only: true

  The unique identifier for party usage.
• AddressUseTypeCode: string
  Title: Address Use Type

  The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.
• AddressUseTypeMeaning: string
  Title: Address Use Type

  Read Only: true

  Maximum Length: 80

  The meaning of the address usage type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number at a given address.
• City: string
  Title: City

  Maximum Length: 60

  The city for the address.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  The country code from the TERRITORY_CODE column in the FND_TERRITORY table.
• County: string
  Title: County

  Maximum Length: 60

  The county for the address.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The end date for the address row.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  The floor number at a given address or in a particular building when building number is provided.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The address formatted based on the country code.
• FormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The multiline display for the formatted address.
• FutureAddressFlag: boolean
  Title: Future Address Indicator

  Read Only: true

  Maximum Length: 1

  Indicates that the address is future dated.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• HouseTypeMeaning: string
  Title: House Type

  Read Only: true

  Maximum Length: 80

  The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the location.
• LocationId: integer (int64)
  Title: Location ID

  The unique identifier for the location.
• PartyAddressId: integer (int64)
  Title: Party Address ID

  Read Only: true

  The unique identifier for party address.
• Position: string
  Title: Position

  Maximum Length: 50

  The primary direction such as North or East that's used to access the location.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code for the address.
• PostalPlusFourCode: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States postal code.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred address. The default value is: false.
• Province: string
  Title: Province Code

  Maximum Length: 60

  The province for the address.
• StartDate: string (date)
  Title: Start Date

  The start date for the address row.
• StateCode: string
  Title: State Code

  Maximum Length: 60

  The state for the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for the address row.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "NoTimeStamp":"Y",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "title":"Address Use Type",
            "type":"string",
            "description":"The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"AddressUseTypeMeaning"
            },
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address line. Used in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"The country code from the TERRITORY_CODE column in the FND_TERRITORY table.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "title":"Address Use Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the address usage type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":"50",
            "type":"string",
            "description":"The primary direction such as North or East that's used to access the location.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "title":"House Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The address formatted based on the country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StateCode":{
            "title":"State Code",
            "maxLength":"60",
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date for the address row.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE",
                "NoTimeStamp":"Y",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province Code",
            "maxLength":"60",
            "type":"string",
            "description":"The province for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressUseId":{
            "title":"Address Use ID",
            "type":"integer",
            "description":"The unique identifier for party usage.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PartyAddressId":{
            "title":"Party Address ID",
            "type":"integer",
            "description":"The unique identifier for party address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four digit extension to the United States postal code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "FutureAddressFlag":{
            "title":"Future Address Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the address is future dated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedPersonProfiles-citizenships-item-response

Type: object

Show Source

• CitizenshipCountryCode: string
  Title: Citizenship Country Code

  Maximum Length: 2

  The code for the country from which a person claims citizenship.
• CitizenshipCountryName: string
  Title: Citizenship Country Name

  Read Only: true

  Maximum Length: 80

  The name of the citizenship country code.
• CitizenshipId: integer (int64)
  Title: Citizenship ID

  Read Only: true

  The unique identifier for the citizenship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CitizenshipCountryCode":{
            "title":"Citizenship Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"The code for the country from which a person claims citizenship.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CitizenshipCountryName":{
            "title":"Citizenship Country Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the citizenship country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipId":{
            "title":"Citizenship ID",
            "type":"integer",
            "description":"The unique identifier for the citizenship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-emails-item-response

Type: object

Show Source

• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address of the person.
• EmailId: integer (int64)
  Title: Email ID

  Read Only: true

  The unique identifier for an email address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred email address.
• PurposeCode: string
  Title: Purpose

  Maximum Length: 30

  The type of purpose for email contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PurposeMeaning: string
  Title: Purpose

  Read Only: true

  Maximum Length: 80

  The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.

{
    "type":"object",
    "properties":{
        "EmailId":{
            "title":"Email ID",
            "type":"integer",
            "description":"The unique identifier for an email address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PurposeMeaning":{
            "title":"Purpose",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for email contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred email address.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-emergencyContacts-item-response

Type: object

Show Source

• AdditionalEmail: string
  Title: Additional Email

  Maximum Length: 1000

  The additional email for an emergency contact.
• AdditionalEmailTypeCode: string
  Title: Additional Email Type Code

  Maximum Length: 30

  The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• AdditionalEmailTypeMeaning: string
  Title: Additional Email Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• AdditionalPhoneAreaCode: string
  Title: Additional Phone Area Code

  Maximum Length: 10

  The area code for additional phone of an emergency contact.
• AdditionalPhoneCountryCode: string
  Title: Additional Phone Country Code

  Maximum Length: 10

  The country code for additional phone of an emergency contact.
• AdditionalPhoneExtension: string
  Title: Additional Phone Extension

  Maximum Length: 10

  The extension for additional phone of an emergency contact.
• AdditionalPhoneNumber: string
  Title: Additional Phone Number

  Maximum Length: 40

  The additional phone number for an emergency contact.
• AdditionalPhoneTypeCode: string
  Title: Additional Phone Type Code

  Maximum Length: 30

  The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• AdditionalPhoneTypeMeaning: string
  Title: Additional Phone Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• ContactTypeCode: string
  Title: Contact Type Code

  Maximum Length: 30

  The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
• ContactTypeMeaning: string
  Title: Relationship Type

  Read Only: true

  Maximum Length: 80

  The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
• Email: string
  Title: Email

  Maximum Length: 1000

  The email address of the emergency contact.
• EmailTypeCode: string
  Title: Email Type Code

  Maximum Length: 30

  The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• EmailTypeMeaning: string
  Title: Email Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• EmergencyContactId: integer (int64)
  Title: Emergency Contact ID

  Read Only: true

  The unique identifier for emergency contact.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name by which emergency contact is known.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name by which emergency contact is known.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the person.
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The suffix can be junior or senior.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 10

  The country area code for the emergency contact phone number.
• PhoneCountryCode: string
  Title: Select Country

  Maximum Length: 10

  The international country code for the emergency contact phone number.
• PhoneExtension: string
  Title: Extension

  Maximum Length: 10

  The extension number for the emergency contact phone number.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The emergency contact phone number.
• PhoneTypeCode: string
  Title: Phone Type Code

  Maximum Length: 30

  The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PhoneTypeMeaning: string
  Title: Phone Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred emergency contact.
• SingleNameFlag: boolean
  Title: Only One Name

  Maximum Length: 1

  Default Value: false

  Indicates if the person has single name.
• Title: string
  Title: Title

  Maximum Length: 60

  The title of the person, such as Mr or Mrs.

{
    "type":"object",
    "properties":{
        "AdditionalPhoneAreaCode":{
            "title":"Additional Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The area code for additional phone of an emergency contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"1000",
            "type":"string",
            "description":"The email address of the emergency contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneNumber":{
            "title":"Additional Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The additional phone number for an emergency contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneTypeMeaning":{
            "title":"Phone Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalEmailTypeMeaning":{
            "title":"Additional Email Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalEmail":{
            "title":"Additional Email",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional email for an emergency contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Relationship Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Select Country",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for the emergency contact phone number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country area code for the emergency contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneExtension":{
            "title":"Additional Phone Extension",
            "maxLength":"10",
            "type":"string",
            "description":"The extension for additional phone of an emergency contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalEmailTypeCode":{
            "title":"Additional Email Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailTypeMeaning":{
            "title":"Email Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalPhoneTypeMeaning":{
            "title":"Additional Phone Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name by which emergency contact is known.",
            "nullable":true,
            "x-queryable":true
        },
        "EmergencyContactId":{
            "title":"Emergency Contact ID",
            "type":"integer",
            "description":"The unique identifier for emergency contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneTypeCode":{
            "title":"Phone Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalPhoneTypeCode":{
            "title":"Additional Phone Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"10",
            "type":"string",
            "description":"The extension number for the emergency contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneCountryCode":{
            "title":"Additional Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for additional phone of an emergency contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The emergency contact phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name by which emergency contact is known.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred emergency contact.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailTypeCode":{
            "title":"Email Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-images-item-response

Type: object

Show Source

• ImageContent: string (byte)
  Title: Attachment Content

  The binary representation of the attachment.
• ImageId: integer (int64)
  Title: Attachment ID

  Read Only: true

  The unique identifier for image.
• ImageName: string
  Maximum Length: 240

  The name of the image.
• ImageTypeCode: string
  Title: Attachment Type Code

  Read Only: true

  Maximum Length: 30

  Default Value: PROFILE_PHOTO

  The type code of the attachment, for example, STUDENT_PHOTO and INSTRUCTOR_PHOTO.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The unique identifier for image.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ImageName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the image.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ImageTypeCode":{
            "title":"Attachment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type code of the attachment, for example, STUDENT_PHOTO and INSTRUCTOR_PHOTO.",
            "nullable":false,
            "readOnly":true,
            "default":"PROFILE_PHOTO",
            "x-queryable":true
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The binary representation of the attachment.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-missingPersonContacts-item-response

Type: object

Show Source

• AdditionalEmail: string
  Title: Additional Email

  Maximum Length: 1000

  The additional email for a missing person contact.
• AdditionalEmailTypeCode: string
  Title: Additional Email Type Code

  Maximum Length: 30

  The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• AdditionalEmailTypeMeaning: string
  Title: Additional Email Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• AdditionalPhoneAreaCode: string
  Title: Additional Phone Area Code

  Maximum Length: 10

  The area code for additional phone of a missing person contact.
• AdditionalPhoneCountryCode: string
  Title: Additional Phone Country Code

  Maximum Length: 10

  The country code for additional phone of a missing person contact.
• AdditionalPhoneExtension: string
  Title: Additional Phone Extension

  Maximum Length: 10

  The extension for additional phone of a missing person contact.
• AdditionalPhoneNumber: string
  Title: Additional Phone Number

  Maximum Length: 40

  The additional phone number for a missing person contact.
• AdditionalPhoneTypeCode: string
  Title: Additional Phone Type Code

  Maximum Length: 30

  The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• AdditionalPhoneTypeMeaning: string
  Title: Additional Phone Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• ContactTypeCode: string
  Title: Relationship Type

  Maximum Length: 30

  The missing person contact type of the person, such as Spouse, Parent, and Grandparent. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
• ContactTypeMeaning: string
  Title: Relationship Type

  Read Only: true

  Maximum Length: 80

  The meaning of missing person contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.
• Email: string
  Title: Email

  Maximum Length: 1000

  The email for a missing person contact.
• EmailTypeCode: string
  Title: Email Type Code

  Maximum Length: 30

  The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• EmailTypeMeaning: string
  Title: Email Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of a person.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of a person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the person.
• MissingPersonContactId: integer (int64)
  Title: Missing Person Contact ID

  Read Only: true

  The unique identifier of a missing person contact.
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The suffix can be junior or senior.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 10

  The area code within a country code.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 10

  The country code for phone of a missing person contact.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 10

  The extension number for a phone number.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PhoneTypeCode: string
  Title: Phone Type Code

  Maximum Length: 30

  The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PhoneTypeMeaning: string
  Title: Phone Type Name

  Read Only: true

  Maximum Length: 80

  The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred emergency contact.
• SingleNameFlag: boolean
  Title: Only One Name

  Maximum Length: 1

  Default Value: false

  Indicates if the person has single name.
• Title: string
  Title: Title

  Maximum Length: 60

  The title of the person, such as Mr or Mrs.

{
    "type":"object",
    "properties":{
        "AdditionalPhoneAreaCode":{
            "title":"Additional Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The area code for additional phone of a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"1000",
            "type":"string",
            "description":"The email for a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneNumber":{
            "title":"Additional Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The additional phone number for a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneTypeMeaning":{
            "title":"Phone Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalEmailTypeMeaning":{
            "title":"Additional Email Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalEmail":{
            "title":"Additional Email",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional email for a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Relationship Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of missing person contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for phone of a missing person contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneExtension":{
            "title":"Additional Phone Extension",
            "maxLength":"10",
            "type":"string",
            "description":"The extension for additional phone of a missing person contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The missing person contact type of the person, such as Spouse, Parent, and Grandparent. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalEmailTypeCode":{
            "title":"Additional Email Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The additional email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailTypeMeaning":{
            "title":"Email Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalPhoneTypeMeaning":{
            "title":"Additional Phone Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of a person.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneTypeCode":{
            "title":"Phone Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalPhoneTypeCode":{
            "title":"Additional Phone Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The additional phone type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"10",
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalPhoneCountryCode":{
            "title":"Additional Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for additional phone of a missing person contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MissingPersonContactId":{
            "title":"Missing Person Contact ID",
            "type":"integer",
            "description":"The unique identifier of a missing person contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of a person.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred emergency contact.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EmailTypeCode":{
            "title":"Email Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The email type code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-names-item-response

Type: object

Show Source

• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of a person.
• FullName: string
  Title: Full Name

  Maximum Length: 360

  The full name of the person.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of a person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of a person.
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The suffix can be junior or senior.
• NameTypeCode: string
  Title: Name Type

  Maximum Length: 30

  The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
• NameTypeMeaning: string
  Title: Name Type

  Read Only: true

  Maximum Length: 80

  The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
• PartyNameId: integer (int64)
  Title: Party Name ID

  Read Only: true

  The unique identifier for a name.
• PreferredFlag: boolean
  Title: Preferred

  Indicates the name as preferred name for this party within this name type.
• SingleNameFlag: boolean
  Title: Only One Name

  Maximum Length: 1

  Default Value: false

  Indicates if the person has single name.
• Title: string
  Title: Title

  Maximum Length: 60

  The title of the person, such as Mr or Mrs.

{
    "type":"object",
    "properties":{
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "dependencies":[
                    "SingleNameFlag"
                ]
            },
            "x-queryable":true
        },
        "NameTypeMeaning":{
            "title":"Name Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"The full name of the person.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "dependencies":[
                    "SingleNameFlag"
                ]
            },
            "x-queryable":true
        },
        "NameTypeCode":{
            "title":"Name Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "type":"boolean",
            "description":"Indicates the name as preferred name for this party within this name type.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNameId":{
            "title":"Party Name ID",
            "type":"integer",
            "description":"The unique identifier for a name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-nationalIdentifiers-item-response

Type: object

Show Source

• Authority: string
  Title: Authority

  Maximum Length: 100

  The authority who issues the person national identifier.
• CountryCode: string
  Title: Country Code

  Maximum Length: 30

  The country code for national identifier of the person.
• CountryName: string
  Title: Country Name

  Read Only: true

  Maximum Length: 80

  The country name for national identifier of the person.
• ExpirationDate: string (date)
  Title: Expiration Date

  The expiration date of the person national identifier.
• IdentifierTypeCode: string
  Title: Identifier Type Code

  Maximum Length: 30

  The identifier type code for national identifier of the person.
• IdentifierTypeMeaning: string
  Title: Identifier Type

  Read Only: true

  Maximum Length: 60

  The meaning of identifier type code for national identifier of the person.
• IdentifierValue: string
  Title: ID Number

  Maximum Length: 30

  The identifier value of the person.
• IssueDate: string (date)
  Title: Issue Date

  The issue date of the person national identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NationalIdentifierId: integer (int64)
  Title: National Identifier ID

  Read Only: true

  The unique identifier for the national identifier.
• Notes: string
  Title: Note

  Maximum Length: 240

  The additional notes for person national identifier.

{
    "type":"object",
    "properties":{
        "IdentifierTypeCode":{
            "title":"Identifier Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier type code for national identifier of the person.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NationalIdentifierId":{
            "title":"National Identifier ID",
            "type":"integer",
            "description":"The unique identifier for the national identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the person national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country Name",
            "maxLength":"80",
            "type":"string",
            "description":"The country name for national identifier of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Authority":{
            "title":"Authority",
            "maxLength":"100",
            "type":"string",
            "description":"The authority who issues the person national identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The issue date of the person national identifier.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IdentifierValue":{
            "title":"ID Number",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier value of the person.",
            "nullable":false,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"The country code for national identifier of the person.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IdentifierTypeMeaning":{
            "title":"Identifier Type",
            "maxLength":"60",
            "type":"string",
            "description":"The meaning of identifier type code for national identifier of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "title":"Note",
            "maxLength":"240",
            "type":"string",
            "description":"The additional notes for person national identifier.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-phones-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code within a country code.
• PhoneCountryCode: string
  Title: Country Code

  Maximum Length: 10

  The international country code for a phone number. For example, 33 for France.
• PhoneExtension: string
  Title: Phone Extension

  Maximum Length: 20

  The extension number for a phone number.
• PhoneId: integer (int64)
  Title: Phone ID

  Read Only: true

  The unique identifier for the phone number.
• PhoneLineTypeCode: string
  Title: Phone Type

  Maximum Length: 30

  Default Value: GEN

  The phone line type for phone contact, such as mobile and land. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.
• PhoneLineTypeMeaning: string
  Title: Phone Type

  Read Only: true

  Maximum Length: 80

  The meaning of the phone line type. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.
• PhoneNumber: string
  Title: Phone Number

  Maximum Length: 40

  The phone number formatted in the local format. The number should not include area code, country code, or extension.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred phone number.
• PrimaryPerPhoneTypeFlag: boolean
  Title: Primary Phone Indicator

  Maximum Length: 1

  Default Value: false

  Indicates the primary phone number for a phone type.
• PurposeCode: string
  Title: Purpose

  Maximum Length: 30

  The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.
• PurposeMeaning: string
  Title: Purpose

  Read Only: true

  Maximum Length: 80

  The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.

{
    "type":"object",
    "properties":{
        "PhoneCountryCode":{
            "title":"Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneLineTypeMeaning":{
            "title":"Phone Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the phone line type. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneId":{
            "title":"Phone ID",
            "type":"integer",
            "description":"The unique identifier for the phone number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PurposeMeaning":{
            "title":"Purpose",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryPerPhoneTypeFlag":{
            "title":"Primary Phone Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the primary phone number for a phone type.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneLineTypeCode":{
            "title":"Phone Type",
            "maxLength":"30",
            "type":"string",
            "description":"The phone line type for phone contact, such as mobile and land. A list of accepted values is defined in the lookup type PHONE_LINE_TYPE.",
            "nullable":false,
            "default":"GEN",
            "x-hints":{
                "controlType":"choice",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred phone number.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-races-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonalRaceId: integer (int64)
  Title: Personal Race ID

  Read Only: true

  The unique identifier of person's race.
• RaceCode: string
  Title: Race

  Maximum Length: 30

  The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
• RaceCodeMeaning: string
  Title: Race

  Read Only: true

  Maximum Length: 80

  The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
• RaceValue: string
  Title: Race Value

  Maximum Length: 100

  The race value for a person.

{
    "type":"object",
    "properties":{
        "RaceValue":{
            "title":"Race Value",
            "maxLength":"100",
            "type":"string",
            "description":"The race value for a person.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonalRaceId":{
            "title":"Personal Race ID",
            "type":"integer",
            "description":"The unique identifier of person's race.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RaceCode":{
            "title":"Race",
            "maxLength":"30",
            "type":"string",
            "description":"The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RaceCodeMeaning":{
            "title":"Race",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedPersonProfiles-socialNetworks-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred social network address.
• ProviderCode: string
  Title: Provider

  Maximum Length: 30

  The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
• ProviderMeaning: string
  Title: Provider

  The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
• SocialNetworkAddress: string
  Title: Social Network Address

  Maximum Length: 200

  The social network address of the person.
• SocialNetworkId: integer (int64)
  Title: Social Network ID

  Read Only: true

  The unique identifier for the social network.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProviderMeaning":{
            "title":"Provider",
            "type":"string",
            "description":"The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "SocialNetworkId":{
            "title":"Social Network ID",
            "type":"integer",
            "description":"The unique identifier for the social network.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SocialNetworkAddress":{
            "title":"Social Network Address",
            "maxLength":"200",
            "type":"string",
            "description":"The social network address of the person.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred social network address.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ProviderCode":{
            "title":"Provider",
            "maxLength":"30",
            "type":"string",
            "description":"The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top