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
  
  

  • ByResidencyIdFinder Finds the student official residency that matches the residency ID.
    Finder Variables
    • ResidencyId; integer; The unique identifier of the student official residency.
  • 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:
  

  • AcademicLevelCode; string; The unique code for the academic level.
  • AcademicLevelId; integer; The unique identifier of the academic level.
  • AcademicLevelName; string; The name of the academic level offered by the institution such as undergraduate.
  • AddrElementAttributeFive; string; The additional address element to support flexible address format.
  • AddrElementAttributeFour; string; The additional address element to support flexible address format.
  • AddrElementAttributeOne; string; The additional address element to support flexible address format.
  • AddrElementAttributeThree; string; The additional address element to support flexible address format.
  • AddrElementAttributeTwo; string; The additional address element to support flexible address format.
  • AddressFour; string; The fourth line for address.
  • AddressLinesPhonetic; string; The phonetic or Kana representation of the Kanji address lines. Used in Japan.
  • AddressOne; string; The first line for address.
  • AddressThree; string; The third line for address.
  • AddressTwo; string; The second line for address.
  • Building; string; The building name or number at a given address.
  • City; string; The city for the address.
  • CountryCode; string; The country for the address.
  • County; string; The county for the address.
  • FloorNumber; string; The floor number at a given address or in a particular building when building name or number is provided.
  • FullName; string; The first and last name of the party displayed as a single string.
  • HouseType; string; The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
  • HouseTypeMeaning; string; The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
  • InstitutionId; integer; The unique identifier of the institution.
  • InstitutionName; string; The name of the institution.
  • LocationDirections; string; The directions to the location.
  • Note; string; Additional comments associated with the official residency.
  • PartyId; integer; The unique identifier for the party. Party can be a person. For example, a student can be a party.
  • Position; string; The primary direction such as North or East that's used to access the location.
  • PostalCode; string; The postal code for the address.
  • PostalPlusFourCode; string; The four digit extension to the United States postal code.
  • Province; string; The province for the address.
  • 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.
  • StateCode; string; The state for the address.
• 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 : 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":{
        "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/studentOfficialResidencies-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 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

• AcademicLevelCode: string
  Title: Academic Level Code

  Maximum Length: 100

  The unique code for the academic level.
• AcademicLevelId: integer (int64)
  The unique identifier of the academic level.
• AcademicLevelName: string
  Title: Academic Level Name

  Read Only: true

  Maximum Length: 100

  The name of the academic level offered by the institution such as undergraduate.
• AddrElementAttributeFive: string
  Title: Additional Address Element 5

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeFour: string
  Title: Additional Address Element 4

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeOne: string
  Title: Additional Address Element 1

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeThree: string
  Title: Additional Address Element 3

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddrElementAttributeTwo: string
  Title: Additional Address Element 2

  Maximum Length: 150

  The additional address element to support flexible address format.
• AddressFour: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth line for address.
• AddressLinesPhonetic: string
  Title: Address Lines Phonetic

  Maximum Length: 560

  The phonetic or Kana representation of the Kanji address lines. Used in Japan.
• AddressOne: string
  Title: Address Line 1

  Maximum Length: 240

  The first line for address.
• AddressThree: string
  Title: Address Line 3

  Maximum Length: 240

  The third line for address.
• AddressTwo: string
  Title: Address Line 2

  Maximum Length: 240

  The second line for address.
• Building: string
  Title: Building

  Maximum Length: 240

  The building name or number at a given address.
• City: string
  Title: City

  Maximum Length: 60

  The city for the address.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  The country for the address.
• County: string
  Title: County

  Maximum Length: 60

  The county for the address.
• FloorNumber: string
  Title: Floor Number

  Maximum Length: 40

  The floor number at a given address or in a particular building when building name or number is provided.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The address formatted based on the country code.
• FormattedMultilineAddress: string
  Title: Address

  Read Only: true

  The multiline display for the formatted address.
• FullName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The first and last name of the party displayed as a single string.
• HouseType: string
  Title: House Type

  Maximum Length: 30

  The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• HouseTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.
• InstitutionId: integer (int64)
  The unique identifier of the institution.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The name of the institution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDirections: string
  Title: Location Directions

  Maximum Length: 640

  The directions to the location.
• Note: string
  Maximum Length: 240

  Additional comments associated with the official residency.
• PartyId: integer (int64)
  The unique identifier for the party. Party can be a person. For example, a student can be a party.
• Position: string
  Title: Position

  Maximum Length: 50

  The primary direction such as North or East that's used to access the location.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code for the address.
• PostalPlusFourCode: string
  Title: Postal Code Extension

  Maximum Length: 20

  The four digit extension to the United States postal code.
• Province: string
  Title: Province Code

  Maximum Length: 60

  The province for the address.
• ResidencyCode: string
  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)
  Read Only: true

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

  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)
  The effective date of the official residency determination.
• StateCode: string
  Title: State Code

  Maximum Length: 60

  The state for the address.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":40,
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building name or number is provided.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The effective date of the official residency determination.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "type":"integer",
            "description":"The unique identifier of the academic level.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level offered by the institution such as undergraduate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. Used in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"The country for the address.",
            "nullable":false,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AcademicLevelCode":{
            "title":"Academic Level Code",
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the academic level.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":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-response"
            }
        },
        "ResidencyCode":{
            "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":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "type":"integer",
            "description":"The unique identifier of the institution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":50,
            "type":"string",
            "description":"The primary direction such as North or East that's used to access the location.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The address formatted based on the country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StateCode":{
            "title":"State Code",
            "maxLength":60,
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "ResidencyId":{
            "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
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The multiline display for the formatted address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province Code",
            "maxLength":60,
            "type":"string",
            "description":"The province for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD",
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PartyId":{
            "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":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "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
        },
        "Note":{
            "maxLength":240,
            "type":"string",
            "description":"Additional comments associated with the official residency.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States postal code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "ResidencyMeaning":{
            "title":"Meaning",
            "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
        }
    }
}

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.
• Note: string
  Maximum Length: 240

  The additional information entered to clarify the residency exception.
• ResidencyExceptionCode: string
  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)
  Read Only: true

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

  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":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResidencyExceptionCode":{
            "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":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResidencyExceptionId":{
            "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":"Meaning",
            "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
        },
        "Note":{
            "maxLength":240,
            "type":"string",
            "description":"The additional information entered to clarify the residency exception.",
            "nullable":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