Jump to

• Request
• Response

Get all student official residencies

get

/fscmRestApi/resources/11.13.18.05/studentOfficialResidencies

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 the student official residency that matches the specified primary key criteria.
    Finder Variables
    • ResidencyId; integer; The unique identifier of the official residency.
• 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:
  

  • EndDate; string; The end date of the residency information record.
  • FullName; string; The first and last name of the party displayed as a single string.
  • LastUpdateDate; string; The last updated date of the residency information record.
  • PartyId; integer; The unique identifier for the party. Party can be a person. For example, a student can be a party.
  • ResidencyCode; string; The unique code for the residency type. A list of accepted values is defined in the lookup type ORA_HEY_RESIDENCY_CODE.
  • ResidencyId; integer; The unique identifier assigned to an official residency record.
  • ResidencyMeaning; string; 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; The effective date of the official residency determination.
  • TimelineStatus; integer; 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.
• 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: 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : studentOfficialResidencies

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/studentOfficialResidencies-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentOfficialResidencies-item-response

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

Back to Top