Jump to

• Request
• Response

Create a student official residency

post

/fscmRestApi/resources/11.13.18.05/studentOfficialResidencies

Request

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The end date of the residency information record.
• PartyId(required): integer (int64)
  Title: Party ID

  The unique identifier for the party. Party can be a person. For example, a student can be a party.
• ResidencyCode(required): string
  Title: Residency Type Code

  Maximum Length: 30

  The unique code for the residency type. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.
• residencyExceptions: array Residency Exceptions
  Title: Residency Exceptions

  The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.
• StartDate: string (date)
  Title: Start Date

  The effective date of the official residency determination.

{
    "required":[
        "PartyId",
        "ResidencyCode"
    ],
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the residency information record.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.hed.campusCommunity.student.bioDemo.model.r131805.view.HedPersonProfileVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"FullName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartyId"
            }
        },
        "ResidencyCode":{
            "title":"Residency Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the residency type. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"ORA_HEY_RESIDENCY_CODE",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The effective date of the official residency determination.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "residencyExceptions":{
            "title":"Residency Exceptions",
            "type":"array",
            "description":"The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.",
            "items":{
                "$ref":"#/components/schemas/studentOfficialResidencies-residencyExceptions-item-post-request"
            }
        }
    }
}

Nested Schema : Residency Exceptions

Type: array

Title: Residency Exceptions

The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.

Show Source

• Array of: object studentOfficialResidencies-residencyExceptions-item-post-request

{
    "title":"Residency Exceptions",
    "type":"array",
    "description":"The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.",
    "items":{
        "$ref":"#/components/schemas/studentOfficialResidencies-residencyExceptions-item-post-request"
    }
}

Nested Schema : studentOfficialResidencies-residencyExceptions-item-post-request

Type: object

Show Source

• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  Action to define if the object should be removed.
• ResidencyExceptionCode: string
  Title: Residency Exception Type

  Maximum Length: 30

  The type of residency exception. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.

{
    "type":"object",
    "properties":{
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"Action to define if the object should be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "ResidencyExceptionCode":{
            "title":"Residency Exception Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of residency exception. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"ORA_HEY_RESIDENCY_EXCPT_CODE",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : studentOfficialResidencies-item-response

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The end date of the residency information record.
• FullName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The first and last name of the party displayed as a single string.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last updated date of the residency information record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier for the party. Party can be a person. For example, a student can be a party.
• ResidencyCode: string
  Title: Residency Type Code

  Maximum Length: 30

  The unique code for the residency type. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.
• residencyExceptions: array Residency Exceptions
  Title: Residency Exceptions

  The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.
• ResidencyId: integer (int64)
  Title: Student Residency ID

  Read Only: true

  The unique identifier assigned to an official residency record.
• ResidencyMeaning: string
  Title: Residency Type

  Read Only: true

  Maximum Length: 80

  The meaning of the residency type code, such as in-state, out-of-state, or international. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.
• StartDate: string (date)
  Title: Start Date

  The effective date of the official residency determination.
• TimelineStatus: integer
  Title: Residency Date Status

  Read Only: true

  The status of the residency record in the timeline. A value of -1 indicates this is a past record, 0 indicated this is current, and 1 indicates this is upcoming.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the residency information record.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The first and last name of the party displayed as a single string.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last updated date of the residency information record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.hed.campusCommunity.student.bioDemo.model.r131805.view.HedPersonProfileVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"FullName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartyId"
            },
            "x-queryable":true
        },
        "ResidencyCode":{
            "title":"Residency Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the residency type. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"ORA_HEY_RESIDENCY_CODE",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ResidencyId":{
            "title":"Student Residency ID",
            "type":"integer",
            "description":"The unique identifier assigned to an official residency record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResidencyMeaning":{
            "title":"Residency Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the residency type code, such as in-state, out-of-state, or international. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The effective date of the official residency determination.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "TimelineStatus":{
            "title":"Residency Date Status",
            "type":"integer",
            "description":"The status of the residency record in the timeline. A value of -1 indicates this is a past record, 0 indicated this is current, and 1 indicates this is upcoming.",
            "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"
            }
        },
        "residencyExceptions":{
            "title":"Residency Exceptions",
            "type":"array",
            "description":"The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.",
            "items":{
                "$ref":"#/components/schemas/studentOfficialResidencies-residencyExceptions-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 : Residency Exceptions

Type: array

Title: Residency Exceptions

The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.

Show Source

• Array of: object studentOfficialResidencies-residencyExceptions-item-response

{
    "title":"Residency Exceptions",
    "type":"array",
    "description":"The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.",
    "items":{
        "$ref":"#/components/schemas/studentOfficialResidencies-residencyExceptions-item-response"
    }
}

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 : studentOfficialResidencies-residencyExceptions-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  Action to define if the object should be removed.
• ResidencyExceptionCode: string
  Title: Residency Exception Type

  Maximum Length: 30

  The type of residency exception. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.
• ResidencyExceptionId: integer (int64)
  Title: Student Residency Exception ID

  Read Only: true

  The unique identifier for a residency exception.
• ResidencyExceptionMeaning: string
  Title: Residency Exception

  Read Only: true

  Maximum Length: 80

  The meaning of the residency exception code, such as military. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.

{
    "type":"object",
    "properties":{
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"Action to define if the object should be removed.",
            "nullable":true,
            "x-queryable":false
        },
        "ResidencyExceptionCode":{
            "title":"Residency Exception Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of residency exception. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_LOOKUP_TYPE":"ORA_HEY_RESIDENCY_EXCPT_CODE",
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ResidencyExceptionId":{
            "title":"Student Residency Exception ID",
            "type":"integer",
            "description":"The unique identifier for a residency exception.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResidencyExceptionMeaning":{
            "title":"Residency Exception",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the residency exception code, such as military. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_EXCPT_CODE.",
            "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"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

residencyExceptions

Operation: /fscmRestApi/resources/11.13.18.05/studentOfficialResidencies/{ResidencyId}/child/residencyExceptions

Parameters:

• ResidencyId: $request.path.ResidencyId

The residency exceptions resource contains the residency exception type and related notes that are used to grant official residency determination, where without the exception, the student wouldn't qualify for the residency.

residencyTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupCode%3D{ResidencyCode}%2CLookupType%3DORA_HEY_RESIDENCY_CODE

The following properties are defined on the LOV link relation:

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

Back to Top