REST API for Oracle Fusion Cloud Student Management

Get a person details instance

get

/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/personDetails/{PersonalDetailId}

Request

Path Parameters

ApplicationId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
PersonalDetailId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
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
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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : admissionApplications-personDetails-item-response

Type: object

Show Source

BirthCountryCode: string

Title: Country of Birth

Read Only: true

Maximum Length: 30

The country where this person was born.
BirthCountryName: string

Title: Country of Birth

Read Only: true

Maximum Length: 80

The name of the birth country code.
CitizenshipCountryCode: string

Title: Country of Citizenship

Read Only: true

Maximum Length: 2

The code for the country from which a person claims citizenship.
CitizenshipCountryName: string

Title: Country of Citizenship

Read Only: true

Maximum Length: 80

The name of the citizenship country code.
CitizenshipStatusCode: string

Title: Citizenship Status

Read Only: true

Maximum Length: 30

The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
CitizenshipStatusMeaning: string

Title: Citizenship Status

Read Only: true

Maximum Length: 80

The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.
DateOfBirth: string (date)

Title: Date of Birth

Read Only: true

The date when the person was born.
GenderCode: string

Title: Gender

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 HZ_GENDER.
GenderIdentityCode: string

Title: Gender Identity

Read Only: true

Maximum Length: 30

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

Title: Gender Identity

Read Only: true

Maximum Length: 80

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

Title: Gender Identity Value

Read Only: true

Maximum Length: 100

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

Title: Gender

Read Only: true

Maximum Length: 80

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

Title: Hispanic or Latino

Read Only: true

Maximum Length: 60

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

Title: Hispanic or Latino

Read Only: true

Maximum Length: 80

The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.
links: array Links

Title: Links

The link relations associated with the resource instance.
MaritalStatusCode: string

Title: Marital Status

Read Only: true

Maximum Length: 30

The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.
MaritalStatusEffectiveDate: string (date)

Title: Marital Status as Of

Read Only: true

The date when the person's marital status changed.
MaritalStatusMeaning: string

Title: Marital Status

Read Only: true

Maximum Length: 80

The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.
PersonalDetailId: integer (int64)

Title: Personal Detail ID

Read Only: true

Unique identifier for personal data information associated with an application.
PlaceOfBirth: string

Title: Place of Birth

Read Only: true

Maximum Length: 60

The place of birth of the student.
PreferredPronounsCode: string

Title: Preferred Pronouns

Read Only: true

Maximum Length: 30

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

Title: Preferred Pronouns

Read Only: true

Maximum Length: 80

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

Title: Preferred Pronouns Value

Read Only: true

Maximum Length: 100

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

Title: Primary Language

Read Only: true

Maximum Length: 30

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

Title: Primary Language

Read Only: true

Maximum Length: 80

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

Title: Primary Language Value

Read Only: true

Maximum Length: 100

The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.
ResidenceCountryCode: string

Title: Country of Residence

Read Only: true

Maximum Length: 30

The country this person normally resides in.
ResidenceCountryName: string

Title: Country of Residence

Read Only: true

Maximum Length: 80

The name of the residency country code.
VisaTypeCode: string

Title: Visa Type

Read Only: true

Maximum Length: 30

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

Title: Visa Type

Read Only: true

Maximum Length: 80

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

{
    "type":"object",
    "properties":{
        "PrimaryLanguageCode":{
            "title":"Primary Language",
            "maxLength":"30",
            "type":"string",
            "description":"The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLanguageMeaning":{
            "title":"Primary Language",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BirthCountryCode":{
            "title":"Country of Birth",
            "maxLength":"30",
            "type":"string",
            "description":"The country where this person was born.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaritalStatusEffectiveDate":{
            "title":"Marital Status as Of",
            "type":"string",
            "description":"The date when the person's marital status changed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisaTypeMeaning":{
            "title":"Visa Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityValue":{
            "title":"Gender Identity Value",
            "maxLength":"100",
            "type":"string",
            "description":"The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityCode":{
            "title":"Gender Identity",
            "maxLength":"30",
            "type":"string",
            "description":"The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredPronounsValue":{
            "title":"Preferred Pronouns Value",
            "maxLength":"100",
            "type":"string",
            "description":"The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlaceOfBirth":{
            "title":"Place of Birth",
            "maxLength":"60",
            "type":"string",
            "description":"The place of birth of the student.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaritalStatusMeaning":{
            "title":"Marital Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipCountryCode":{
            "title":"Country of Citizenship",
            "maxLength":"2",
            "type":"string",
            "description":"The code for the country from which a person claims citizenship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderMeaning":{
            "title":"Gender",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLanguageValue":{
            "title":"Primary Language Value",
            "maxLength":"100",
            "type":"string",
            "description":"The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HispanicOrLatinoCode":{
            "title":"Hispanic or Latino",
            "maxLength":"60",
            "type":"string",
            "description":"The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date when the person was born.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResidenceCountryCode":{
            "title":"Country of Residence",
            "maxLength":"30",
            "type":"string",
            "description":"The country this person normally resides in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderCode":{
            "title":"Gender",
            "maxLength":"30",
            "type":"string",
            "description":"The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisaTypeCode":{
            "title":"Visa Type",
            "maxLength":"30",
            "type":"string",
            "description":"The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipStatusMeaning":{
            "title":"Citizenship Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BirthCountryName":{
            "title":"Country of Birth",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the birth country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HispanicOrLatinoMeaning":{
            "title":"Hispanic or Latino",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipCountryName":{
            "title":"Country of Citizenship",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the citizenship country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredPronounsMeaning":{
            "title":"Preferred Pronouns",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredPronounsCode":{
            "title":"Preferred Pronouns",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonalDetailId":{
            "title":"Personal Detail ID",
            "type":"integer",
            "description":"Unique identifier for personal data information associated with an application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MaritalStatusCode":{
            "title":"Marital Status",
            "maxLength":"30",
            "type":"string",
            "description":"The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipStatusCode":{
            "title":"Citizenship Status",
            "maxLength":"30",
            "type":"string",
            "description":"The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResidenceCountryName":{
            "title":"Country of Residence",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the residency country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityMeaning":{
            "title":"Gender Identity",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}