Jump to

• Request
• Response

Get all person profiles

get

/fscmRestApi/resources/11.13.18.05/searchHedPersonProfiles

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:
  
  

  • PrimaryKey: Finds all person profiles that match the Party ID, Party ID1, 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.
  • searchByKeywords: Keyword to search from Name, Email ID, and Constituent ID.
    Finder Variables:
    • keyword1; string.
    • keyword2; string.
• 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:
  

  • AdditionalFirstName; string; The additional first name of a person.
  • AdditionalLastName; string; The additional last name of a person.
  • AdditionalMiddleName; string; The additional middle name of a person.
  • ConstituentId; string; The unique identifier for a constituent.
  • DisplayFirstName; string; The display first name of a person.
  • DisplayLastName; string; The display last name of a person.
  • EmailAddress; string; The email address of the person.
  • EmailId; integer; The unique identifier for an email address.
  • FirstName; string; The first name of a 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 ORA_HEY_GENDER.
  • Gendermeaning; string; The meaning of the gender code. A list of accepted values is defined in the lookup type ORA_HEY_GENDER.
  • LastName; string; The last name of a person.
  • MiddleName; string; The middle name of a person.
  • NameSuffix; string; The suffix can be junior or senior.
  • NameTypeCode; string; The type of the name. It is 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.
  • PartyId; integer; The unique identifier for the party. Party can be a person. For example, a student can be a party.
  • PartyNameId; integer; The unique identifier for a name.
  • PreferredEmailFlag; boolean; Indicates the preferred email address.
  • PreferredNameFlag; boolean; Indicates the name as preferred name for this party within this name type.
  • PurposeCode; string; The type of purpose for email contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type ORA_HEY_EMAIL_CONTACT_PURPOSE.
  • Title; string; The title of the person, such as Mr or Mrs.
• 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(required):
  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(required):
  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 : searchHedPersonProfiles

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/searchHedPersonProfiles-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 searchHedPersonProfiles-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-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 : searchHedPersonProfiles-item-response

Type: object

Show Source

• AdditionalFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

  The additional middle name of a person.
• ConstituentId: string
  Title: Constituent ID

  Read Only: true

  Maximum Length: 30

  The unique identifier for a constituent.
• DisplayFirstName: string
  Read Only: true

  Maximum Length: 150

  The display first name of a person.
• DisplayLastName: string
  Read Only: true

  Maximum Length: 150

  The display last name of a person.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the person.
• EmailId: integer (int64)
  Read Only: true

  The unique identifier for an email address.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 360

  The full name of the person.
• Gendercode: string
  Read Only: true

  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 ORA_HEY_GENDER.
• Gendermeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the gender code. A list of accepted values is defined in the lookup type ORA_HEY_GENDER.
• images: array Images
  Title: Images

  The images resource is a child of search person profiles resource and provides information about the image uploaded by the user.
• LastName: string
  Title: Last Name

  Read Only: true

  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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  The type of the name. It is 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.
• 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.
• PartyNameId: integer (int64)
  Title: Party Name ID

  Read Only: true

  The unique identifier for a name.
• phones: array Phones
  Title: Phones

  The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user.
• PreferredEmailFlag: boolean
  Title: Preferred

  Read Only: true

  Maximum Length: 1

  Indicates the preferred email address.
• PreferredNameFlag: boolean
  Title: Preferred

  Read Only: true

  Maximum Length: 1

  Indicates the name as preferred name for this party within this name type.
• PurposeCode: string
  Title: Purpose Code

  Read Only: true

  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 ORA_HEY_EMAIL_CONTACT_PURPOSE.
• studentCredentials: array Student Credentials
  Title: Student Credentials

  The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.
• studentCurriculums: array Student Curriculums
  Title: Student Curriculums

  The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student.
• Title: string
  Title: Title

  Read Only: true

  Maximum Length: 60

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

{
    "type":"object",
    "properties":{
        "PreferredNameFlag":{
            "title":"Preferred",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the name as preferred name for this party within this name type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "studentCurriculums":{
            "title":"Student Curriculums",
            "type":"array",
            "description":"The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-item-response"
            }
        },
        "DisplayFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The display first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "phones":{
            "title":"Phones",
            "type":"array",
            "description":"The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-phones-item-response"
            }
        },
        "PurposeCode":{
            "title":"Purpose Code",
            "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 ORA_HEY_EMAIL_CONTACT_PURPOSE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConstituentId":{
            "title":"Constituent ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a constituent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "studentCredentials":{
            "title":"Student Credentials",
            "type":"array",
            "description":"The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCredentials-item-response"
            }
        },
        "Gendercode":{
            "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 ORA_HEY_GENDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The additional middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The display last name of a person.",
            "nullable":true,
            "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":"Name Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The additional last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NameTypeCode":{
            "title":"Name Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of the name. It is 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,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "type":"integer",
            "description":"The unique identifier for an email address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of search person profiles resource and provides information about the image uploaded by the user.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-images-item-response"
            }
        },
        "AdditionalFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The additional first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredEmailFlag":{
            "title":"Preferred",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of a person.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Gendermeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the gender code. A list of accepted values is defined in the lookup type ORA_HEY_GENDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNameId":{
            "title":"Party Name ID",
            "type":"integer",
            "description":"The unique identifier for a name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
            },
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":360,
            "type":"string",
            "description":"The full name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Images

Type: array

Title: Images

The images resource is a child of search person profiles resource and provides information about the image uploaded by the user.

Show Source

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

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of search person profiles resource and provides information about the image uploaded by the user.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-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 : Phones

Type: array

Title: Phones

The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user.

Show Source

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

{
    "title":"Phones",
    "type":"array",
    "description":"The phones resource is a child of search person profiles resource and provides information about the various phone numbers associated with the user.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-phones-item-response"
    }
}

Nested Schema : Student Credentials

Type: array

Title: Student Credentials

The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.

Show Source

• Array of: object searchHedPersonProfiles-studentCredentials-item-response

{
    "title":"Student Credentials",
    "type":"array",
    "description":"The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCredentials-item-response"
    }
}

Nested Schema : Student Curriculums

Type: array

Title: Student Curriculums

The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student.

Show Source

• Array of: object searchHedPersonProfiles-studentCurriculums-item-response

{
    "title":"Student Curriculums",
    "type":"array",
    "description":"The student curriculum resource is a child of search person profiles resource and provides a list of academic groups and programs associated with a student.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-item-response"
    }
}

Nested Schema : searchHedPersonProfiles-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 : 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 : searchHedPersonProfiles-phones-item-response

Type: object

Show Source

• ContactPointType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: PHONE

  The type code of the contact point.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the row.
• OwnerTableId: integer (int64)
  Read Only: true

  The unique identifier of the owner table.
• OwnerTableName: string
  Read Only: true

  Maximum Length: 30

  The name of the owner table.
• PhoneAreaCode: string
  Title: Area Code

  Read Only: true

  Maximum Length: 20

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

  Read Only: true

  Maximum Length: 10

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

  Read Only: true

  Maximum Length: 20

  The extension number for a phone number.
• PhoneId: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 40

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

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates the preferred phone number.
• PurposeCode: string
  Title: Purpose

  Read Only: true

  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 ORA_HEY_PHONE_CONTACT_PURPOSE.
• Status: string
  Read Only: true

  Maximum Length: 30

  Default Value: A

  Indicates the active phone number.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the active phone number.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "OwnerTableName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the owner table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerTableId":{
            "type":"integer",
            "description":"The unique identifier of the owner table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 ORA_HEY_PHONE_CONTACT_PURPOSE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The international country code for a telephone number. For example, 33 for France.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PhoneId":{
            "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
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The telephone number formatted in the local format.  The number should not include area code, country code, or extension.",
            "nullable":true,
            "readOnly":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"
            }
        },
        "ContactPointType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type code of the contact point.",
            "nullable":false,
            "readOnly":true,
            "default":"PHONE",
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred phone number.",
            "nullable":true,
            "readOnly":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 : searchHedPersonProfiles-studentCredentials-item-response

Type: object

Show Source

• CompletionPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the academic period that is associated with completion of the enrollment record.
• ConferralDate: string (date-time)
  Title: Conferral Date

  Read Only: true

  The date when the credential was conferred to the student.
• CredentialId: integer (int64)
  Title: Program Credential ID

  Read Only: true

  The unique identifier for the credential associated with the enrollment record.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the enrollment record.
• EnrollmentCredentialId: integer (int64)
  Read Only: true

  The generated primary key column of the credential record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.
• StatusDate: string (date-time)
  Title: Status Date

  Read Only: true

  The date of the latest status associated with the credential.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.
• StudentPartyId: integer (int64)
  Title: Student ID

  Read Only: true

  The unique identifier assigned to a person whose association with an institution is classified as being a student.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date of the latest status associated with the credential.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Program Credential ID",
            "type":"integer",
            "description":"The unique identifier for the credential associated with the enrollment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConferralDate":{
            "title":"Conferral Date",
            "type":"string",
            "description":"The date when the credential was conferred to the student.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"The unique identifier assigned to a person whose association with an institution is classified as being a student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentCredentialId":{
            "type":"integer",
            "description":"The generated primary key column of the credential record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the academic period that is associated with completion of the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : searchHedPersonProfiles-studentCurriculums-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Read Only: true

  The unique identifier for an academic level that is associated with the enrollment record.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of an academic level that is associated with the enrollment record.
• ActionReasonId: integer (int64)
  Title: Last Action Reason ID

  Read Only: true

  The unique identifier of action reason associated with the enrollment record.
• ActionTypeCode: string
  Title: Last Action

  Read Only: true

  Maximum Length: 30

  The code of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
• advisors: array Advisors
  Title: Advisors

  The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student.
• ApprovedAcademicLoad: string
  Title: Student Program Approved Academic Load

  Read Only: true

  Maximum Length: 30

  The approved academic load code of the enrollment record. Valid values include ORA_FULL_TIME or ORA_PART_TIME. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.
• CampusId: integer (int64)
  Title: Campus ID

  Read Only: true

  The unique identifier of the campus associated with the enrollment record.
• CampusName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the campus associated with the enrollment record.
• CurriculumId: integer (int64)
  Title: Curriculum ID

  Read Only: true

  The identifier for the program or academic group associated with this student curriculum item.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the program or academic group associated with this student curriculum item.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The code of the type category of a curriculum item.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type

  Read Only: true

  The unique identifier of the type category of a curriculum item.
• EnrollmentId: integer (int64)
  Title: Student Curriculum Item ID

  Read Only: true

  The generated primary key column of the enrollment record.
• InstitutionId: integer (int64)
  Title: Institution ID

  Read Only: true

  The unique identifier of the institution associated with the enrollment record.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution associated with the enrollment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentAcademicGroupId: integer (int64)
  Read Only: true

  The unique identifier of the academic group associated with the program record.
• ParentAcademicLevelId: integer
  Read Only: true

  The unique identifier of the academic level associated with the program record.
• PrimaryProgramFlag: boolean
  Read Only: true

  Indicates whether the program is a primary program. The default value is: false.
• ProgramAdmitAcademicPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the academic period that is associated with admit date of the enrollment record.
• ProgramAdmitDate: string (date)
  Read Only: true

  The admit date of the enrollment record.
• ProgramStartDate: string (date)
  Read Only: true

  The date when the student???s program started.
• ProgramStatus: string
  Read Only: true

  Maximum Length: 30

  Indicates the active program.
• ProgramTypeCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  The code of a program type that is associated with a program.
• ProgramTypeId: integer (int64)
  Read Only: true

  The unique identifier for a program type that is associated with a program.
• ProgramTypeMainFlag: boolean
  Title: Main program

  Read Only: true

  Maximum Length: 1

  Indicates whether a program is a main program.
• ProgramTypeName: string
  Title: Program Type

  Read Only: true

  Maximum Length: 50

  The meaning of a program type that is associated with a program.
• ProjectedCompletionDate: string (date)
  Title: Projected Completion Date

  Read Only: true

  The date when a student is expected to complete the program.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The code of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
• StatusDate: string (date-time)
  Title: Status Date

  Read Only: true

  The date of the latest status associated with the enrollment record.
• studentAcademicLevels: array Student Academic Levels
  Title: Student Academic Levels

  The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period.
• studentAcademicLoads: array Student Academic Loads
  Title: Student Academic Loads

  The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period.
• studentCredentials: array Student Credentials
  Title: Student Credentials

  The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.
• studentCurriculumElements: array Student Curriculum Elements
  Title: Student Curriculum Elements

  The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group.
• StudentPartyId: integer (int64)
  Title: Student ID

  Read Only: true

  The unique identifier assigned to a person whose association with an institution is classified as being a student.

{
    "type":"object",
    "properties":{
        "CurriculumTypeId":{
            "title":"Curriculum Type",
            "type":"integer",
            "description":"The unique identifier of the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentAcademicGroupId":{
            "type":"integer",
            "description":"The unique identifier of the academic group associated with the program record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the program or academic group associated with this student curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest status associated with the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMainFlag":{
            "title":"Main program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a program is a main program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "studentCredentials":{
            "title":"Student Credentials",
            "type":"array",
            "description":"The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentCredentials-item-response"
            }
        },
        "studentCurriculumElements":{
            "title":"Student Curriculum Elements",
            "type":"array",
            "description":"The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentCurriculumElements-item-response"
            }
        },
        "AcademicLevelId":{
            "type":"integer",
            "description":"The unique identifier for an academic level that is associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of an academic level that is associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramStartDate":{
            "type":"string",
            "description":"The date when the student???s program started.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramAdmitDate":{
            "type":"string",
            "description":"The admit date of the enrollment record.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeName":{
            "title":"Program Type",
            "maxLength":50,
            "type":"string",
            "description":"The meaning of a program type that is associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramAdmitAcademicPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the academic period that is associated with admit date of the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentAcademicLevelId":{
            "type":"integer",
            "description":"The unique identifier of the academic level associated with the program record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurriculumType"
                ]
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a program type that is associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the type category of a curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier of the institution associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "advisors":{
            "title":"Advisors",
            "type":"array",
            "description":"The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-advisors-item-response"
            }
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"The unique identifier assigned to a person whose association with an institution is classified as being a student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApprovedAcademicLoad":{
            "title":"Student Program Approved Academic Load",
            "maxLength":30,
            "type":"string",
            "description":"The approved academic load code of the enrollment record. Valid values include ORA_FULL_TIME or ORA_PART_TIME. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LOAD_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "studentAcademicLevels":{
            "title":"Student Academic Levels",
            "type":"array",
            "description":"The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentAcademicLevels-item-response"
            }
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date of the latest status associated with the enrollment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The identifier for the program or academic group associated with this student curriculum item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"The unique identifier for a program type that is associated with a program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentId":{
            "title":"Student Curriculum Item ID",
            "type":"integer",
            "description":"The generated primary key column of the enrollment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProjectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"The date when a student is expected to complete the program.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier of the campus associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionTypeCode":{
            "title":"Last Action",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest action taken on the enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonId":{
            "title":"Last Action Reason ID",
            "type":"integer",
            "description":"The unique identifier of action reason associated with the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "studentAcademicLoads":{
            "title":"Student Academic Loads",
            "type":"array",
            "description":"The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period.",
            "items":{
                "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentAcademicLoads-item-response"
            }
        },
        "PrimaryProgramFlag":{
            "type":"boolean",
            "description":"Indicates whether the program is a primary program. The default value is: false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "CurriculumType"
                ]
            },
            "x-queryable":true
        },
        "ProgramStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the active program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Advisors

Type: array

Title: Advisors

The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student.

Show Source

• Array of: object searchHedPersonProfiles-studentCurriculums-advisors-item-response

{
    "title":"Advisors",
    "type":"array",
    "description":"The advisors resource is a child of the search person profiles resource and provides a list of advisors assigned to a student.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-advisors-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 Academic Levels

Type: array

Title: Student Academic Levels

The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period.

Show Source

• Array of: object searchHedPersonProfiles-studentCurriculums-studentAcademicLevels-item-response

{
    "title":"Student Academic Levels",
    "type":"array",
    "description":"The student academic levels resource is a child of the search person profiles resource and provides a list of academic levels calculated for a student under each reporting period.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentAcademicLevels-item-response"
    }
}

Nested Schema : Student Academic Loads

Type: array

Title: Student Academic Loads

The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period.

Show Source

• Array of: object searchHedPersonProfiles-studentCurriculums-studentAcademicLoads-item-response

{
    "title":"Student Academic Loads",
    "type":"array",
    "description":"The student academic loads resource is a child of the search person profiles resource and provides a list of academic loads calculated for a student under each reporting period.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentAcademicLoads-item-response"
    }
}

Nested Schema : Student Credentials

Type: array

Title: Student Credentials

The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.

Show Source

• Array of: object searchHedPersonProfiles-studentCurriculums-studentCredentials-item-response

{
    "title":"Student Credentials",
    "type":"array",
    "description":"The student credentials resource is a child of search person profiles resource and provides a list of credentials awarded to a student.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentCredentials-item-response"
    }
}

Nested Schema : Student Curriculum Elements

Type: array

Title: Student Curriculum Elements

The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group.

Show Source

• Array of: object searchHedPersonProfiles-studentCurriculums-studentCurriculumElements-item-response

{
    "title":"Student Curriculum Elements",
    "type":"array",
    "description":"The student curriculum elements resource is a child of the search person profiles resource and provides a list of programs enrolled for a student under an academic group.",
    "items":{
        "$ref":"#/components/schemas/searchHedPersonProfiles-studentCurriculums-studentCurriculumElements-item-response"
    }
}

Nested Schema : searchHedPersonProfiles-studentCurriculums-advisors-item-response

Type: object

Show Source

• AdvisorId: integer (int64)
  Title: Advisor ID

  Read Only: true

  The generated primary key column of the advisor record.
• AdvisorName: string
  Title: Advisor Name

  Read Only: true

  Maximum Length: 450

  The name of the advisor associated with the enrollment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: boolean
  Title: Primary Advisor

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Identifies the primary advisor associated with the enrollment record.

{
    "type":"object",
    "properties":{
        "AdvisorId":{
            "title":"Advisor ID",
            "type":"integer",
            "description":"The generated primary key column of the advisor record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AdvisorName":{
            "title":"Advisor Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the advisor associated with the enrollment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryFlag":{
            "title":"Primary Advisor",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary advisor associated with the enrollment record.",
            "nullable":false,
            "readOnly":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 : searchHedPersonProfiles-studentCurriculums-studentAcademicLevels-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Read Only: true

  The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• AcademicLevelName: string
  Read Only: true

  Maximum Length: 50

  The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• BeginningAcademicLevel: string
  Read Only: true

  Maximum Length: 30

  The student level at the start of an enrollment period.
• EndingAcademicLevel: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectedAcademicLevel: string
  Read Only: true

  Maximum Length: 30

  The projected student level at the point of enrollment.
• ReportingPeriodEndDate: string (date)
  Read Only: true

  The date when the reporting period associated with a student enrollment record ended.
• ReportingPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the reporting period associated with a student enrollment record.
• ReportingPeriodName: string
  Read Only: true

  Maximum Length: 50

  The name of the reporting period associated with a student enrollment record.
• ReportingPeriodStartDate: string (date)
  Read Only: true

  The date when the reporting period associated with a student enrollment record started.

{
    "type":"object",
    "properties":{
        "BeginningAcademicLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The student level at the start of an enrollment period.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProjectedAcademicLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The projected student level at the point of enrollment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodEndDate":{
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record ended.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "type":"integer",
            "description":"The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the reporting period associated with a student enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndingAcademicLevel":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with a student enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record started.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 : searchHedPersonProfiles-studentCurriculums-studentAcademicLoads-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 50

  The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.
• CalculatedAcademicLoad: string
  Read Only: true

  Maximum Length: 30

  The automatically-calculated academic load of the student, such as full-time or part-time.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverriddenAcademicLoad: string
  Read Only: true

  Maximum Length: 30

  The manually-assigned student academic load that supersedes the automatically-calculated value.
• ReportingPeriodEndDate: string (date)
  Title: Reporting Period End Date

  Read Only: true

  The date when the reporting period associated with a student enrollment record ended.
• ReportingPeriodId: integer (int64)
  Title: Reporting Period ID

  Read Only: true

  The unique identifier of the reporting period associated with a student enrollment record.
• ReportingPeriodName: string
  Title: Reporting Period Name

  Read Only: true

  Maximum Length: 50

  The name of the reporting period associated with a student enrollment record.
• ReportingPeriodStartDate: string (date)
  Title: Reporting Period Start Date

  Read Only: true

  The date when the reporting period associated with a student enrollment record started.

{
    "type":"object",
    "properties":{
        "ReportingPeriodEndDate":{
            "title":"Reporting Period End Date",
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record ended.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier of the reporting period associated with a student enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic level associated with a student curriculum item. For example, a student program might be associated with the academic level of undergraduate.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CalculatedAcademicLoad":{
            "maxLength":30,
            "type":"string",
            "description":"The automatically-calculated academic load of the student, such as full-time or part-time.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OverriddenAcademicLoad":{
            "maxLength":30,
            "type":"string",
            "description":"The manually-assigned student academic load that supersedes the automatically-calculated value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with a student enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "title":"Reporting Period Start Date",
            "type":"string",
            "description":"The date when the reporting period associated with a student enrollment record started.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 : searchHedPersonProfiles-studentCurriculums-studentCredentials-item-response

Type: object

Show Source

• CompletionPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the academic period that is associated with completion of the enrollment record.
• ConferralDate: string (date-time)
  Title: Conferral Date

  Read Only: true

  The date when the credential was conferred to the student.
• CredentialId: integer (int64)
  Title: Program Credential ID

  Read Only: true

  The unique identifier for the credential associated with the enrollment record.
• CredentialName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the credential associated with the enrollment record.
• EnrollmentCredentialId: integer (int64)
  Read Only: true

  The generated primary key column of the credential record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.
• StatusDate: string (date-time)
  Title: Status Date

  Read Only: true

  The date of the latest status associated with the credential.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.
• StudentPartyId: integer (int64)
  Title: Student ID

  Read Only: true

  The unique identifier assigned to a person whose association with an institution is classified as being a student.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the latest status associated with the credential. Valid values include Awarded or Revoked. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date of the latest status associated with the credential.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Program Credential ID",
            "type":"integer",
            "description":"The unique identifier for the credential associated with the enrollment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the enrollment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConferralDate":{
            "title":"Conferral Date",
            "type":"string",
            "description":"The date when the credential was conferred to the student.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StudentPartyId":{
            "title":"Student ID",
            "type":"integer",
            "description":"The unique identifier assigned to a person whose association with an institution is classified as being a student.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnrollmentCredentialId":{
            "type":"integer",
            "description":"The generated primary key column of the credential record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the latest status associated with the credential. Valid values include ORA_AWARDED or ORA_REVOKED. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the academic period that is associated with completion of the enrollment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : searchHedPersonProfiles-studentCurriculums-studentCurriculumElements-item-response

Type: object

Show Source

• CurriculumId: integer (int64)
  Title: Curriculum ID

  The identifier for the program associated with this student curriculum item.
• CurriculumName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the program associated with this student curriculum item.
• CurriculumType: string
  Title: Curriculum Item Type

  Read Only: true

  Maximum Length: 30

  The code of the type category of a curriculum item.
• CurriculumTypeId: integer (int64)
  Title: Curriculum Type

  The unique identifier of the type category of a curriculum item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramEnrollmentId: integer (int64)
  Title: Student Curriculum Item ID

  The generated primary key column of the program enrollment record.
• ProgramTypeId: integer (int64)
  Title: Program Type ID

  Read Only: true

  The unique identifier for a program type value that is associated with a program.
• ProgramTypeMainFlag: boolean
  Title: Main program

  Read Only: true

  Maximum Length: 1

  Indicates whether a program is a main program.
• ProgramTypeName: string
  Title: Program Type Name

  Read Only: true

  Maximum Length: 50

  The name of a program type value that is associated with a program.

{
    "type":"object",
    "properties":{
        "ProgramTypeId":{
            "title":"Program Type ID",
            "type":"integer",
            "description":"The unique identifier for a program type value that is associated with a program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The identifier for the program associated with this student curriculum item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumTypeId":{
            "title":"Curriculum Type",
            "type":"integer",
            "description":"The unique identifier of the type category of a curriculum item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumType":{
            "title":"Curriculum Item Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the type category of a curriculum item.",
            "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"
            }
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the program associated with this student curriculum item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramEnrollmentId":{
            "title":"Student Curriculum Item ID",
            "type":"integer",
            "description":"The generated primary key column of the program enrollment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramTypeName":{
            "title":"Program Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a program type value that is associated with a program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeMainFlag":{
            "title":"Main program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a program is a main program.",
            "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"
    }
}

Back to Top