Create a student official residency
post
/fscmRestApi/resources/11.13.18.05/studentOfficialResidencies
Request
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
AcademicLevelCode(required): string
Title:
Academic Level Code
Maximum Length:100
The unique code for the academic level. -
AcademicLevelId(required): integer
(int64)
The unique identifier of the academic level.
-
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(required): 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. -
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. -
InstitutionId(required): integer
(int64)
The unique identifier of the institution.
-
InstitutionName(required): string
Title:
Institution
Maximum Length:50
The name of the institution. -
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(required): 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(required): 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. -
StartDate(required): string
(date)
The effective date of the official residency determination.
-
StateCode: string
Title:
State Code
Maximum Length:60
The state for the address.
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
Nested Schema : studentOfficialResidencies-residencyExceptions-item-post-request
Type:
Show Source
object
-
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.
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.
Root Schema : studentOfficialResidencies-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : studentOfficialResidencies-residencyExceptions-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- academicInstitutionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionName; Target Attribute: InstitutionName
- Display Attribute: InstitutionName
- academicLevelsLOV
-
Parameters:
- finder:
ByInstitutionFinder%3BInstitutionName%3D{InstitutionName}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicLevelCode; Target Attribute: LevelCode
- Display Attribute: LevelName
- finder:
- houseTypesLOV
-
Parameters:
- finder:
LookupTypeIsActiveFinder%3BLookupType%3DHZ_HOUSE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: HouseType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- 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. - ResidencyId:
- residencyTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_RESIDENCY_CODE%2CLookupCode%3D{ResidencyCode}
The following properties are defined on the LOV link relation:- Source Attribute: ResidencyCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: