Jump to

• Request
• Response

Create all Student Management organization contacts

post

/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• contactAssociations: array Student Management Organization Contact Associations
  Title: Student Management Organization Contact Associations

  The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.
• ContactStatusCode: string
  Title: Contact Status Code

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The contact status code for this contact.
• DefaultContactTypeCode: string
  Title: Default Contact Type Code

  Maximum Length: 30

  The default contact type code for this contact.
• DefaultDepartment: string
  Title: Default Department

  Maximum Length: 100

  The default department of this contact.
• DefaultJobTitle: string
  Title: Default Job Title

  Maximum Length: 100

  The default job title for this contact.
• emails: array Student Management Organization Contact Emails
  Title: Student Management Organization Contact Emails

  The emails resource contains the email addresses of the Student Management organization contacts.
• FirstName: string
  Title: First Name

  Maximum Length: 150

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

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• LastName: string
  Title: Last Name

  Maximum Length: 150

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

  Maximum Length: 60

  The middle name of the person.
• names: array Student Management Organization Contact Names
  Title: Student Management Organization Contact Names

  The names resource contains the names of the Student Management organization contacts.
• NameSuffix: string
  Title: Suffix

  Maximum Length: 30

  The name suffix of the person such as junior or senior.
• phones: array Student Management Organization Contact Phones
  Title: Student Management Organization Contact Phones

  The phones resource contains the phone numbers of the Student Management organization contacts.
• PrimaryEmailAddress: string
  Title: Primary Email

  Maximum Length: 320

  The email address of the person.
• PrimaryPhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 20

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

  Maximum Length: 10

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

  Maximum Length: 20

  The extension number for a phone number.
• PrimaryPhoneNumber: 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.
• Title: string
  Title: Prefix

  Maximum Length: 60

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

{
    "required":[
        "FullName"
    ],
    "type":"object",
    "properties":{
        "PrimaryPhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "DefaultDepartment":{
            "title":"Default Department",
            "maxLength":"100",
            "type":"string",
            "description":"The default department of this contact.",
            "nullable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "DefaultContactTypeCode":{
            "title":"Default Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The default contact type code for this contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Title":{
            "title":"Prefix",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true
        },
        "phones":{
            "title":"Student Management Organization Contact Phones",
            "type":"array",
            "description":"The phones resource contains the phone numbers of the Student Management organization contacts.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-phones-item-post-request"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "contactAssociations":{
            "title":"Student Management Organization Contact Associations",
            "type":"array",
            "description":"The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-contactAssociations-item-post-request"
            }
        },
        "emails":{
            "title":"Student Management Organization Contact Emails",
            "type":"array",
            "description":"The emails resource contains the email addresses of the Student Management organization contacts.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-emails-item-post-request"
            }
        },
        "PrimaryPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true
        },
        "PrimaryPhoneExtension":{
            "title":"Phone Number 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"
            }
        },
        "PrimaryEmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "names":{
            "title":"Student Management Organization Contact Names",
            "type":"array",
            "description":"The names resource contains the names of the Student Management organization contacts.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-names-item-post-request"
            }
        },
        "PrimaryPhoneNumber":{
            "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"
            }
        },
        "FullName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":false
        },
        "ContactStatusCode":{
            "title":"Contact Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The contact status code for this contact.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of the person such as junior or senior.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "DefaultJobTitle":{
            "title":"Default Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The default job title for this contact.",
            "nullable":true
        }
    }
}

Nested Schema : Student Management Organization Contact Associations

Type: array

Title: Student Management Organization Contact Associations

The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.

Show Source

• Array of: object hedOrganizationContacts-contactAssociations-item-post-request

{
    "title":"Student Management Organization Contact Associations",
    "type":"array",
    "description":"The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-contactAssociations-item-post-request"
    }
}

Nested Schema : Student Management Organization Contact Emails

Type: array

Title: Student Management Organization Contact Emails

The emails resource contains the email addresses of the Student Management organization contacts.

Show Source

• Array of: object schema

{
    "title":"Student Management Organization Contact Emails",
    "type":"array",
    "description":"The emails resource contains the email addresses of the Student Management organization contacts.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-emails-item-post-request"
    }
}

Nested Schema : Student Management Organization Contact Names

Type: array

Title: Student Management Organization Contact Names

The names resource contains the names of the Student Management organization contacts.

Show Source

• Array of: object hedOrganizationContacts-names-item-post-request

{
    "title":"Student Management Organization Contact Names",
    "type":"array",
    "description":"The names resource contains the names of the Student Management organization contacts.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-names-item-post-request"
    }
}

Nested Schema : Student Management Organization Contact Phones

Type: array

Title: Student Management Organization Contact Phones

The phones resource contains the phone numbers of the Student Management organization contacts.

Show Source

• Array of: object hedOrganizationContacts-phones-item-post-request

{
    "title":"Student Management Organization Contact Phones",
    "type":"array",
    "description":"The phones resource contains the phone numbers of the Student Management organization contacts.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-phones-item-post-request"
    }
}

Nested Schema : hedOrganizationContacts-contactAssociations-item-post-request

Type: object

Show Source

• OrganizationCategoryCode: string
  Title: Organization Category Code

  Maximum Length: 30

  Default Value: ORA_HER_EXTERNAL_ORG

  The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.

{
    "type":"object",
    "properties":{
        "OrganizationCategoryCode":{
            "title":"Organization Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "default":"ORA_HER_EXTERNAL_ORG",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address of the contact.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred email address to use for the contact. The default value is: false.
• PurposeCode: string
  Title: Purpose Code

  Maximum Length: 30

  The type of purpose for the email contact point, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.

{
    "type":"object",
    "properties":{
        "PurposeCode":{
            "title":"Purpose Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for the email contact point, 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"
            }
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred email address to use for the contact. The default value is: false.",
            "nullable":true,
            "default":false
        }
    }
}

Nested Schema : hedOrganizationContacts-names-item-post-request

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 first and last name of the person displayed as a single string.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of a person.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

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

  Maximum Length: 30

  The name suffix of a person such as 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.
• PreferredFlag: boolean
  Title: Preferred

  Indicates that this name record contains the person's preferred name.
• SingleNameFlag: boolean
  Title: Only One Name

  Maximum Length: 1

  Default Value: false

  Indicates if the person has single name, typically a last name only, and that other names such as first name and middle name are intentionally blank.
• 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"
                ]
            }
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of a person such as junior or senior.",
            "nullable":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"
            }
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name, typically a last name only, and that other names such as first name and middle name are intentionally blank.",
            "nullable":false,
            "default":false
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "PreferredFlag":{
            "title":"Preferred",
            "type":"boolean",
            "description":"Indicates that this name record contains the person's preferred name.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : hedOrganizationContacts-phones-item-post-request

Type: object

Show Source

• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 20

  The area code within a country.
• 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.
• 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 to use for the contact. The default value is: false.
• PurposeCode: string
  Title: Purpose Code

  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.

{
    "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"
            }
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            }
        },
        "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"
            }
        },
        "PurposeCode":{
            "title":"Purpose Code",
            "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"
            }
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred phone number to use for the contact. The default value is: false.",
            "nullable":true,
            "default":false
        },
        "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"
            }
        }
    }
}

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 : hedOrganizationContacts-item-response

Type: object

Show Source

• ConstituentId: string
  Title: Constituent ID

  Read Only: true

  Maximum Length: 30

  The unique identifier for a constituent.
• contactAssociations: array Student Management Organization Contact Associations
  Title: Student Management Organization Contact Associations

  The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.
• ContactPartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier for the party. Party can be a person or an organization. Organizational contacts will always be a party of type person.
• ContactStatusCode: string
  Title: Contact Status Code

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The contact status code for this contact.
• ContactStatusMeaning: string
  Title: Contact Status

  Read Only: true

  Maximum Length: 80

  The meaning of the default contact type code for this contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Created On

  Read Only: true

  The date the row was created.
• DefaultContactTypeCode: string
  Title: Default Contact Type Code

  Maximum Length: 30

  The default contact type code for this contact.
• DefaultContactTypeMeaning: string
  Title: Default Contact Type

  Read Only: true

  Maximum Length: 80

  The meaning of the default contact type code for this contact.
• DefaultDepartment: string
  Title: Default Department

  Maximum Length: 100

  The default department of this contact.
• DefaultJobTitle: string
  Title: Default Job Title

  Maximum Length: 100

  The default job title for this contact.
• emails: array Student Management Organization Contact Emails
  Title: Student Management Organization Contact Emails

  The emails resource contains the email addresses of the Student Management organization contacts.
• FirstName: string
  Title: First Name

  Maximum Length: 150

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

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• 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.
• names: array Student Management Organization Contact Names
  Title: Student Management Organization Contact Names

  The names resource contains the names of the Student Management organization contacts.
• NameSuffix: string
  Title: Suffix

  Maximum Length: 30

  The name suffix of the person such as junior or senior.
• phones: array Student Management Organization Contact Phones
  Title: Student Management Organization Contact Phones

  The phones resource contains the phone numbers of the Student Management organization contacts.
• PreferredFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The preferred first name of a person.
• PreferredFullName: string
  Title: Preferred Name

  Read Only: true

  Maximum Length: 360

  The preferred first and last name of the person displayed as a single string.
• PreferredLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 30

  The name suffix of the person such as junior or senior.
• PreferredNameTitle: string
  Title: Prefix

  Read Only: true

  Maximum Length: 60

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

  Maximum Length: 320

  The email address of the person.
• PrimaryPhoneAreaCode: string
  Title: Phone Area Code

  Maximum Length: 20

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

  Maximum Length: 10

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

  Maximum Length: 20

  The extension number for a phone number.
• PrimaryPhoneNumber: 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.
• Title: string
  Title: Prefix

  Maximum Length: 60

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredNameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of the person such as junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "phones":{
            "title":"Student Management Organization Contact Phones",
            "type":"array",
            "description":"The phones resource contains the phone numbers of the Student Management organization contacts.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-phones-item-response"
            }
        },
        "PreferredFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "contactAssociations":{
            "title":"Student Management Organization Contact Associations",
            "type":"array",
            "description":"The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-contactAssociations-item-response"
            }
        },
        "emails":{
            "title":"Student Management Organization Contact Emails",
            "type":"array",
            "description":"The emails resource contains the email addresses of the Student Management organization contacts.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-emails-item-response"
            }
        },
        "ConstituentId":{
            "title":"Constituent ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a constituent.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneExtension":{
            "title":"Phone Number 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"
            },
            "x-queryable":true
        },
        "ContactStatusCode":{
            "title":"Contact Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The contact status code for this contact.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "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":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of the person such as junior or senior.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix"
            },
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the party. Party can be a person or an organization. Organizational contacts will always be a party of type person.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultJobTitle":{
            "title":"Default Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The default job title for this contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredNameTitle":{
            "title":"Prefix",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "DefaultDepartment":{
            "title":"Default Department",
            "maxLength":"100",
            "type":"string",
            "description":"The default department of this contact.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "DefaultContactTypeCode":{
            "title":"Default Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The default contact type code for this contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Prefix",
            "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-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "PreferredLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The preferred last name of a 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 a phone number. For example, 33 for France.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryEmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "names":{
            "title":"Student Management Organization Contact Names",
            "type":"array",
            "description":"The names resource contains the names of the Student Management organization contacts.",
            "items":{
                "$ref":"#/components/schemas/hedOrganizationContacts-names-item-response"
            }
        },
        "DefaultContactTypeMeaning":{
            "title":"Default Contact Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the default contact type code for this contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "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"
            },
            "x-queryable":true
        },
        "ContactStatusMeaning":{
            "title":"Contact Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the default contact type code for this contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredFullName":{
            "title":"Preferred Name",
            "maxLength":"360",
            "type":"string",
            "description":"The preferred first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "PreferredMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The preferred middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Student Management Organization Contact Associations

Type: array

Title: Student Management Organization Contact Associations

The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.

Show Source

• Array of: object hedOrganizationContacts-contactAssociations-item-response

{
    "title":"Student Management Organization Contact Associations",
    "type":"array",
    "description":"The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-contactAssociations-item-response"
    }
}

Nested Schema : Student Management Organization Contact Emails

Type: array

Title: Student Management Organization Contact Emails

The emails resource contains the email addresses of the Student Management organization contacts.

Show Source

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

{
    "title":"Student Management Organization Contact Emails",
    "type":"array",
    "description":"The emails resource contains the email addresses of the Student Management organization contacts.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-emails-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 : Student Management Organization Contact Names

Type: array

Title: Student Management Organization Contact Names

The names resource contains the names of the Student Management organization contacts.

Show Source

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

{
    "title":"Student Management Organization Contact Names",
    "type":"array",
    "description":"The names resource contains the names of the Student Management organization contacts.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-names-item-response"
    }
}

Nested Schema : Student Management Organization Contact Phones

Type: array

Title: Student Management Organization Contact Phones

The phones resource contains the phone numbers of the Student Management organization contacts.

Show Source

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

{
    "title":"Student Management Organization Contact Phones",
    "type":"array",
    "description":"The phones resource contains the phone numbers of the Student Management organization contacts.",
    "items":{
        "$ref":"#/components/schemas/hedOrganizationContacts-phones-item-response"
    }
}

Nested Schema : hedOrganizationContacts-contactAssociations-item-response

Type: object

Show Source

• AssociatedObjectId: integer (int64)
  Title: Associated Object ID

  Read Only: true

  The unique identifier of the associated object.
• AssociationEndDate: string (date)
  Title: End Date

  Read Only: true

  The end or expiration date of the contact association.
• AssociationStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the contact association.
• ContactAssociationId: integer (int64)
  Title: Contact Association ID

  Read Only: true

  The unique identifier for the organization contact association record.
• ContactTypeCode: string
  Title: Contact Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• ContactTypeMeaning: string
  Title: Contact Type

  Read Only: true

  Maximum Length: 80

  The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Created On

  Read Only: true

  The date the row was created.
• Department: string
  Title: Department

  Read Only: true

  Maximum Length: 100

  The name of the department that the contact belongs to.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the associated contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCategoryCode: string
  Title: Organization Category Code

  Maximum Length: 30

  Default Value: ORA_HER_EXTERNAL_ORG

  The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• OrganizationCategoryMeaning: string
  Title: Organization Category

  Read Only: true

  Maximum Length: 80

  The category name or meaning of the associated Student Management entity.
• OrganizationDescription: string
  Title: Organization Description

  Read Only: true

  A description of the associated Student Management entity.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  The name of the associated Student Management entity.
• PrimaryContactFlag: boolean
  Title: Primary Contact

  Read Only: true

  Maximum Length: 1

  Indicates that this person should be the primary contact.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "type":"string",
            "description":"The name of the associated Student Management entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that this person should be the primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCategoryCode":{
            "title":"Organization Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the associated Student Management entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "default":"ORA_HER_EXTERNAL_ORG",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedObjectId":{
            "title":"Associated Object ID",
            "type":"integer",
            "description":"The unique identifier of the associated object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationDescription":{
            "title":"Organization Description",
            "type":"string",
            "description":"A description of the associated Student Management entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Contact Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the contact type code. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCategoryMeaning":{
            "title":"Organization Category",
            "maxLength":"80",
            "type":"string",
            "description":"The category name or meaning of the associated Student Management entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end or expiration date of the contact association.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type or usage of the contact. A list of accepted values is defined in the lookup type ORA_HEY_ORG_CON_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the department that the contact belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactAssociationId":{
            "title":"Contact Association ID",
            "type":"integer",
            "description":"The unique identifier for the organization contact association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssociationStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the contact association.",
            "format":"date",
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : 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 : hedOrganizationContacts-emails-item-response

Type: object

Show Source

• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address of the contact.
• 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 to use for the contact. The default value is: false.
• PurposeCode: string
  Title: Purpose Code

  Maximum Length: 30

  The type of purpose for the email contact point, 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_WEB.

{
    "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_WEB.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Purpose Code",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for the email contact point, 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 contact.",
            "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 to use for the contact. The default value is: false.",
            "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 : hedOrganizationContacts-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 first and last name of the person displayed as a single string.
• 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 name suffix of a person such as 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 that this name record contains the person's preferred name.
• SingleNameFlag: boolean
  Title: Only One Name

  Maximum Length: 1

  Default Value: false

  Indicates if the person has single name, typically a last name only, and that other names such as first name and middle name are intentionally blank.
• 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 first and last name of the person displayed as a single string.",
            "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 name suffix of a person such as 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, typically a last name only, and that other names such as first name and middle name are intentionally blank.",
            "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 that this name record contains the person's preferred name.",
            "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 : hedOrganizationContacts-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.
• 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 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.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred phone number to use for the contact. The default value is: false.
• PurposeCode: string
  Title: Purpose Code

  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.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneId":{
            "title":"Phone ID",
            "type":"integer",
            "description":"The unique identifier for a 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"
            }
        },
        "PurposeCode":{
            "title":"Purpose Code",
            "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
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred phone number to use for the contact. The default value is: false.",
            "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"
    }
}

Links

ContactStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{ContactStatusCode}%2CLookupType%3DORA_HER_CONTACT_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: ContactStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ContactTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_ORG_CON_TYPE%2CLookupCode%3D{DefaultContactTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: DefaultContactTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

contactAssociations

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/contactAssociations

Parameters:

• ContactPartyId: $request.path.ContactPartyId

The contact associations resource is used to associate a Student Management organization contact with a Student Management organization.

emails

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/emails

Parameters:

• ContactPartyId: $request.path.ContactPartyId

The emails resource contains the email addresses of the Student Management organization contacts.

names

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names

Parameters:

• ContactPartyId: $request.path.ContactPartyId

The names resource contains the names of the Student Management organization contacts.

phones

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/phones

Parameters:

• ContactPartyId: $request.path.ContactPartyId

The phones resource contains the phone numbers of the Student Management organization contacts.

Back to Top